QCPItemText

Search for usage in LXR

Inheritance diagram for QCPItemText:

Public Member Functions

 QCPItemText (QCustomPlot *parentPlot)
 
QBrush brush () const
 
QColor color () const
 
QFont font () const
 
QMargins padding () const
 
QPen pen () const
 
Qt::Alignment positionAlignment () const
 
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=nullptr) const 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
 
- Public Member Functions inherited from QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
 
QCPItemAnchoranchor (const QString &name) const
 
QList< QCPItemAnchor * > anchors () const
 
QCPAxisRectclipAxisRect () const
 
bool clipToAxisRect () const
 
bool hasAnchor (const QString &name) const
 
QCPItemPositionposition (const QString &name) const
 
QList< QCPItemPosition * > positions () const
 
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)
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=nullptr)
 
bool antialiased () const
 
QCPLayerlayer () const
 
QCPLayerableparentLayerable () const
 
QCustomPlotparentPlot () const
 
bool realVisibility () const
 
void setAntialiased (bool enabled)
 
bool setLayer (const QString &layerName)
 
Q_SLOT bool setLayer (QCPLayer *layer)
 
void setVisible (bool on)
 
bool visible () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

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
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Protected Types

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

Protected Member Functions

virtual QPointF anchorPixelPosition (int anchorId) const override
 
virtual void draw (QCPPainter *painter) 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 override
 
virtual QRect clipRect () const override
 
QCPItemAnchorcreateAnchor (const QString &name, int anchorId)
 
QCPItemPositioncreatePosition (const QString &name)
 
virtual void deselectEvent (bool *selectionStateChanged) override
 
double rectDistance (const QRectF &rect, const QPointF &pos, bool filledRect) const
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) override
 
virtual QCP::Interaction selectionCategory () const 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 Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *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< QCPAxisRectmClipAxisRect
 
bool mClipToAxisRect
 
QList< QCPItemPosition * > mPositions
 
bool mSelectable
 
bool mSelected
 
- Protected Attributes inherited from QCPLayerable
bool mAntialiased
 
QCPLayermLayer
 
QPointer< QCPLayerablemParentLayerable
 
QCustomPlotmParentPlot
 
bool mVisible
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Signals inherited from QCPAbstractItem
void selectableChanged (bool selectable)
 
void selectionChanged (bool selected)
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 

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

Member Enumeration Documentation

◆ AnchorIndex

enum QCPItemText::AnchorIndex
protected

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

◆ ~QCPItemText()

QCPItemText::~QCPItemText ( )
overridevirtual

Definition at line 29625 of file qcustomplot.cpp.

Member Function Documentation

◆ anchorPixelPosition()

QPointF QCPItemText::anchorPixelPosition ( int anchorId) const
overrideprotectedvirtual

Returns the pixel position of the anchor with Id anchorId. This function must be reimplemented in item subclasses if they want to provide anchors (QCPItemAnchor).

For example, if the item has two anchors with id 0 and 1, this function takes one of these anchor ids and returns the respective pixel points of the specified anchor.

See also
createAnchor

Reimplemented from QCPAbstractItem.

Definition at line 29820 of file qcustomplot.cpp.

◆ brush()

QBrush QCPItemText::brush ( ) const
inline

Definition at line 6594 of file qcustomplot.h.

◆ color()

QColor QCPItemText::color ( ) const
inline

Definition at line 6590 of file qcustomplot.h.

◆ draw()

void QCPItemText::draw ( QCPPainter * painter)
overrideprotectedvirtual

Draws this item with the provided painter.

The cliprect of the provided painter is set to the rect returned by clipRect before this function is called. The clipRect depends on the clipping settings defined by setClipToAxisRect and setClipAxisRect.

Implements QCPAbstractItem.

Definition at line 29788 of file qcustomplot.cpp.

◆ font()

QFont QCPItemText::font ( ) const
inline

Definition at line 6596 of file qcustomplot.h.

◆ getTextDrawPoint()

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

Returns the point that must be given to the QPainter::drawText function (which expects the top left point of the text rect), according to the position pos, the text bounding box rect and the requested positionAlignment.

For example, if positionAlignment is Qt::AlignLeft | Qt::AlignBottom the returned point will be shifted upward by the height of rect, starting from pos. So if the text is finally drawn at that point, the lower left corner of the resulting text rect is at pos.

Definition at line 29861 of file qcustomplot.cpp.

◆ mainBrush()

QBrush QCPItemText::mainBrush ( ) const
protected

Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item is not selected and mSelectedBrush when it is.

Definition at line 29913 of file qcustomplot.cpp.

◆ mainColor()

QColor QCPItemText::mainColor ( ) const
protected

Returns the color that should be used for drawing text. Returns mColor when the item is not selected and mSelectedColor when it is.

Definition at line 29893 of file qcustomplot.cpp.

◆ mainFont()

QFont QCPItemText::mainFont ( ) const
protected

Returns the font that should be used for drawing text. Returns mFont when the item is not selected and mSelectedFont when it is.

Definition at line 29883 of file qcustomplot.cpp.

◆ mainPen()

QPen QCPItemText::mainPen ( ) const
protected

Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected and mSelectedPen when it is.

Definition at line 29903 of file qcustomplot.cpp.

◆ padding()

QMargins QCPItemText::padding ( ) const
inline

Definition at line 6602 of file qcustomplot.h.

◆ pen()

QPen QCPItemText::pen ( ) const
inline

Definition at line 6592 of file qcustomplot.h.

◆ positionAlignment()

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

Definition at line 6599 of file qcustomplot.h.

◆ rotation()

double QCPItemText::rotation ( ) const
inline

Definition at line 6601 of file qcustomplot.h.

◆ selectedBrush()

QBrush QCPItemText::selectedBrush ( ) const
inline

Definition at line 6595 of file qcustomplot.h.

◆ selectedColor()

QColor QCPItemText::selectedColor ( ) const
inline

Definition at line 6591 of file qcustomplot.h.

◆ selectedFont()

QFont QCPItemText::selectedFont ( ) const
inline

Definition at line 6597 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemText::selectedPen ( ) const
inline

Definition at line 6593 of file qcustomplot.h.

◆ selectTest()

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

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 nullptr 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 29764 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 29673 of file qcustomplot.cpp.

◆ setColor()

void QCPItemText::setColor ( const QColor & color)

Sets the color of the text.

Definition at line 29632 of file qcustomplot.cpp.

◆ setFont()

void QCPItemText::setFont ( const QFont & font)

Sets the font of the text.

See also
setSelectedFont, setColor

Definition at line 29694 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 29758 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 29651 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 you want to control the alignment of (multi-lined) text within the text rect, use setTextAlignment.

Definition at line 29732 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 29749 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 29684 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 29640 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 29704 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 29662 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 29715 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 29740 of file qcustomplot.cpp.

◆ text()

QString QCPItemText::text ( ) const
inline

Definition at line 6598 of file qcustomplot.h.

◆ textAlignment()

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

Definition at line 6600 of file qcustomplot.h.

Member Data Documentation

◆ bottom

QCPItemAnchor* const QCPItemText::bottom

Definition at line 6628 of file qcustomplot.h.

◆ bottomLeft

QCPItemAnchor* const QCPItemText::bottomLeft

Definition at line 6629 of file qcustomplot.h.

◆ bottomRight

QCPItemAnchor* const QCPItemText::bottomRight

Definition at line 6627 of file qcustomplot.h.

◆ left

QCPItemAnchor* const QCPItemText::left

Definition at line 6630 of file qcustomplot.h.

◆ mBrush

QBrush QCPItemText::mBrush
protected

Definition at line 6638 of file qcustomplot.h.

◆ mColor

QColor QCPItemText::mColor
protected

Definition at line 6636 of file qcustomplot.h.

◆ mFont

QFont QCPItemText::mFont
protected

Definition at line 6639 of file qcustomplot.h.

◆ mPadding

QMargins QCPItemText::mPadding
protected

Definition at line 6644 of file qcustomplot.h.

◆ mPen

QPen QCPItemText::mPen
protected

Definition at line 6637 of file qcustomplot.h.

◆ mPositionAlignment

Qt::Alignment QCPItemText::mPositionAlignment
protected

Definition at line 6641 of file qcustomplot.h.

◆ mRotation

double QCPItemText::mRotation
protected

Definition at line 6643 of file qcustomplot.h.

◆ mSelectedBrush

QBrush QCPItemText::mSelectedBrush
protected

Definition at line 6638 of file qcustomplot.h.

◆ mSelectedColor

QColor QCPItemText::mSelectedColor
protected

Definition at line 6636 of file qcustomplot.h.

◆ mSelectedFont

QFont QCPItemText::mSelectedFont
protected

Definition at line 6639 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemText::mSelectedPen
protected

Definition at line 6637 of file qcustomplot.h.

◆ mText

QString QCPItemText::mText
protected

Definition at line 6640 of file qcustomplot.h.

◆ mTextAlignment

Qt::Alignment QCPItemText::mTextAlignment
protected

Definition at line 6642 of file qcustomplot.h.

◆ position

QCPItemPosition* const QCPItemText::position

Definition at line 6622 of file qcustomplot.h.

◆ right

QCPItemAnchor* const QCPItemText::right

Definition at line 6626 of file qcustomplot.h.

◆ top

QCPItemAnchor* const QCPItemText::top

Definition at line 6624 of file qcustomplot.h.

◆ topLeft

QCPItemAnchor* const QCPItemText::topLeft

Definition at line 6623 of file qcustomplot.h.

◆ topRight

QCPItemAnchor* const QCPItemText::topRight

Definition at line 6625 of file qcustomplot.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:48:28 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.