iCub-main
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
QCPItemText Class Reference

A text label. More...

#include <qcustomplot.h>

+ Inheritance diagram for QCPItemText:

Public Member Functions

 QCPItemText (QCustomPlot *parentPlot)
 Creates a text item and sets default values.
 
virtual ~QCPItemText ()
 
QColor color () const
 
QColor selectedColor () const
 
QPen pen () const
 
QPen selectedPen () const
 
QBrush brush () const
 
QBrush selectedBrush () const
 
QFont font () const
 
QFont selectedFont () const
 
QString text () const
 
Qt::Alignment positionAlignment () const
 
Qt::Alignment textAlignment () const
 
double rotation () const
 
QMargins padding () const
 
void setColor (const QColor &color)
 Sets the color of the text.
 
void setSelectedColor (const QColor &color)
 Sets the color of the text that will be used when the item is selected.
 
void setPen (const QPen &pen)
 Sets the pen that will be used do draw a rectangular border around the text.
 
void setSelectedPen (const QPen &pen)
 Sets the pen that will be used do draw a rectangular border around the text, when the item is selected.
 
void setBrush (const QBrush &brush)
 Sets the brush that will be used do fill the background of the text.
 
void setSelectedBrush (const QBrush &brush)
 Sets the brush that will be used do fill the background of the text, when the item is selected.
 
void setFont (const QFont &font)
 Sets the font of the text.
 
void setSelectedFont (const QFont &font)
 Sets the font of the text that will be used when the item is selected.
 
void setText (const QString &text)
 Sets the text that will be displayed.
 
void setPositionAlignment (Qt::Alignment alignment)
 Sets which point of the text rect shall be aligned with position.
 
void setTextAlignment (Qt::Alignment alignment)
 Controls how (multi-lined) text is aligned inside the text rect (typically Qt::AlignLeft, Qt::AlignCenter or Qt::AlignRight).
 
void setRotation (double degrees)
 Sets the angle in degrees by which the text (and the text rectangle, if visible) will be rotated around position.
 
void setPadding (const QMargins &padding)
 Sets the distance between the border of the text rectangle and the text.
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
 This function is used to decide whether a click hits a layerable object or not.
 
- Public Member Functions inherited from QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
 Base class constructor which initializes base class members.
 
virtual ~QCPAbstractItem ()
 
bool clipToAxisRect () const
 
QCPAxisRectclipAxisRect () const
 
bool selectable () const
 
bool selected () const
 
void setClipToAxisRect (bool clip)
 Sets whether the item shall be clipped to an axis rect or whether it shall be visible on the entire QCustomPlot.
 
void setClipAxisRect (QCPAxisRect *rect)
 Sets the clip axis rect.
 
Q_SLOT void setSelectable (bool selectable)
 Sets whether the user can (de-)select this item by clicking on the QCustomPlot surface.
 
Q_SLOT void setSelected (bool selected)
 Sets whether this item is selected or not.
 
QList< QCPItemPosition * > positions () const
 Returns all positions of the item in a list.
 
QList< QCPItemAnchor * > anchors () const
 Returns all anchors of the item in a list.
 
QCPItemPositionposition (const QString &name) const
 Returns the QCPItemPosition with the specified name.
 
QCPItemAnchoranchor (const QString &name) const
 Returns the QCPItemAnchor with the specified name.
 
bool hasAnchor (const QString &name) const
 Returns whether this item has an anchor with the specified name.
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer="", QCPLayerable *parentLayerable=0)
 Creates a new QCPLayerable instance.
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlotparentPlot () const
 
QCPLayerableparentLayerable () const
 Returns the parent layerable of this layerable.
 
QCPLayerlayer () const
 
bool antialiased () const
 
void setVisible (bool on)
 Sets the visibility of this layerable object.
 
Q_SLOT bool setLayer (QCPLayer *layer)
 Sets the layer of this layerable object.
 
bool setLayer (const QString &layerName)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name.
 
void setAntialiased (bool enabled)
 Sets whether this object will be drawn antialiased or not.
 
bool realVisibility () const
 Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of the layer this layerable is on into account.
 

Public Attributes

QCPItemPosition *const position
 
QCPItemAnchor *const topLeft
 
QCPItemAnchor *const top
 
QCPItemAnchor *const topRight
 
QCPItemAnchor *const right
 
QCPItemAnchor *const bottomRight
 
QCPItemAnchor *const bottom
 
QCPItemAnchor *const bottomLeft
 
QCPItemAnchor *const left
 

Protected Types

enum  AnchorIndex {
  aiTopLeft ,
  aiTop ,
  aiTopRight ,
  aiRight ,
  aiBottomRight ,
  aiBottom ,
  aiBottomLeft ,
  aiLeft
}
 

Protected Member Functions

virtual void draw (QCPPainter *painter)
 
virtual QPointF anchorPixelPoint (int anchorId) const
 
QPointF getTextDrawPoint (const QPointF &pos, const QRectF &rect, Qt::Alignment positionAlignment) const
 
QFont mainFont () const
 
QColor mainColor () const
 
QPen mainPen () const
 
QBrush mainBrush () const
 
- Protected Member Functions inherited from QCPAbstractItem
virtual QCP::Interaction selectionCategory () const
 
virtual QRect clipRect () const
 
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
 
virtual void deselectEvent (bool *selectionStateChanged)
 
double distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const
 
double rectSelectTest (const QRectF &rect, const QPointF &pos, bool filledRect) const
 
QCPItemPositioncreatePosition (const QString &name)
 
QCPItemAnchorcreateAnchor (const QString &name, int anchorId)
 
- Protected Member Functions inherited from QCPLayerable
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
void initializeParentPlot (QCustomPlot *parentPlot)
 
void setParentLayerable (QCPLayerable *parentLayerable)
 
bool moveToLayer (QCPLayer *layer, bool prepend)
 
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
 

Protected Attributes

QColor mColor
 
QColor mSelectedColor
 
QPen mPen
 
QPen mSelectedPen
 
QBrush mBrush
 
QBrush mSelectedBrush
 
QFont mFont
 
QFont mSelectedFont
 
QString mText
 
Qt::Alignment mPositionAlignment
 
Qt::Alignment mTextAlignment
 
double mRotation
 
QMargins mPadding
 
- Protected Attributes inherited from QCPAbstractItem
bool mClipToAxisRect
 
QPointer< QCPAxisRectmClipAxisRect
 
QList< QCPItemPosition * > mPositions
 
QList< QCPItemAnchor * > mAnchors
 
bool mSelectable
 
bool mSelected
 
- Protected Attributes inherited from QCPLayerable
bool mVisible
 
QCustomPlotmParentPlot
 
QPointer< QCPLayerablemParentLayerable
 
QCPLayermLayer
 
bool mAntialiased
 

Additional Inherited Members

- Signals inherited from QCPAbstractItem
void selectionChanged (bool selected)
 This signal is emitted when the selection state of this item has changed, either by user interaction or by a direct call to setSelected.
 
void selectableChanged (bool selectable)
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 This signal is emitted when the layer of this layerable changes, i.e.
 

Detailed Description

A text label.

Text example. Blue dotted circles are anchors, solid blue discs are positions.

Its position is defined by the member position and the setting of setPositionAlignment. The latter controls which part of the text rect shall be aligned with position.

The text alignment itself (i.e. left, center, right) can be controlled with setTextAlignment.

The text may be rotated around the position point with setRotation.

Definition at line 3186 of file qcustomplot.h.

Member Enumeration Documentation

◆ AnchorIndex

enum QCPItemText::AnchorIndex
protected
Enumerator
aiTopLeft 
aiTop 
aiTopRight 
aiRight 
aiBottomRight 
aiBottom 
aiBottomLeft 
aiLeft 

Definition at line 3252 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPItemText()

QCPItemText::QCPItemText ( QCustomPlot parentPlot)

Creates a text item and sets default values.

The constructed item can be added to the plot with QCustomPlot::addItem.

Definition at line 20045 of file qcustomplot.cpp.

◆ ~QCPItemText()

QCPItemText::~QCPItemText ( )
virtual

Definition at line 20072 of file qcustomplot.cpp.

Member Function Documentation

◆ anchorPixelPoint()

QPointF QCPItemText::anchorPixelPoint ( int  anchorId) const
protectedvirtual

Reimplemented from QCPAbstractItem.

Definition at line 20267 of file qcustomplot.cpp.

◆ brush()

QBrush QCPItemText::brush ( ) const
inline

Definition at line 3213 of file qcustomplot.h.

◆ color()

QColor QCPItemText::color ( ) const
inline

Definition at line 3209 of file qcustomplot.h.

◆ draw()

void QCPItemText::draw ( QCPPainter painter)
protectedvirtual

Implements QCPAbstractItem.

Definition at line 20235 of file qcustomplot.cpp.

◆ font()

QFont QCPItemText::font ( ) const
inline

Definition at line 3215 of file qcustomplot.h.

◆ getTextDrawPoint()

QPointF QCPItemText::getTextDrawPoint ( const QPointF &  pos,
const QRectF &  rect,
Qt::Alignment  positionAlignment 
) const
protected

Definition at line 20308 of file qcustomplot.cpp.

◆ mainBrush()

QBrush QCPItemText::mainBrush ( ) const
protected

Definition at line 20360 of file qcustomplot.cpp.

◆ mainColor()

QColor QCPItemText::mainColor ( ) const
protected

Definition at line 20340 of file qcustomplot.cpp.

◆ mainFont()

QFont QCPItemText::mainFont ( ) const
protected

Definition at line 20330 of file qcustomplot.cpp.

◆ mainPen()

QPen QCPItemText::mainPen ( ) const
protected

Definition at line 20350 of file qcustomplot.cpp.

◆ padding()

QMargins QCPItemText::padding ( ) const
inline

Definition at line 3221 of file qcustomplot.h.

◆ pen()

QPen QCPItemText::pen ( ) const
inline

Definition at line 3211 of file qcustomplot.h.

◆ positionAlignment()

Qt::Alignment QCPItemText::positionAlignment ( ) const
inline

Definition at line 3218 of file qcustomplot.h.

◆ rotation()

double QCPItemText::rotation ( ) const
inline

Definition at line 3220 of file qcustomplot.h.

◆ selectedBrush()

QBrush QCPItemText::selectedBrush ( ) const
inline

Definition at line 3214 of file qcustomplot.h.

◆ selectedColor()

QColor QCPItemText::selectedColor ( ) const
inline

Definition at line 3210 of file qcustomplot.h.

◆ selectedFont()

QFont QCPItemText::selectedFont ( ) const
inline

Definition at line 3216 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemText::selectedPen ( ) const
inline

Definition at line 3212 of file qcustomplot.h.

◆ selectTest()

double QCPItemText::selectTest ( const QPointF &  pos,
bool  onlySelectable,
QVariant *  details = 0 
) const
virtual

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a click inside the area returns a constant value greater zero (typically the selectionTolerance of the parent QCustomPlot multiplied by 0.99). If the click lies outside the area, this function returns -1.0.

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also
selectEvent, deselectEvent, QCustomPlot::setInteractions

Implements QCPAbstractItem.

Definition at line 20211 of file qcustomplot.cpp.

◆ setBrush()

void QCPItemText::setBrush ( const QBrush &  brush)

Sets the brush that will be used do fill the background of the text.

To disable the background, set brush to Qt::NoBrush.

See also
setSelectedBrush, setPen, setPadding

Definition at line 20120 of file qcustomplot.cpp.

◆ setColor()

void QCPItemText::setColor ( const QColor &  color)

Sets the color of the text.

Definition at line 20079 of file qcustomplot.cpp.

◆ setFont()

void QCPItemText::setFont ( const QFont &  font)

Sets the font of the text.

See also
setSelectedFont, setColor

Definition at line 20141 of file qcustomplot.cpp.

◆ setPadding()

void QCPItemText::setPadding ( const QMargins &  padding)

Sets the distance between the border of the text rectangle and the text.

The appearance (and visibility) of the text rectangle can be controlled with setPen and setBrush.

Definition at line 20205 of file qcustomplot.cpp.

◆ setPen()

void QCPItemText::setPen ( const QPen &  pen)

Sets the pen that will be used do draw a rectangular border around the text.

To disable the border, set pen to Qt::NoPen.

See also
setSelectedPen, setBrush, setPadding

Definition at line 20098 of file qcustomplot.cpp.

◆ setPositionAlignment()

void QCPItemText::setPositionAlignment ( Qt::Alignment  alignment)

Sets which point of the text rect shall be aligned with position.

Examples:

  • If alignment is Qt::AlignHCenter | Qt::AlignTop, the text will be positioned such that the top of the text rect will be horizontally centered on position.
  • If alignment is Qt::AlignLeft | Qt::AlignBottom, position will indicate the bottom left corner of the text rect.

If you want to control the alignment of (multi-lined) text within the text rect, use setTextAlignment.

Definition at line 20179 of file qcustomplot.cpp.

◆ setRotation()

void QCPItemText::setRotation ( double  degrees)

Sets the angle in degrees by which the text (and the text rectangle, if visible) will be rotated around position.

Definition at line 20196 of file qcustomplot.cpp.

◆ setSelectedBrush()

void QCPItemText::setSelectedBrush ( const QBrush &  brush)

Sets the brush that will be used do fill the background of the text, when the item is selected.

To disable the background, set brush to Qt::NoBrush.

See also
setBrush

Definition at line 20131 of file qcustomplot.cpp.

◆ setSelectedColor()

void QCPItemText::setSelectedColor ( const QColor &  color)

Sets the color of the text that will be used when the item is selected.

Definition at line 20087 of file qcustomplot.cpp.

◆ setSelectedFont()

void QCPItemText::setSelectedFont ( const QFont &  font)

Sets the font of the text that will be used when the item is selected.

See also
setFont

Definition at line 20151 of file qcustomplot.cpp.

◆ setSelectedPen()

void QCPItemText::setSelectedPen ( const QPen &  pen)

Sets the pen that will be used do draw a rectangular border around the text, when the item is selected.

To disable the border, set pen to Qt::NoPen.

See also
setPen

Definition at line 20109 of file qcustomplot.cpp.

◆ setText()

void QCPItemText::setText ( const QString &  text)

Sets the text that will be displayed.

Multi-line texts are supported by inserting a line break character, e.g. '
'.

See also
setFont, setColor, setTextAlignment

Definition at line 20162 of file qcustomplot.cpp.

◆ setTextAlignment()

void QCPItemText::setTextAlignment ( Qt::Alignment  alignment)

Controls how (multi-lined) text is aligned inside the text rect (typically Qt::AlignLeft, Qt::AlignCenter or Qt::AlignRight).

Definition at line 20187 of file qcustomplot.cpp.

◆ text()

QString QCPItemText::text ( ) const
inline

Definition at line 3217 of file qcustomplot.h.

◆ textAlignment()

Qt::Alignment QCPItemText::textAlignment ( ) const
inline

Definition at line 3219 of file qcustomplot.h.

Member Data Documentation

◆ bottom

QCPItemAnchor* const QCPItemText::bottom

Definition at line 3247 of file qcustomplot.h.

◆ bottomLeft

QCPItemAnchor* const QCPItemText::bottomLeft

Definition at line 3248 of file qcustomplot.h.

◆ bottomRight

QCPItemAnchor* const QCPItemText::bottomRight

Definition at line 3246 of file qcustomplot.h.

◆ left

QCPItemAnchor* const QCPItemText::left

Definition at line 3249 of file qcustomplot.h.

◆ mBrush

QBrush QCPItemText::mBrush
protected

Definition at line 3257 of file qcustomplot.h.

◆ mColor

QColor QCPItemText::mColor
protected

Definition at line 3255 of file qcustomplot.h.

◆ mFont

QFont QCPItemText::mFont
protected

Definition at line 3258 of file qcustomplot.h.

◆ mPadding

QMargins QCPItemText::mPadding
protected

Definition at line 3263 of file qcustomplot.h.

◆ mPen

QPen QCPItemText::mPen
protected

Definition at line 3256 of file qcustomplot.h.

◆ mPositionAlignment

Qt::Alignment QCPItemText::mPositionAlignment
protected

Definition at line 3260 of file qcustomplot.h.

◆ mRotation

double QCPItemText::mRotation
protected

Definition at line 3262 of file qcustomplot.h.

◆ mSelectedBrush

QBrush QCPItemText::mSelectedBrush
protected

Definition at line 3257 of file qcustomplot.h.

◆ mSelectedColor

QColor QCPItemText::mSelectedColor
protected

Definition at line 3255 of file qcustomplot.h.

◆ mSelectedFont

QFont QCPItemText::mSelectedFont
protected

Definition at line 3258 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemText::mSelectedPen
protected

Definition at line 3256 of file qcustomplot.h.

◆ mText

QString QCPItemText::mText
protected

Definition at line 3259 of file qcustomplot.h.

◆ mTextAlignment

Qt::Alignment QCPItemText::mTextAlignment
protected

Definition at line 3261 of file qcustomplot.h.

◆ position

QCPItemPosition* const QCPItemText::position

Definition at line 3241 of file qcustomplot.h.

◆ right

QCPItemAnchor* const QCPItemText::right

Definition at line 3245 of file qcustomplot.h.

◆ top

QCPItemAnchor* const QCPItemText::top

Definition at line 3243 of file qcustomplot.h.

◆ topLeft

QCPItemAnchor* const QCPItemText::topLeft

Definition at line 3242 of file qcustomplot.h.

◆ topRight

QCPItemAnchor* const QCPItemText::topRight

Definition at line 3244 of file qcustomplot.h.


The documentation for this class was generated from the following files: