A text label. More...

#include <qcustomplot.h>

Inheritance diagram for QCPItemText:

Collaboration diagram for QCPItemText:

[legend]

Public Member Functions
	QCPItemText (QCustomPlot *parentPlot)

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)

void	setSelectedColor (const QColor &color)

void	setPen (const QPen &pen)

void	setSelectedPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setSelectedBrush (const QBrush &brush)

void	setFont (const QFont &font)

void	setSelectedFont (const QFont &font)

void	setText (const QString &text)

void	setPositionAlignment (Qt::Alignment alignment)

void	setTextAlignment (Qt::Alignment alignment)

void	setRotation (double degrees)

void	setPadding (const QMargins &padding)

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

Public Member Functions inherited from QCPAbstractItem
	QCPAbstractItem (QCustomPlot *parentPlot)

virtual	~QCPAbstractItem ()

bool	clipToAxisRect () const

QCPAxisRect *	clipAxisRect () const

bool	selectable () const

bool	selected () const

void	setClipToAxisRect (bool clip)

void	setClipAxisRect (QCPAxisRect *rect)

Q_SLOT void	setSelectable (bool selectable)

Q_SLOT void	setSelected (bool selected)

QList< QCPItemPosition * >	positions () const

QList< QCPItemAnchor * >	anchors () const

QCPItemPosition *	position (const QString &name) const

QCPItemAnchor *	anchor (const QString &name) const

bool	hasAnchor (const QString &name) const

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

virtual	~QCPLayerable ()

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setAntialiased (bool enabled)

bool	realVisibility () const

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) 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	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged) Q_DECL_OVERRIDE

virtual void	deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE

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 void	mousePressEvent (QMouseEvent *event, const QVariant &details)

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

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

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

virtual void	wheelEvent (QWheelEvent *event)

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)

void	selectableChanged (bool selectable)

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

Member Enumeration Documentation

enum QCPItemText::AnchorIndex

protected

Enumerator
aiTopLeft
aiTop
aiTopRight
aiRight
aiBottomRight
aiBottom
aiBottomLeft
aiLeft

Definition at line 6315 of file qcustomplot.h.

Constructor & Destructor Documentation

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 28368 of file qcustomplot.cpp.

QCPItemText::~QCPItemText ( )

virtual

Definition at line 28394 of file qcustomplot.cpp.

Member Function Documentation

QPointF QCPItemText::anchorPixelPosition ( int anchorId ) const

protectedvirtual

Reimplemented from QCPAbstractItem.

Definition at line 28589 of file qcustomplot.cpp.

QBrush QCPItemText::brush ( ) const

inline

Definition at line 6276 of file qcustomplot.h.

QColor QCPItemText::color ( ) const

inline

Definition at line 6272 of file qcustomplot.h.

void QCPItemText::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractItem.

Definition at line 28557 of file qcustomplot.cpp.

QFont QCPItemText::font ( ) const

inline

Definition at line 6278 of file qcustomplot.h.

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

protected

Definition at line 28630 of file qcustomplot.cpp.

QBrush QCPItemText::mainBrush ( ) const

protected

Definition at line 28682 of file qcustomplot.cpp.

QColor QCPItemText::mainColor ( ) const

protected

Definition at line 28662 of file qcustomplot.cpp.

QFont QCPItemText::mainFont ( ) const

protected

Definition at line 28652 of file qcustomplot.cpp.

QPen QCPItemText::mainPen ( ) const

protected

Definition at line 28672 of file qcustomplot.cpp.

QMargins QCPItemText::padding ( ) const

inline

Definition at line 6284 of file qcustomplot.h.

QPen QCPItemText::pen ( ) const

inline

Definition at line 6274 of file qcustomplot.h.

Qt::Alignment QCPItemText::positionAlignment ( ) const

inline

Definition at line 6281 of file qcustomplot.h.

double QCPItemText::rotation ( ) const

inline

Definition at line 6283 of file qcustomplot.h.

QBrush QCPItemText::selectedBrush ( ) const

inline

Definition at line 6277 of file qcustomplot.h.

QColor QCPItemText::selectedColor ( ) const

inline

Definition at line 6273 of file qcustomplot.h.

QFont QCPItemText::selectedFont ( ) const

inline

Definition at line 6279 of file qcustomplot.h.

QPen QCPItemText::selectedPen ( ) const

inline

Definition at line 6275 of file qcustomplot.h.

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.

Definition at line 28533 of file qcustomplot.cpp.

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 28442 of file qcustomplot.cpp.

void QCPItemText::setColor ( const QColor & color )

Sets the color of the text.

Definition at line 28401 of file qcustomplot.cpp.

void QCPItemText::setFont ( const QFont & font )

Sets the font of the text.

See also: setSelectedFont, setColor

Definition at line 28463 of file qcustomplot.cpp.

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 28527 of file qcustomplot.cpp.

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 28420 of file qcustomplot.cpp.

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 28501 of file qcustomplot.cpp.

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 28518 of file qcustomplot.cpp.

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 28453 of file qcustomplot.cpp.

void QCPItemText::setSelectedColor ( const QColor & color )

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

Definition at line 28409 of file qcustomplot.cpp.

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 28473 of file qcustomplot.cpp.

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 28431 of file qcustomplot.cpp.

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 28484 of file qcustomplot.cpp.

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 28509 of file qcustomplot.cpp.

QString QCPItemText::text ( ) const

inline

Definition at line 6280 of file qcustomplot.h.

Qt::Alignment QCPItemText::textAlignment ( ) const

inline

Definition at line 6282 of file qcustomplot.h.

Member Data Documentation

QCPItemAnchor* const QCPItemText::bottom

Definition at line 6310 of file qcustomplot.h.

QCPItemAnchor* const QCPItemText::bottomLeft

Definition at line 6311 of file qcustomplot.h.

QCPItemAnchor* const QCPItemText::bottomRight

Definition at line 6309 of file qcustomplot.h.

QCPItemAnchor* const QCPItemText::left

Definition at line 6312 of file qcustomplot.h.

QBrush QCPItemText::mBrush

protected

Definition at line 6320 of file qcustomplot.h.

QColor QCPItemText::mColor

protected

Definition at line 6318 of file qcustomplot.h.

QFont QCPItemText::mFont

protected

Definition at line 6321 of file qcustomplot.h.

QMargins QCPItemText::mPadding

protected

Definition at line 6326 of file qcustomplot.h.

QPen QCPItemText::mPen

protected

Definition at line 6319 of file qcustomplot.h.

Qt::Alignment QCPItemText::mPositionAlignment

protected

Definition at line 6323 of file qcustomplot.h.

double QCPItemText::mRotation

protected

Definition at line 6325 of file qcustomplot.h.

QBrush QCPItemText::mSelectedBrush

protected

Definition at line 6320 of file qcustomplot.h.

QColor QCPItemText::mSelectedColor

protected

Definition at line 6318 of file qcustomplot.h.

QFont QCPItemText::mSelectedFont

protected

Definition at line 6321 of file qcustomplot.h.

QPen QCPItemText::mSelectedPen

protected

Definition at line 6319 of file qcustomplot.h.

QString QCPItemText::mText

protected

Definition at line 6322 of file qcustomplot.h.

Qt::Alignment QCPItemText::mTextAlignment

protected

Definition at line 6324 of file qcustomplot.h.

QCPItemPosition* const QCPItemText::position

Definition at line 6304 of file qcustomplot.h.

QCPItemAnchor* const QCPItemText::right

Definition at line 6308 of file qcustomplot.h.

QCPItemAnchor* const QCPItemText::top

Definition at line 6306 of file qcustomplot.h.

QCPItemAnchor* const QCPItemText::topLeft

Definition at line 6305 of file qcustomplot.h.

QCPItemAnchor* const QCPItemText::topRight

Definition at line 6307 of file qcustomplot.h.

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

Workflow/GRAPHICS/qcustomplot.h
Workflow/GRAPHICS/qcustomplot.cpp

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation