A text label. More...

#include <qcustomplot.h>

Inheritance diagram for QCPItemText:

Public Member Functions
QBrush	brush () const

QColor	color () const

QFont	font () const

QMargins	padding () const

QPen	pen () const

Qt::Alignment	positionAlignment () const

	QCPItemText (QCustomPlot *parentPlot)

double	rotation () const

QBrush	selectedBrush () const

QColor	selectedColor () const

QFont	selectedFont () const

QPen	selectedPen () const

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

void	setBrush (const QBrush &brush)

void	setColor (const QColor &color)

void	setFont (const QFont &font)

void	setPadding (const QMargins &padding)

void	setPen (const QPen &pen)

void	setPositionAlignment (Qt::Alignment alignment)

void	setRotation (double degrees)

void	setSelectedBrush (const QBrush &brush)

void	setSelectedColor (const QColor &color)

void	setSelectedFont (const QFont &font)

void	setSelectedPen (const QPen &pen)

void	setText (const QString &text)

void	setTextAlignment (Qt::Alignment alignment)

QString	text () const

Qt::Alignment	textAlignment () const

virtual	~QCPItemText ()

Public Member Functions inherited from QCPAbstractItem
QCPItemAnchor *	anchor (const QString &name) const

QList< QCPItemAnchor * >	anchors () const

QCPAxisRect *	clipAxisRect () const

bool	clipToAxisRect () const

bool	hasAnchor (const QString &name) const

QCPItemPosition *	position (const QString &name) const

QList< QCPItemPosition * >	positions () const

	QCPAbstractItem (QCustomPlot *parentPlot)

bool	selectable () const

bool	selected () const

void	setClipAxisRect (QCPAxisRect *rect)

void	setClipToAxisRect (bool clip)

Q_SLOT void	setSelectable (bool selectable)

Q_SLOT void	setSelected (bool selected)

virtual	~QCPAbstractItem ()

Public Member Functions inherited from QCPLayerable
bool	antialiased () const

QCPLayer *	layer () const

QCPLayerable *	parentLayerable () const

QCustomPlot *	parentPlot () const

	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

bool	realVisibility () const

void	setAntialiased (bool enabled)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setVisible (bool on)

bool	visible () const

virtual	~QCPLayerable ()

Public Attributes
QCPItemAnchor *const	bottom

QCPItemAnchor *const	bottomLeft

QCPItemAnchor *const	bottomRight

QCPItemAnchor *const	left

QCPItemPosition *const	position

QCPItemAnchor *const	right

QCPItemAnchor *const	top

QCPItemAnchor *const	topLeft

QCPItemAnchor *const	topRight

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

Protected Member Functions
virtual QPointF	anchorPixelPosition (int anchorId) const Q_DECL_OVERRIDE

virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE

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

QBrush	mainBrush () const

QColor	mainColor () const

QFont	mainFont () const

QPen	mainPen () const

Protected Member Functions inherited from QCPAbstractItem
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE

virtual QRect	clipRect () const Q_DECL_OVERRIDE

QCPItemAnchor *	createAnchor (const QString &name, int anchorId)

QCPItemPosition *	createPosition (const QString &name)

virtual void	deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE

double	rectDistance (const QRectF &rect, const QPointF &pos, bool filledRect) const

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged) Q_DECL_OVERRIDE

virtual QCP::Interaction	selectionCategory () const Q_DECL_OVERRIDE

Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

void	initializeParentPlot (QCustomPlot *parentPlot)

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)

bool	moveToLayer (QCPLayer *layer, bool prepend)

virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

virtual void	wheelEvent (QWheelEvent *event)

Protected Attributes
QBrush	mBrush

QColor	mColor

QFont	mFont

QMargins	mPadding

QPen	mPen

Qt::Alignment	mPositionAlignment

double	mRotation

QBrush	mSelectedBrush

QColor	mSelectedColor

QFont	mSelectedFont

QPen	mSelectedPen

QString	mText

Qt::Alignment	mTextAlignment

Protected Attributes inherited from QCPAbstractItem
QList< QCPItemAnchor * >	mAnchors

QPointer< QCPAxisRect >	mClipAxisRect

bool	mClipToAxisRect

QList< QCPItemPosition * >	mPositions

bool	mSelectable

bool	mSelected

Protected Attributes inherited from QCPLayerable
bool	mAntialiased

QCPLayer *	mLayer

QPointer< QCPLayerable >	mParentLayerable

QCustomPlot *	mParentPlot

bool	mVisible

Additional Inherited Members
Signals inherited from QCPAbstractItem
void	selectableChanged (bool selectable)

void	selectionChanged (bool selected)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

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 6294 of file qcustomplot.h.

Member Enumeration Documentation

◆ AnchorIndex

enum QCPItemText::AnchorIndex

protected

Enumerator
aiTopLeft
aiTop
aiTopRight
aiRight
aiBottomRight
aiBottom
aiBottomLeft
aiLeft

Definition at line 6360 of file qcustomplot.h.

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.

Definition at line 28826 of file qcustomplot.cpp.

◆ ~QCPItemText()

QCPItemText::~QCPItemText ( )

virtual

Definition at line 28852 of file qcustomplot.cpp.

Member Function Documentation

◆ anchorPixelPosition()

QPointF QCPItemText::anchorPixelPosition ( int anchorId ) const

protectedvirtual

Reimplemented from QCPAbstractItem.

Definition at line 29047 of file qcustomplot.cpp.

◆ brush()

QBrush QCPItemText::brush ( ) const

inline

Definition at line 6321 of file qcustomplot.h.

◆ color()

QColor QCPItemText::color ( ) const

inline

Definition at line 6317 of file qcustomplot.h.

◆ draw()

void QCPItemText::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractItem.

Definition at line 29015 of file qcustomplot.cpp.

◆ font()

QFont QCPItemText::font ( ) const

inline

Definition at line 6323 of file qcustomplot.h.

◆ getTextDrawPoint()

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

protected

Definition at line 29088 of file qcustomplot.cpp.

◆ mainBrush()

QBrush QCPItemText::mainBrush ( ) const

protected

Definition at line 29140 of file qcustomplot.cpp.

◆ mainColor()

QColor QCPItemText::mainColor ( ) const

protected

Definition at line 29120 of file qcustomplot.cpp.

◆ mainFont()

QFont QCPItemText::mainFont ( ) const

protected

Definition at line 29110 of file qcustomplot.cpp.

◆ mainPen()

QPen QCPItemText::mainPen ( ) const

protected

Definition at line 29130 of file qcustomplot.cpp.

◆ padding()

QMargins QCPItemText::padding ( ) const

inline

Definition at line 6329 of file qcustomplot.h.

◆ pen()

QPen QCPItemText::pen ( ) const

inline

Definition at line 6319 of file qcustomplot.h.

◆ positionAlignment()

Qt::Alignment QCPItemText::positionAlignment ( ) const

inline

Definition at line 6326 of file qcustomplot.h.

◆ rotation()

double QCPItemText::rotation ( ) const

inline

Definition at line 6328 of file qcustomplot.h.

◆ selectedBrush()

QBrush QCPItemText::selectedBrush ( ) const

inline

Definition at line 6322 of file qcustomplot.h.

◆ selectedColor()

QColor QCPItemText::selectedColor ( ) const

inline

Definition at line 6318 of file qcustomplot.h.

◆ selectedFont()

QFont QCPItemText::selectedFont ( ) const

inline

Definition at line 6324 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemText::selectedPen ( ) const

inline

Definition at line 6320 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 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.

In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.

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, QCPAbstractPlottable1D::selectTestRect

Implements QCPAbstractItem.

Definition at line 28991 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 28900 of file qcustomplot.cpp.

◆ setColor()

void QCPItemText::setColor ( const QColor & color )

Sets the color of the text.

Definition at line 28859 of file qcustomplot.cpp.

◆ setFont()

void QCPItemText::setFont ( const QFont & font )

Sets the font of the text.

See also: setSelectedFont, setColor

Definition at line 28921 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 28985 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 28878 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 28959 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 28976 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 28911 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 28867 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 28931 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 28889 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 28942 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 28967 of file qcustomplot.cpp.

◆ text()

QString QCPItemText::text ( ) const

inline

Definition at line 6325 of file qcustomplot.h.

◆ textAlignment()

Qt::Alignment QCPItemText::textAlignment ( ) const

inline

Definition at line 6327 of file qcustomplot.h.

Member Data Documentation

◆ bottom

QCPItemAnchor* const QCPItemText::bottom

Definition at line 6355 of file qcustomplot.h.

◆ bottomLeft

QCPItemAnchor* const QCPItemText::bottomLeft

Definition at line 6356 of file qcustomplot.h.

◆ bottomRight

QCPItemAnchor* const QCPItemText::bottomRight

Definition at line 6354 of file qcustomplot.h.

◆ left

QCPItemAnchor* const QCPItemText::left

Definition at line 6357 of file qcustomplot.h.

◆ mBrush

QBrush QCPItemText::mBrush

protected

Definition at line 6365 of file qcustomplot.h.

◆ mColor

QColor QCPItemText::mColor

protected

Definition at line 6363 of file qcustomplot.h.

◆ mFont

QFont QCPItemText::mFont

protected

Definition at line 6366 of file qcustomplot.h.

◆ mPadding

QMargins QCPItemText::mPadding

protected

Definition at line 6371 of file qcustomplot.h.

◆ mPen

QPen QCPItemText::mPen

protected

Definition at line 6364 of file qcustomplot.h.

◆ mPositionAlignment

Qt::Alignment QCPItemText::mPositionAlignment

protected

Definition at line 6368 of file qcustomplot.h.

◆ mRotation

double QCPItemText::mRotation

protected

Definition at line 6370 of file qcustomplot.h.

◆ mSelectedBrush

QBrush QCPItemText::mSelectedBrush

protected

Definition at line 6365 of file qcustomplot.h.

◆ mSelectedColor

QColor QCPItemText::mSelectedColor

protected

Definition at line 6363 of file qcustomplot.h.

◆ mSelectedFont

QFont QCPItemText::mSelectedFont

protected

Definition at line 6366 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemText::mSelectedPen

protected

Definition at line 6364 of file qcustomplot.h.

◆ mText

QString QCPItemText::mText

protected

Definition at line 6367 of file qcustomplot.h.

◆ mTextAlignment

Qt::Alignment QCPItemText::mTextAlignment

protected

Definition at line 6369 of file qcustomplot.h.

◆ position

QCPItemPosition* const QCPItemText::position

Definition at line 6349 of file qcustomplot.h.

◆ right

QCPItemAnchor* const QCPItemText::right

Definition at line 6353 of file qcustomplot.h.

◆ top

QCPItemAnchor* const QCPItemText::top

Definition at line 6351 of file qcustomplot.h.

◆ topLeft

QCPItemAnchor* const QCPItemText::topLeft

Definition at line 6350 of file qcustomplot.h.

◆ topRight

QCPItemAnchor* const QCPItemText::topRight

Definition at line 6352 of file qcustomplot.h.

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

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AnchorIndex

Constructor & Destructor Documentation

◆ QCPItemText()

◆ ~QCPItemText()

Member Function Documentation

◆ anchorPixelPosition()

◆ brush()

◆ color()

◆ draw()

◆ font()

◆ getTextDrawPoint()

◆ mainBrush()

◆ mainColor()

◆ mainFont()

◆ mainPen()

◆ padding()

◆ pen()

◆ positionAlignment()

◆ rotation()

◆ selectedBrush()

◆ selectedColor()

◆ selectedFont()

◆ selectedPen()

◆ selectTest()

◆ setBrush()

◆ setColor()

◆ setFont()

◆ setPadding()

◆ setPen()

◆ setPositionAlignment()

◆ setRotation()

◆ setSelectedBrush()

◆ setSelectedColor()

◆ setSelectedFont()

◆ setSelectedPen()

◆ setText()

◆ setTextAlignment()

◆ text()

◆ textAlignment()

Member Data Documentation

◆ bottom

◆ bottomLeft

◆ bottomRight

◆ left

◆ mBrush

◆ mColor

◆ mFont

◆ mPadding

◆ mPen

◆ mPositionAlignment

◆ mRotation

◆ mSelectedBrush

◆ mSelectedColor

◆ mSelectedFont

◆ mSelectedPen

◆ mText

◆ mTextAlignment

◆ position

◆ right

◆ top

◆ topLeft

◆ topRight