QCPItemText Class Reference

A text label. More...

Inheritance diagram for QCPItemText:

Public Member Functions
	QCPItemText (QCustomPlot *parentPlot)
	Creates a text item and sets default values.
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 Q_DECL_OVERRIDE
	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.
bool	clipToAxisRect () const
QCPAxisRect *	clipAxisRect () 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.
virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE=0
	This function is used to decide whether a click hits a layerable object 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.
QCPItemPosition *	position (const QString &name) const
	Returns the QCPItemPosition with the specified name.
QCPItemAnchor *	anchor (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=QString(), QCPLayerable *parentLayerable=0)
	Creates a new QCPLayerable instance.
bool	visible () const
QCustomPlot *	parentPlot () const
QCPLayerable *	parentLayerable () const
	Returns the parent layerable of this layerable.
QCPLayer *	layer () 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.
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.
bool	realVisibility () const
	Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of this layerable's layer into account.

Data Fields
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) Q_DECL_OVERRIDE
virtual QPointF	anchorPixelPosition (int anchorId) const Q_DECL_OVERRIDE
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 Q_DECL_OVERRIDE
virtual QRect	clipRect () const Q_DECL_OVERRIDE
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE
virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE=0
virtual void	selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) Q_DECL_OVERRIDE
virtual void	deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE
virtual QPointF	anchorPixelPosition (int anchorId) const
double	rectDistance (const QRectF &rect, const QPointF &pos, bool filledRect) const
QCPItemPosition *	createPosition (const QString &name)
QCPItemAnchor *	createAnchor (const QString &name, int anchorId)
Protected Member Functions inherited from QCPLayerable
virtual void	parentPlotInitialized (QCustomPlot *parentPlot)
virtual QCP::Interaction	selectionCategory () const
virtual QRect	clipRect () const
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const =0
virtual void	draw (QCPPainter *painter)=0
virtual void	selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
virtual void	deselectEvent (bool *selectionStateChanged)
virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)
	This event gets called when the user presses a mouse button while the cursor is over the layerable.
virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)
	This event gets called when the user moves the mouse while holding a mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent.
virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)
	This event gets called when the user releases the mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent.
virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)
	This event gets called when the user presses the mouse button a second time in a double-click, while the cursor is over the layerable.
virtual void	wheelEvent (QWheelEvent *event)
	This event gets called when the user turns the mouse scroll wheel while the cursor is over the layerable.
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< QCPAxisRect >	mClipAxisRect
QList< QCPItemPosition * >	mPositions
QList< QCPItemAnchor * >	mAnchors
bool	mSelectable
bool	mSelected
Protected Attributes inherited from QCPLayerable
bool	mVisible
QCustomPlot *	mParentPlot
QPointer< QCPLayerable >	mParentLayerable
QCPLayer *	mLayer
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.

Constructor & Destructor Documentation

QCPItemText()

QCPItemText::QCPItemText ( QCustomPlot *  parentPlot )

explicit

Creates a text item and sets default values.

The created item is automatically registered with parentPlot. This QCustomPlot instance takes ownership of the item, so do not delete it manually but use QCustomPlot::removeItem() instead.

Member Function Documentation

anchorPixelPosition()

QPointF QCPItemText::anchorPixelPosition ( int  anchorId ) const

protectedvirtual

Reimplemented from QCPAbstractItem.

draw()

void QCPItemText::draw ( QCPPainter *  painter )

protectedvirtual

Implements QCPAbstractItem.

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 object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

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, mousePressEvent, wheelEvent, QCustomPlot::setInteractions

Implements QCPAbstractItem.

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

setFont()

void QCPItemText::setFont

(

const QFont &

font

)

Sets the font of the text.

See also

setSelectedFont, setColor

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.

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

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.

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

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

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

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

---

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

• qcustomplot.h
• qcustomplot.cpp