SimCenterCommon
Common functionality used within different SimCenter projects
QCPTextElement Class Reference

A layout element displaying a text. More...

#include <qcustomplot.h>

Inheritance diagram for QCPTextElement:
Collaboration diagram for QCPTextElement:

Signals

void selectionChanged (bool selected)
 
void selectableChanged (bool selectable)
 
void clicked (QMouseEvent *event)
 
void doubleClicked (QMouseEvent *event)
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 

Public Member Functions

 QCPTextElement (QCustomPlot *parentPlot)
 
 QCPTextElement (QCustomPlot *parentPlot, const QString &text)
 
 QCPTextElement (QCustomPlot *parentPlot, const QString &text, double pointSize)
 
 QCPTextElement (QCustomPlot *parentPlot, const QString &text, const QString &fontFamily, double pointSize)
 
 QCPTextElement (QCustomPlot *parentPlot, const QString &text, const QFont &font)
 
QString text () const
 
int textFlags () const
 
QFont font () const
 
QColor textColor () const
 
QFont selectedFont () const
 
QColor selectedTextColor () const
 
bool selectable () const
 
bool selected () const
 
void setText (const QString &text)
 
void setTextFlags (int flags)
 
void setFont (const QFont &font)
 
void setTextColor (const QColor &color)
 
void setSelectedFont (const QFont &font)
 
void setSelectedTextColor (const QColor &color)
 
Q_SLOT void setSelectable (bool selectable)
 
Q_SLOT void setSelected (bool selected)
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE
 
virtual void mousePressEvent (QMouseEvent *event, const QVariant &details) Q_DECL_OVERRIDE
 
virtual void mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos) Q_DECL_OVERRIDE
 
virtual void mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details) Q_DECL_OVERRIDE
 
- Public Member Functions inherited from QCPLayoutElement
 QCPLayoutElement (QCustomPlot *parentPlot=0)
 
virtual ~QCPLayoutElement ()
 
QCPLayoutlayout () const
 
QRect rect () const
 
QRect outerRect () const
 
QMargins margins () const
 
QMargins minimumMargins () const
 
QCP::MarginSides autoMargins () const
 
QSize minimumSize () const
 
QSize maximumSize () const
 
QCPMarginGroupmarginGroup (QCP::MarginSide side) const
 
QHash< QCP::MarginSide, QCPMarginGroup * > marginGroups () const
 
void setOuterRect (const QRect &rect)
 
void setMargins (const QMargins &margins)
 
void setMinimumMargins (const QMargins &margins)
 
void setAutoMargins (QCP::MarginSides sides)
 
void setMinimumSize (const QSize &size)
 
void setMinimumSize (int width, int height)
 
void setMaximumSize (const QSize &size)
 
void setMaximumSize (int width, int height)
 
void setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group)
 
virtual void update (UpdatePhase phase)
 
virtual QList< QCPLayoutElement * > elements (bool recursive) const
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 
virtual ~QCPLayerable ()
 
bool visible () const
 
QCustomPlotparentPlot () const
 
QCPLayerableparentLayerable () const
 
QCPLayerlayer () 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
 

Protected Member Functions

virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE
 
virtual void draw (QCPPainter *painter) Q_DECL_OVERRIDE
 
virtual QSize minimumSizeHint () const Q_DECL_OVERRIDE
 
virtual QSize maximumSizeHint () 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
 
QFont mainFont () const
 
QColor mainTextColor () const
 
- Protected Member Functions inherited from QCPLayoutElement
virtual int calculateAutoMargin (QCP::MarginSide side)
 
virtual void layoutChanged ()
 
virtual void parentPlotInitialized (QCustomPlot *parentPlot) Q_DECL_OVERRIDE
 
- Protected Member Functions inherited from QCPLayerable
virtual QCP::Interaction selectionCategory () const
 
virtual QRect clipRect () const
 
virtual void mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)
 
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

QString mText
 
int mTextFlags
 
QFont mFont
 
QColor mTextColor
 
QFont mSelectedFont
 
QColor mSelectedTextColor
 
QRect mTextBoundingRect
 
bool mSelectable
 
bool mSelected
 
- Protected Attributes inherited from QCPLayoutElement
QCPLayoutmParentLayout
 
QSize mMinimumSize
 
QSize mMaximumSize
 
QRect mRect
 
QRect mOuterRect
 
QMargins mMargins
 
QMargins mMinimumMargins
 
QCP::MarginSides mAutoMargins
 
QHash< QCP::MarginSide, QCPMarginGroup * > mMarginGroups
 
- Protected Attributes inherited from QCPLayerable
bool mVisible
 
QCustomPlotmParentPlot
 
QPointer< QCPLayerablemParentLayerable
 
QCPLayermLayer
 
bool mAntialiased
 

Additional Inherited Members

- Public Types inherited from QCPLayoutElement
enum  UpdatePhase { upPreparation, upMargins, upLayout }
 

Detailed Description

A layout element displaying a text.

The text may be specified with setText, the formatting can be controlled with setFont, setTextColor, and setTextFlags.

A text element can be added as follows:

Definition at line 4893 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPTextElement::QCPTextElement ( QCustomPlot parentPlot)
explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Creates a new QCPTextElement instance and sets default values. The initial text is empty (setText).

Definition at line 18609 of file qcustomplot.cpp.

QCPTextElement::QCPTextElement ( QCustomPlot parentPlot,
const QString &  text 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Creates a new QCPTextElement instance and sets default values.

The initial text is set to text.

Definition at line 18634 of file qcustomplot.cpp.

QCPTextElement::QCPTextElement ( QCustomPlot parentPlot,
const QString &  text,
double  pointSize 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Creates a new QCPTextElement instance and sets default values.

The initial text is set to text with pointSize.

Definition at line 18659 of file qcustomplot.cpp.

QCPTextElement::QCPTextElement ( QCustomPlot parentPlot,
const QString &  text,
const QString &  fontFamily,
double  pointSize 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Creates a new QCPTextElement instance and sets default values.

The initial text is set to text with pointSize and the specified fontFamily.

Definition at line 18686 of file qcustomplot.cpp.

QCPTextElement::QCPTextElement ( QCustomPlot parentPlot,
const QString &  text,
const QFont &  font 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Creates a new QCPTextElement instance and sets default values.

The initial text is set to text with the specified font.

Definition at line 18706 of file qcustomplot.cpp.

Member Function Documentation

void QCPTextElement::applyDefaultAntialiasingHint ( QCPPainter painter) const
protectedvirtual

Reimplemented from QCPLayoutElement.

Definition at line 18827 of file qcustomplot.cpp.

void QCPTextElement::clicked ( QMouseEvent *  event)
signal

This signal is emitted when the text element is clicked.

See also
doubleClicked, selectTest
void QCPTextElement::deselectEvent ( bool *  selectionStateChanged)
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 18875 of file qcustomplot.cpp.

void QCPTextElement::doubleClicked ( QMouseEvent *  event)
signal

This signal is emitted when the text element is double clicked.

See also
clicked, selectTest
void QCPTextElement::draw ( QCPPainter painter)
protectedvirtual

Reimplemented from QCPLayoutElement.

Definition at line 18833 of file qcustomplot.cpp.

QFont QCPTextElement::font ( ) const
inline

Definition at line 4915 of file qcustomplot.h.

QFont QCPTextElement::mainFont ( ) const
protected

Definition at line 18948 of file qcustomplot.cpp.

QColor QCPTextElement::mainTextColor ( ) const
protected

Definition at line 18958 of file qcustomplot.cpp.

QSize QCPTextElement::maximumSizeHint ( ) const
protectedvirtual

Returns the maximum size this layout element (the inner rect) may be expanded to.

if a maximum size (setMaximumSize) was not set manually, parent layouts consult this function to determine the maximum allowed size of this layout element. (A manual maximum size is considered set if it is smaller than Qt's QWIDGETSIZE_MAX.)

Reimplemented from QCPLayoutElement.

Definition at line 18851 of file qcustomplot.cpp.

QSize QCPTextElement::minimumSizeHint ( ) const
protectedvirtual

Returns the minimum size this layout element (the inner rect) may be compressed to.

if a minimum size (setMinimumSize) was not set manually, parent layouts consult this function to determine the minimum allowed size of this layout element. (A manual minimum size is considered set if it is non-zero.)

Reimplemented from QCPLayoutElement.

Definition at line 18841 of file qcustomplot.cpp.

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

Emits the doubleClicked signal.

Reimplemented from QCPLayerable.

Definition at line 18937 of file qcustomplot.cpp.

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

Accepts the mouse event in order to emit the according click signal in the mouseReleaseEvent.

Reimplemented from QCPLayerable.

Definition at line 18914 of file qcustomplot.cpp.

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

Emits the clicked signal if the cursor hasn't moved by more than a few pixels since the mousePressEvent.

Reimplemented from QCPLayerable.

Definition at line 18926 of file qcustomplot.cpp.

bool QCPTextElement::selectable ( ) const
inline

Definition at line 4919 of file qcustomplot.h.

void QCPTextElement::selectableChanged ( bool  selectable)
signal
bool QCPTextElement::selected ( ) const
inline

Definition at line 4920 of file qcustomplot.h.

QFont QCPTextElement::selectedFont ( ) const
inline

Definition at line 4917 of file qcustomplot.h.

QColor QCPTextElement::selectedTextColor ( ) const
inline

Definition at line 4918 of file qcustomplot.h.

void QCPTextElement::selectEvent ( QMouseEvent *  event,
bool  additive,
const QVariant &  details,
bool *  selectionStateChanged 
)
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 18861 of file qcustomplot.cpp.

void QCPTextElement::selectionChanged ( bool  selected)
signal

This signal is emitted when the selection state has changed to selected, either by user interaction or by a direct call to setSelected.

See also
setSelected, setSelectable
double QCPTextElement::selectTest ( const QPointF &  pos,
bool  onlySelectable,
QVariant *  details = 0 
) const
virtual

Returns 0.99*selectionTolerance (see QCustomPlot::setSelectionTolerance) when pos is within the bounding box of the text element's text. Note that this bounding box is updated in the draw call.

If pos is outside the text's bounding box or if onlySelectable is true and this text element is not selectable (setSelectable), returns -1.

Reimplemented from QCPLayoutElement.

Definition at line 18896 of file qcustomplot.cpp.

void QCPTextElement::setFont ( const QFont &  font)

Sets the font of the text.

See also
setTextColor, setSelectedFont

Definition at line 18760 of file qcustomplot.cpp.

void QCPTextElement::setSelectable ( bool  selectable)

Sets whether the user may select this text element.

Note that even when selectable is set to false, the selection state may be changed programmatically via setSelected.

Definition at line 18801 of file qcustomplot.cpp.

void QCPTextElement::setSelected ( bool  selected)

Sets the selection state of this text element to selected. If the selection has changed, selectionChanged is emitted.

Note that this function can change the selection state independently of the current setSelectable state.

Definition at line 18817 of file qcustomplot.cpp.

void QCPTextElement::setSelectedFont ( const QFont &  font)

Sets the font of the text that will be used if the text element is selected (setSelected).

See also
setFont

Definition at line 18780 of file qcustomplot.cpp.

void QCPTextElement::setSelectedTextColor ( const QColor &  color)

Sets the color of the text that will be used if the text element is selected (setSelected).

See also
setTextColor

Definition at line 18790 of file qcustomplot.cpp.

void QCPTextElement::setText ( const QString &  text)

Sets the text that will be displayed to text. Multiple lines can be created by insertion of "\n".

See also
setFont, setTextColor, setTextFlags

Definition at line 18725 of file qcustomplot.cpp.

void QCPTextElement::setTextColor ( const QColor &  color)

Sets the color of the text.

See also
setFont, setSelectedTextColor

Definition at line 18770 of file qcustomplot.cpp.

void QCPTextElement::setTextFlags ( int  flags)

Sets options for text alignment and wrapping behaviour. flags is a bitwise OR-combination of Qt::AlignmentFlag and Qt::TextFlag enums.

Possible enums are:

  • Qt::AlignLeft
  • Qt::AlignRight
  • Qt::AlignHCenter
  • Qt::AlignJustify
  • Qt::AlignTop
  • Qt::AlignBottom
  • Qt::AlignVCenter
  • Qt::AlignCenter
  • Qt::TextDontClip
  • Qt::TextSingleLine
  • Qt::TextExpandTabs
  • Qt::TextShowMnemonic
  • Qt::TextWordWrap
  • Qt::TextIncludeTrailingSpaces

Definition at line 18750 of file qcustomplot.cpp.

QString QCPTextElement::text ( ) const
inline

Definition at line 4913 of file qcustomplot.h.

QColor QCPTextElement::textColor ( ) const
inline

Definition at line 4916 of file qcustomplot.h.

int QCPTextElement::textFlags ( ) const
inline

Definition at line 4914 of file qcustomplot.h.

Member Data Documentation

QFont QCPTextElement::mFont
protected

Definition at line 4948 of file qcustomplot.h.

bool QCPTextElement::mSelectable
protected

Definition at line 4953 of file qcustomplot.h.

bool QCPTextElement::mSelected
protected

Definition at line 4953 of file qcustomplot.h.

QFont QCPTextElement::mSelectedFont
protected

Definition at line 4950 of file qcustomplot.h.

QColor QCPTextElement::mSelectedTextColor
protected

Definition at line 4951 of file qcustomplot.h.

QString QCPTextElement::mText
protected

Definition at line 4946 of file qcustomplot.h.

QRect QCPTextElement::mTextBoundingRect
protected

Definition at line 4952 of file qcustomplot.h.

QColor QCPTextElement::mTextColor
protected

Definition at line 4949 of file qcustomplot.h.

int QCPTextElement::mTextFlags
protected

Definition at line 4947 of file qcustomplot.h.


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