A margin group allows synchronization of margin sides if working with multiple layout elements. More...
#include <qcustomplot.h>
Public Member Functions | |
| void | clear () |
| QList< QCPLayoutElement * > | elements (QCP::MarginSide side) const |
| bool | isEmpty () const |
| QCPMarginGroup (QCustomPlot *parentPlot) | |
| virtual | ~QCPMarginGroup () |
Protected Member Functions | |
| void | addChild (QCP::MarginSide side, QCPLayoutElement *element) |
| virtual int | commonMargin (QCP::MarginSide side) const |
| void | removeChild (QCP::MarginSide side, QCPLayoutElement *element) |
Protected Attributes | |
| QHash< QCP::MarginSide, QList< QCPLayoutElement * > > | mChildren |
| QCustomPlot * | mParentPlot |
Friends | |
| class | QCPLayoutElement |
Detailed Description
A margin group allows synchronization of margin sides if working with multiple layout elements.
QCPMarginGroup allows you to tie a margin side of two or more layout elements together, such that they will all have the same size, based on the largest required margin in the group.
In certain situations it is desirable that margins at specific sides are synchronized across layout elements. For example, if one QCPAxisRect is below another one in a grid layout, it will provide a cleaner look to the user if the left and right margins of the two axis rects are of the same size. The left axis of the top axis rect will then be at the same horizontal position as the left axis of the lower axis rect, making them appear aligned. The same applies for the right axes. This is what QCPMarginGroup makes possible.
To add/remove a specific side of a layout element to/from a margin group, use the QCPLayoutElement::setMarginGroup method. To completely break apart the margin group, either call clear, or just delete the margin group.
Example
First create a margin group:
Then set this group on the layout element sides:
Here, we've used the first two axis rects of the plot and synchronized their left margins with each other and their right margins with each other.
Definition at line 1153 of file qcustomplot.h.
Constructor & Destructor Documentation
◆ QCPMarginGroup()
|
explicit |
Creates a new QCPMarginGroup instance in parentPlot.
Definition at line 3014 of file qcustomplot.cpp.
◆ ~QCPMarginGroup()
|
virtual |
Definition at line 3024 of file qcustomplot.cpp.
Member Function Documentation
◆ addChild()
|
protected |
Definition at line 3094 of file qcustomplot.cpp.
◆ clear()
| void QCPMarginGroup::clear | ( | ) |
Clears this margin group. The synchronization of the margin sides that use this margin group is lifted and they will use their individual margin sizes again.
Definition at line 3049 of file qcustomplot.cpp.
◆ commonMargin()
|
protectedvirtual |
Definition at line 3072 of file qcustomplot.cpp.
◆ elements()
|
inline |
Returns a list of all layout elements that have their margin side associated with this margin group.
Definition at line 1161 of file qcustomplot.h.
◆ isEmpty()
| bool QCPMarginGroup::isEmpty | ( | ) | const |
Returns whether this margin group is empty. If this function returns true, no layout elements use this margin group to synchronize margin sides.
Definition at line 3033 of file qcustomplot.cpp.
◆ removeChild()
|
protected |
Definition at line 3108 of file qcustomplot.cpp.
Friends And Related Function Documentation
◆ QCPLayoutElement
|
friend |
Definition at line 1180 of file qcustomplot.h.
Member Data Documentation
◆ mChildren
|
protected |
Definition at line 1168 of file qcustomplot.h.
◆ mParentPlot
|
protected |
Definition at line 1167 of file qcustomplot.h.
The documentation for this class was generated from the following files: