SimCenterCommon
Common functionality used within different SimCenter projects
|
Manages a legend inside a QCustomPlot. More...
#include <qcustomplot.h>
Public Types | |
enum | SelectablePart { spNone = 0x000, spLegendBox = 0x001, spItems = 0x002 } |
Public Types inherited from QCPLayoutGrid | |
enum | FillOrder { foRowsFirst, foColumnsFirst } |
Public Types inherited from QCPLayoutElement | |
enum | UpdatePhase { upPreparation, upMargins, upLayout } |
Signals | |
void | selectionChanged (QCPLegend::SelectableParts parts) |
void | selectableChanged (QCPLegend::SelectableParts parts) |
Signals inherited from QCPLayerable | |
void | layerChanged (QCPLayer *newLayer) |
Public Member Functions | |
QCPLegend () | |
virtual | ~QCPLegend () |
QPen | borderPen () const |
QBrush | brush () const |
QFont | font () const |
QColor | textColor () const |
QSize | iconSize () const |
int | iconTextPadding () const |
QPen | iconBorderPen () const |
SelectableParts | selectableParts () const |
SelectableParts | selectedParts () const |
QPen | selectedBorderPen () const |
QPen | selectedIconBorderPen () const |
QBrush | selectedBrush () const |
QFont | selectedFont () const |
QColor | selectedTextColor () const |
void | setBorderPen (const QPen &pen) |
void | setBrush (const QBrush &brush) |
void | setFont (const QFont &font) |
void | setTextColor (const QColor &color) |
void | setIconSize (const QSize &size) |
void | setIconSize (int width, int height) |
void | setIconTextPadding (int padding) |
void | setIconBorderPen (const QPen &pen) |
Q_SLOT void | setSelectableParts (const SelectableParts &selectableParts) |
Q_SLOT void | setSelectedParts (const SelectableParts &selectedParts) |
void | setSelectedBorderPen (const QPen &pen) |
void | setSelectedIconBorderPen (const QPen &pen) |
void | setSelectedBrush (const QBrush &brush) |
void | setSelectedFont (const QFont &font) |
void | setSelectedTextColor (const QColor &color) |
virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE |
QCPAbstractLegendItem * | item (int index) const |
QCPPlottableLegendItem * | itemWithPlottable (const QCPAbstractPlottable *plottable) const |
int | itemCount () const |
bool | hasItem (QCPAbstractLegendItem *item) const |
bool | hasItemWithPlottable (const QCPAbstractPlottable *plottable) const |
bool | addItem (QCPAbstractLegendItem *item) |
bool | removeItem (int index) |
bool | removeItem (QCPAbstractLegendItem *item) |
void | clearItems () |
QList< QCPAbstractLegendItem * > | selectedItems () const |
Public Member Functions inherited from QCPLayoutGrid | |
QCPLayoutGrid () | |
virtual | ~QCPLayoutGrid () |
int | rowCount () const |
int | columnCount () const |
QList< double > | columnStretchFactors () const |
QList< double > | rowStretchFactors () const |
int | columnSpacing () const |
int | rowSpacing () const |
int | wrap () const |
FillOrder | fillOrder () const |
void | setColumnStretchFactor (int column, double factor) |
void | setColumnStretchFactors (const QList< double > &factors) |
void | setRowStretchFactor (int row, double factor) |
void | setRowStretchFactors (const QList< double > &factors) |
void | setColumnSpacing (int pixels) |
void | setRowSpacing (int pixels) |
void | setWrap (int count) |
void | setFillOrder (FillOrder order, bool rearrange=true) |
virtual void | updateLayout () Q_DECL_OVERRIDE |
virtual int | elementCount () const Q_DECL_OVERRIDE |
virtual QCPLayoutElement * | elementAt (int index) const Q_DECL_OVERRIDE |
virtual QCPLayoutElement * | takeAt (int index) Q_DECL_OVERRIDE |
virtual bool | take (QCPLayoutElement *element) Q_DECL_OVERRIDE |
virtual QList< QCPLayoutElement * > | elements (bool recursive) const Q_DECL_OVERRIDE |
virtual void | simplify () Q_DECL_OVERRIDE |
virtual QSize | minimumSizeHint () const Q_DECL_OVERRIDE |
virtual QSize | maximumSizeHint () const Q_DECL_OVERRIDE |
QCPLayoutElement * | element (int row, int column) const |
bool | addElement (int row, int column, QCPLayoutElement *element) |
bool | addElement (QCPLayoutElement *element) |
bool | hasElement (int row, int column) |
void | expandTo (int newRowCount, int newColumnCount) |
void | insertRow (int newIndex) |
void | insertColumn (int newIndex) |
int | rowColToIndex (int row, int column) const |
void | indexToRowCol (int index, int &row, int &column) const |
Public Member Functions inherited from QCPLayout | |
QCPLayout () | |
virtual void | update (UpdatePhase phase) Q_DECL_OVERRIDE |
bool | removeAt (int index) |
bool | remove (QCPLayoutElement *element) |
void | clear () |
Public Member Functions inherited from QCPLayoutElement | |
QCPLayoutElement (QCustomPlot *parentPlot=0) | |
virtual | ~QCPLayoutElement () |
QCPLayout * | layout () const |
QRect | rect () const |
QRect | outerRect () const |
QMargins | margins () const |
QMargins | minimumMargins () const |
QCP::MarginSides | autoMargins () const |
QSize | minimumSize () const |
QSize | maximumSize () const |
QCPMarginGroup * | marginGroup (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) |
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 |
Protected Member Functions | |
virtual void | parentPlotInitialized (QCustomPlot *parentPlot) Q_DECL_OVERRIDE |
virtual QCP::Interaction | selectionCategory () const Q_DECL_OVERRIDE |
virtual void | applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE |
virtual void | draw (QCPPainter *painter) 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 |
QPen | getBorderPen () const |
QBrush | getBrush () const |
Protected Member Functions inherited from QCPLayoutGrid | |
void | getMinimumRowColSizes (QVector< int > *minColWidths, QVector< int > *minRowHeights) const |
void | getMaximumRowColSizes (QVector< int > *maxColWidths, QVector< int > *maxRowHeights) const |
Protected Member Functions inherited from QCPLayout | |
void | sizeConstraintsChanged () const |
void | adoptElement (QCPLayoutElement *el) |
void | releaseElement (QCPLayoutElement *el) |
QVector< int > | getSectionSizes (QVector< int > maxSizes, QVector< int > minSizes, QVector< double > stretchFactors, int totalSize) const |
Protected Member Functions inherited from QCPLayoutElement | |
virtual int | calculateAutoMargin (QCP::MarginSide side) |
virtual void | layoutChanged () |
Protected Member Functions inherited from QCPLayerable | |
virtual QRect | clipRect () const |
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 |
Friends | |
class | QCustomPlot |
class | QCPAbstractLegendItem |
Manages a legend inside a QCustomPlot.
A legend is a small box somewhere in the plot which lists plottables with their name and icon.
Normally, the legend is populated by calling QCPAbstractPlottable::addToLegend. The respective legend item can be removed with QCPAbstractPlottable::removeFromLegend. However, QCPLegend also offers an interface to add and manipulate legend items directly: item, itemWithPlottable, itemCount, addItem, removeItem, etc.
Since QCPLegend derives from QCPLayoutGrid, it can be placed in any position a QCPLayoutElement may be positioned. The legend items are themselves QCPLayoutElements which are placed in the grid layout of the legend. QCPLegend only adds an interface specialized for handling child elements of type QCPAbstractLegendItem, as mentioned above. In principle, any other layout elements may also be added to a legend via the normal QCPLayoutGrid interface. See the special page about The Layout System for examples on how to add other elements to the legend and move it outside the axis rect.
Use the methods setFillOrder and setWrap inherited from QCPLayoutGrid to control in which order (column first or row first) the legend is filled up when calling addItem, and at which column or row wrapping occurs.
By default, every QCustomPlot has one legend (QCustomPlot::legend) which is placed in the inset layout of the main axis rect (QCPAxisRect::insetLayout). To move the legend to another position inside the axis rect, use the methods of the QCPLayoutInset. To move the legend outside of the axis rect, place it anywhere else with the QCPLayout/QCPLayoutElement interface.
Definition at line 4763 of file qcustomplot.h.
Defines the selectable parts of a legend
Enumerator | |
---|---|
spNone |
|
spLegendBox |
|
spItems |
|
Definition at line 4788 of file qcustomplot.h.
|
explicit |
Constructs a new QCPLegend instance with default values.
Note that by default, QCustomPlot already contains a legend ready to be used as QCustomPlot::legend
Definition at line 18011 of file qcustomplot.cpp.
|
virtual |
Definition at line 18037 of file qcustomplot.cpp.
bool QCPLegend::addItem | ( | QCPAbstractLegendItem * | item | ) |
Adds item to the legend, if it's not present already. The element is arranged according to the current fill order (setFillOrder) and wrapping (setWrap).
Returns true on sucess, i.e. if the item wasn't in the list already and has been successfuly added.
The legend takes ownership of the item.
Definition at line 18366 of file qcustomplot.cpp.
|
protectedvirtual |
Reimplemented from QCPLayoutElement.
Definition at line 18460 of file qcustomplot.cpp.
|
inline |
Definition at line 4800 of file qcustomplot.h.
|
inline |
Definition at line 4801 of file qcustomplot.h.
void QCPLegend::clearItems | ( | ) |
Removes all items from the legend.
Definition at line 18419 of file qcustomplot.cpp.
|
protectedvirtual |
Reimplemented from QCPLayerable.
Definition at line 18528 of file qcustomplot.cpp.
|
protectedvirtual |
Reimplemented from QCPLayoutElement.
Definition at line 18490 of file qcustomplot.cpp.
|
inline |
Definition at line 4802 of file qcustomplot.h.
|
protected |
Definition at line 18470 of file qcustomplot.cpp.
|
protected |
Definition at line 18480 of file qcustomplot.cpp.
bool QCPLegend::hasItem | ( | QCPAbstractLegendItem * | item | ) | const |
Returns whether the legend contains item.
Definition at line 18335 of file qcustomplot.cpp.
bool QCPLegend::hasItemWithPlottable | ( | const QCPAbstractPlottable * | plottable | ) | const |
Returns whether the legend contains a QCPPlottableLegendItem which is associated with plottable (e.g. a QCPGraph*). If such an item isn't in the legend, returns false.
Definition at line 18351 of file qcustomplot.cpp.
|
inline |
Definition at line 4806 of file qcustomplot.h.
|
inline |
Definition at line 4804 of file qcustomplot.h.
|
inline |
Definition at line 4805 of file qcustomplot.h.
QCPAbstractLegendItem * QCPLegend::item | ( | int | index | ) | const |
Returns the item with index i.
Note that the linear index depends on the current fill order (setFillOrder).
Definition at line 18293 of file qcustomplot.cpp.
int QCPLegend::itemCount | ( | ) | const |
Returns the number of items currently in the legend.
Note that if empty cells are in the legend (e.g. by calling methods of the QCPLayoutGrid base class which allows creating empty cells), they are included in the returned count.
Definition at line 18325 of file qcustomplot.cpp.
QCPPlottableLegendItem * QCPLegend::itemWithPlottable | ( | const QCPAbstractPlottable * | plottable | ) | const |
Returns the QCPPlottableLegendItem which is associated with plottable (e.g. a QCPGraph*). If such an item isn't in the legend, returns 0.
Definition at line 18304 of file qcustomplot.cpp.
|
protectedvirtual |
Reimplemented from QCPLayoutElement.
Definition at line 18553 of file qcustomplot.cpp.
bool QCPLegend::removeItem | ( | int | index | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Removes the item with the specified index from the legend and deletes it.
After successful removal, the legend is reordered according to the current fill order (setFillOrder) and wrapping (setWrap), so no empty cell remains where the removed item was. If you don't want this, rather use the raw element interface of QCPLayoutGrid.
Returns true, if successful. Unlike QCPLayoutGrid::removeAt, this method only removes elements derived from QCPAbstractLegendItem.
Definition at line 18384 of file qcustomplot.cpp.
bool QCPLegend::removeItem | ( | QCPAbstractLegendItem * | item | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Removes item from the legend and deletes it.
After successful removal, the legend is reordered according to the current fill order (setFillOrder) and wrapping (setWrap), so no empty cell remains where the removed item was. If you don't want this, rather use the raw element interface of QCPLayoutGrid.
Returns true, if successful.
Definition at line 18408 of file qcustomplot.cpp.
|
signal |
|
inline |
Definition at line 4807 of file qcustomplot.h.
|
inline |
Definition at line 4809 of file qcustomplot.h.
|
inline |
Definition at line 4811 of file qcustomplot.h.
|
inline |
Definition at line 4812 of file qcustomplot.h.
|
inline |
Definition at line 4810 of file qcustomplot.h.
QList< QCPAbstractLegendItem * > QCPLegend::selectedItems | ( | ) | const |
Returns the legend items that are currently selected. If no items are selected, the list is empty.
Definition at line 18431 of file qcustomplot.cpp.
QCPLegend::SelectableParts QCPLegend::selectedParts | ( | ) | const |
Definition at line 18045 of file qcustomplot.cpp.
|
inline |
Definition at line 4813 of file qcustomplot.h.
|
protectedvirtual |
Reimplemented from QCPLayerable.
Definition at line 18514 of file qcustomplot.cpp.
|
protectedvirtual |
Reimplemented from QCPLayerable.
Definition at line 18541 of file qcustomplot.cpp.
|
signal |
This signal is emitted when the selection state of this legend has changed.
|
virtual |
Layout elements are sensitive to events inside their outer rect. If pos is within the outer rect, this method returns a value corresponding to 0.99 times the parent plot's selection tolerance. However, layout elements are not selectable by default. So if onlySelectable is true, -1.0 is returned.
See QCPLayerable::selectTest for a general explanation of this virtual method.
QCPLayoutElement subclasses may reimplement this method to provide more specific selection test behaviour.
Reimplemented from QCPLayoutElement.
Definition at line 18499 of file qcustomplot.cpp.
void QCPLegend::setBorderPen | ( | const QPen & | pen | ) |
Sets the pen, the border of the entire legend is drawn with.
Definition at line 18066 of file qcustomplot.cpp.
void QCPLegend::setBrush | ( | const QBrush & | brush | ) |
Sets the brush of the legend background.
Definition at line 18074 of file qcustomplot.cpp.
void QCPLegend::setFont | ( | const QFont & | font | ) |
Sets the default font of legend text. Legend items that draw text (e.g. the name of a graph) will use this font by default. However, a different font can be specified on a per-item-basis by accessing the specific legend item.
This function will also set font on all already existing legend items.
Definition at line 18088 of file qcustomplot.cpp.
void QCPLegend::setIconBorderPen | ( | const QPen & | pen | ) |
Sets the pen used to draw a border around each legend icon. Legend items that draw an icon (e.g. a visual representation of the graph) will use this pen by default.
If no border is wanted, set this to Qt::NoPen.
Definition at line 18150 of file qcustomplot.cpp.
void QCPLegend::setIconSize | ( | const QSize & | size | ) |
Sets the size of legend icons. Legend items that draw an icon (e.g. a visual representation of the graph) will use this size by default.
Definition at line 18121 of file qcustomplot.cpp.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 18128 of file qcustomplot.cpp.
void QCPLegend::setIconTextPadding | ( | int | padding | ) |
Sets the horizontal space in pixels between the legend icon and the text next to it. Legend items that draw an icon (e.g. a visual representation of the graph) and text (e.g. the name of the graph) will use this space by default.
Definition at line 18139 of file qcustomplot.cpp.
void QCPLegend::setSelectableParts | ( | const SelectableParts & | selectable | ) |
Sets whether the user can (de-)select the parts in selectable by clicking on the QCustomPlot surface. (When QCustomPlot::setInteractions contains QCP::iSelectLegend.)
However, even when selectable is set to a value not allowing the selection of a specific part, it is still possible to set the selection of this part manually, by calling setSelectedParts directly.
Definition at line 18165 of file qcustomplot.cpp.
void QCPLegend::setSelectedBorderPen | ( | const QPen & | pen | ) |
When the legend box is selected, this pen is used to draw the border instead of the normal pen set via setBorderPen.
Definition at line 18226 of file qcustomplot.cpp.
void QCPLegend::setSelectedBrush | ( | const QBrush & | brush | ) |
When the legend box is selected, this brush is used to draw the legend background instead of the normal brush set via setBrush.
Definition at line 18247 of file qcustomplot.cpp.
void QCPLegend::setSelectedFont | ( | const QFont & | font | ) |
Sets the default font that is used by legend items when they are selected.
This function will also set font on all already existing legend items.
Definition at line 18259 of file qcustomplot.cpp.
void QCPLegend::setSelectedIconBorderPen | ( | const QPen & | pen | ) |
Sets the pen legend items will use to draw their icon borders, when they are selected.
Definition at line 18236 of file qcustomplot.cpp.
void QCPLegend::setSelectedParts | ( | const SelectableParts & | selected | ) |
Sets the selected state of the respective legend parts described by SelectablePart. When a part is selected, it uses a different pen/font and brush. If some legend items are selected and selected doesn't contain spItems, those items become deselected.
The entire selection mechanism is handled automatically when QCustomPlot::setInteractions contains iSelectLegend. You only need to call this function when you wish to change the selection state manually.
This function can change the selection state of a part even when setSelectableParts was set to a value that actually excludes the part.
emits the selectionChanged signal when selected is different from the previous selection state.
Note that it doesn't make sense to set the selected state spItems here when it wasn't set before, because there's no way to specify which exact items to newly select. Do this by calling QCPAbstractLegendItem::setSelected directly on the legend item you wish to select.
Definition at line 18195 of file qcustomplot.cpp.
void QCPLegend::setSelectedTextColor | ( | const QColor & | color | ) |
Sets the default text color that is used by legend items when they are selected.
This function will also set color on all already existing legend items.
Definition at line 18276 of file qcustomplot.cpp.
void QCPLegend::setTextColor | ( | const QColor & | color | ) |
Sets the default color of legend text. Legend items that draw text (e.g. the name of a graph) will use this color by default. However, a different colors can be specified on a per-item-basis by accessing the specific legend item.
This function will also set color on all already existing legend items.
Definition at line 18107 of file qcustomplot.cpp.
|
inline |
Definition at line 4803 of file qcustomplot.h.
|
friend |
Definition at line 4882 of file qcustomplot.h.
|
friend |
Definition at line 4881 of file qcustomplot.h.
|
protected |
Definition at line 4853 of file qcustomplot.h.
|
protected |
Definition at line 4854 of file qcustomplot.h.
|
protected |
Definition at line 4855 of file qcustomplot.h.
|
protected |
Definition at line 4853 of file qcustomplot.h.
|
protected |
Definition at line 4857 of file qcustomplot.h.
|
protected |
Definition at line 4858 of file qcustomplot.h.
|
protected |
Definition at line 4859 of file qcustomplot.h.
|
protected |
Definition at line 4860 of file qcustomplot.h.
|
protected |
Definition at line 4861 of file qcustomplot.h.
|
protected |
Definition at line 4862 of file qcustomplot.h.
|
protected |
Definition at line 4860 of file qcustomplot.h.
|
protected |
Definition at line 4859 of file qcustomplot.h.
|
protected |
Definition at line 4863 of file qcustomplot.h.
|
protected |
Definition at line 4856 of file qcustomplot.h.