Nakuja Flight Computer Testing and Simulation Engine (NaFCTSE) 1.0
A testing and verification tool for the Nakuja Rocket Project flight computers
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...

Inheritance diagram for QCPItemText:
QCPAbstractItem QCPLayerable

Public Member Functions

 QCPItemText (QCustomPlot *parentPlot)
 
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=nullptr) const Q_DECL_OVERRIDE
 
- Public Member Functions inherited from QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
 
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=nullptr)
 
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.

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 = nullptr ) 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 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.

◆ 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

◆ setColor()

void QCPItemText::setColor ( const QColor & color)

Sets the color of the text.

◆ 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.

◆ 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.

◆ 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

◆ setSelectedColor()

void QCPItemText::setSelectedColor ( const QColor & color)

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

◆ 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

◆ 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).

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