A legend item representing a plottable with an icon and the plottable name. More...
Inheritance diagram for QCPPlottableLegendItem:
Public Member Functions | |
| QCPPlottableLegendItem (QCPLegend *parent, QCPAbstractPlottable *plottable) | |
| Creates a new legend item associated with plottable. | |
| QCPAbstractPlottable * | plottable () |
 Public Member Functions inherited from QCPAbstractLegendItem | |
| QCPAbstractLegendItem (QCPLegend *parent) | |
| Constructs a QCPAbstractLegendItem and associates it with the QCPLegend parent. | |
| QCPLegend * | parentLegend () const |
| QFont | font () const |
| QColor | textColor () const |
| QFont | selectedFont () const |
| QColor | selectedTextColor () const |
| bool | selectable () const |
| bool | selected () const |
| void | setFont (const QFont &font) |
| Sets the default font of this specific legend item to font. | |
| void | setTextColor (const QColor &color) |
| Sets the default text color of this specific legend item to color. | |
| void | setSelectedFont (const QFont &font) |
| When this legend item is selected, font is used to draw generic text, instead of the normal font set with setFont. | |
| void | setSelectedTextColor (const QColor &color) |
| When this legend item is selected, color is used to draw generic text, instead of the normal color set with setTextColor. | |
| Q_SLOT void | setSelectable (bool selectable) |
| Sets whether this specific legend item is selectable. | |
| Q_SLOT void | setSelected (bool selected) |
| Sets whether this specific legend item is selected. | |
| virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE |
| Layout elements are sensitive to events inside their outer rect. | |
| Public Member Functions inherited from QCPLayoutElement | |
| QCPLayoutElement (QCustomPlot *parentPlot=0) | |
| Creates an instance of QCPLayoutElement and sets default values. | |
| QCPLayout * | layout () const |
| Returns the parent layout of this layout element. | |
| QRect | rect () const |
| Returns the inner rect of this layout element. | |
| QRect | outerRect () const |
| Returns the outer rect of this layout element. | |
| QMargins | margins () const |
| QMargins | minimumMargins () const |
| QCP::MarginSides | autoMargins () const |
| QSize | minimumSize () const |
| QSize | maximumSize () const |
| SizeConstraintRect | sizeConstraintRect () const |
| QCPMarginGroup * | marginGroup (QCP::MarginSide side) const |
| QHash< QCP::MarginSide, QCPMarginGroup * > | marginGroups () const |
| void | setOuterRect (const QRect &rect) |
| Sets the outer rect of this layout element. | |
| void | setMargins (const QMargins &margins) |
| Sets the margins of this layout element. | |
| void | setMinimumMargins (const QMargins &margins) |
| If setAutoMargins is enabled on some or all margins, this function is used to provide minimum values for those margins. | |
| void | setAutoMargins (QCP::MarginSides sides) |
| Sets on which sides the margin shall be calculated automatically. | |
| void | setMinimumSize (const QSize &size) |
| Sets the minimum size of this layout element. | |
| void | setMinimumSize (int width, int height) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the minimum size of this layout element. | |
| void | setMaximumSize (const QSize &size) |
| Sets the maximum size of this layout element. | |
| void | setMaximumSize (int width, int height) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the maximum size of this layout element. | |
| void | setSizeConstraintRect (SizeConstraintRect constraintRect) |
| Sets to which rect of a layout element the size constraints apply. | |
| void | setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group) |
| Sets the margin group of the specified margin sides. | |
| virtual void | update (UpdatePhase phase) |
| Updates the layout element and sub-elements. | |
| virtual QSize | minimumOuterSizeHint () const |
| Returns the suggested minimum size this layout element (the outerRect) may be compressed to, if no manual minimum size is set. | |
| virtual QSize | maximumOuterSizeHint () const |
| Returns the suggested maximum size this layout element (the outerRect) may be expanded to, if no manual maximum size is set. | |
| virtual QList< QCPLayoutElement * > | elements (bool recursive) const |
| Returns a list of all child elements in this layout element. | |
| virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE |
| Layout elements are sensitive to events inside their outer rect. | |
| Public Member Functions inherited from QCPLayerable | |
| QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0) | |
| Creates a new QCPLayerable instance. | |
| bool | visible () const |
| QCustomPlot * | parentPlot () const |
| QCPLayerable * | parentLayerable () const |
| Returns the parent layerable of this layerable. | |
| QCPLayer * | layer () const |
| bool | antialiased () const |
| void | setVisible (bool on) |
| Sets the visibility of this layerable object. | |
| Q_SLOT bool | setLayer (QCPLayer *layer) |
| Sets the layer of this layerable object. | |
| bool | setLayer (const QString &layerName) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name. | |
| void | setAntialiased (bool enabled) |
| Sets whether this object will be drawn antialiased or not. | |
| virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const |
| This function is used to decide whether a click hits a layerable object or not. | |
| bool | realVisibility () const |
| Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of this layerable's layer into account. | |
Protected Member Functions | |
| virtual void | draw (QCPPainter *painter) Q_DECL_OVERRIDE |
| virtual QSize | minimumOuterSizeHint () const Q_DECL_OVERRIDE |
| Returns the suggested minimum size this layout element (the outerRect) may be compressed to, if no manual minimum size is set. | |
| QPen | getIconBorderPen () const |
| QColor | getTextColor () const |
| QFont | getFont () const |
| Protected Member Functions inherited from QCPAbstractLegendItem | |
| virtual QCP::Interaction | selectionCategory () const Q_DECL_OVERRIDE |
| virtual void | applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE |
| virtual QRect | clipRect () const Q_DECL_OVERRIDE |
| virtual void | draw (QCPPainter *painter) Q_DECL_OVERRIDE=0 |
| virtual void | selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) Q_DECL_OVERRIDE |
| virtual void | deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE |
| Protected Member Functions inherited from QCPLayoutElement | |
| virtual int | calculateAutoMargin (QCP::MarginSide side) |
| virtual void | layoutChanged () |
| virtual void | applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE |
| virtual void | draw (QCPPainter *painter) Q_DECL_OVERRIDE |
| virtual void | parentPlotInitialized (QCustomPlot *parentPlot) Q_DECL_OVERRIDE |
| Protected Member Functions inherited from QCPLayerable | |
| virtual void | parentPlotInitialized (QCustomPlot *parentPlot) |
| virtual QCP::Interaction | selectionCategory () const |
| virtual QRect | clipRect () const |
| virtual void | applyDefaultAntialiasingHint (QCPPainter *painter) const =0 |
| virtual void | draw (QCPPainter *painter)=0 |
| virtual void | selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) |
| virtual void | deselectEvent (bool *selectionStateChanged) |
| virtual void | mousePressEvent (QMouseEvent *event, const QVariant &details) |
| This event gets called when the user presses a mouse button while the cursor is over the layerable. | |
| virtual void | mouseMoveEvent (QMouseEvent *event, const QPointF &startPos) |
| This event gets called when the user moves the mouse while holding a mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent. | |
| virtual void | mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos) |
| This event gets called when the user releases the mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent. | |
| virtual void | mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details) |
| This event gets called when the user presses the mouse button a second time in a double-click, while the cursor is over the layerable. | |
| virtual void | wheelEvent (QWheelEvent *event) |
| This event gets called when the user turns the mouse scroll wheel while the cursor is over the layerable. | |
| 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 | |
| QCPAbstractPlottable * | mPlottable |
| Protected Attributes inherited from QCPAbstractLegendItem | |
| QCPLegend * | mParentLegend |
| QFont | mFont |
| QColor | mTextColor |
| QFont | mSelectedFont |
| QColor | mSelectedTextColor |
| bool | mSelectable |
| bool | mSelected |
| Protected Attributes inherited from QCPLayoutElement | |
| QCPLayout * | mParentLayout |
| QSize | mMinimumSize |
| QSize | mMaximumSize |
| SizeConstraintRect | mSizeConstraintRect |
| QRect | mRect |
| QRect | mOuterRect |
| QMargins | mMargins |
| QMargins | mMinimumMargins |
| QCP::MarginSides | mAutoMargins |
| QHash< QCP::MarginSide, QCPMarginGroup * > | mMarginGroups |
| Protected Attributes inherited from QCPLayerable | |
| bool | mVisible |
| QCustomPlot * | mParentPlot |
| QPointer< QCPLayerable > | mParentLayerable |
| QCPLayer * | mLayer |
| bool | mAntialiased |
Additional Inherited Members | |
| Public Types inherited from QCPLayoutElement | |
| enum | UpdatePhase { upPreparation , upMargins , upLayout } |
| Defines the phases of the update process, that happens just before a replot. More... | |
| enum | SizeConstraintRect { scrInnerRect , scrOuterRect } |
| Defines to which rect of a layout element the size constraints that can be set via setMinimumSize and setMaximumSize apply. More... | |
| Signals inherited from QCPAbstractLegendItem | |
| void | selectionChanged (bool selected) |
| This signal is emitted when the selection state of this legend item has changed, either by user interaction or by a direct call to setSelected. | |
| void | selectableChanged (bool selectable) |
| Signals inherited from QCPLayerable | |
| void | layerChanged (QCPLayer *newLayer) |
| This signal is emitted when the layer of this layerable changes, i.e. | |
Detailed Description
A legend item representing a plottable with an icon and the plottable name.
This is the standard legend item for plottables. It displays an icon of the plottable next to the plottable name. The icon is drawn by the respective plottable itself (QCPAbstractPlottable::drawLegendIcon), and tries to give an intuitive symbol for the plottable. For example, the QCPGraph draws a centered horizontal line and/or a single scatter point in the middle.
Legend items of this type are always associated with one plottable (retrievable via the plottable() function and settable with the constructor). You may change the font of the plottable name with setFont. Icon padding and border pen is taken from the parent QCPLegend, see QCPLegend::setIconBorderPen and QCPLegend::setIconTextPadding.
The function QCPAbstractPlottable::addToLegend/ QCPAbstractPlottable::removeFromLegend creates/removes legend items of this type.
Since QCPLegend is based on QCPLayoutGrid, a legend item itself is just a subclass of QCPLayoutElement. While it could be added to a legend (or any other layout) via the normal layout interface, QCPLegend has specialized functions for handling legend items conveniently, see the documentation of QCPLegend.
Constructor & Destructor Documentation
◆ QCPPlottableLegendItem()
| QCPPlottableLegendItem::QCPPlottableLegendItem | ( | QCPLegend * | parent, |
| QCPAbstractPlottable * | plottable | ||
| ) |
Creates a new legend item associated with plottable.
Once it's created, it can be added to the legend via QCPLegend::addItem.
A more convenient way of adding/removing a plottable to/from the legend is via the functions QCPAbstractPlottable::addToLegend and QCPAbstractPlottable::removeFromLegend.
Member Function Documentation
◆ draw()
|
protectedvirtual |
Implements QCPAbstractLegendItem.
◆ minimumOuterSizeHint()
|
protectedvirtual |
Returns the suggested minimum size this layout element (the outerRect) may be compressed to, if no manual minimum size is set.
if a minimum size (setMinimumSize) was not set manually, parent layouts use the returned size (usually indirectly through QCPLayout::getFinalMinimumOuterSize) to determine the minimum allowed size of this layout element.
A manual minimum size is considered set if it is non-zero.
The default implementation simply returns the sum of the horizontal margins for the width and the sum of the vertical margins for the height. Reimplementations may use their detailed knowledge about the layout element's content to provide size hints.
Reimplemented from QCPLayoutElement.
The documentation for this class was generated from the following files:
- qcustomplot.h
- qcustomplot.cpp
