Vespucci  1.0.0
QCPMarginGroup Class Reference

A margin group allows synchronization of margin sides if working with multiple layout elements. More...

#include <qcustomplot.h>

Inheritance diagram for QCPMarginGroup:

Public Member Functions

 QCPMarginGroup (QCustomPlot *parentPlot)
 ~QCPMarginGroup ()
QList< QCPLayoutElement * > elements (QCP::MarginSide side) const
bool isEmpty () const
void clear ()

Protected Member Functions

int commonMargin (QCP::MarginSide side) const
void addChild (QCP::MarginSide side, QCPLayoutElement *element)
void removeChild (QCP::MarginSide side, QCPLayoutElement *element)

Protected Attributes

QHash< QCP::MarginSide, QList< QCPLayoutElement * > > mChildren


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.

Demonstration of QCPMarginGroup

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.


First create a margin group:

QCPMarginGroup *group = new QCPMarginGroup(customPlot);

Then set this group on the layout element sides:

customPlot->axisRect(0)->setMarginGroup(QCP::msLeft|QCP::msRight, group);
customPlot->axisRect(1)->setMarginGroup(QCP::msLeft|QCP::msRight, group);

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 605 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPMarginGroup::QCPMarginGroup ( QCustomPlot parentPlot)

Creates a new QCPMarginGroup instance in parentPlot.

Definition at line 1564 of file qcustomplot.cpp.

QCPMarginGroup::~QCPMarginGroup ( )

Definition at line 1574 of file qcustomplot.cpp.

Member Function Documentation

void QCPMarginGroup::addChild ( QCP::MarginSide  side,
QCPLayoutElement element 

Definition at line 1644 of file qcustomplot.cpp.

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 1599 of file qcustomplot.cpp.

int QCPMarginGroup::commonMargin ( QCP::MarginSide  side) const

Definition at line 1622 of file qcustomplot.cpp.

QList< QCPLayoutElement * > QCPMarginGroup::elements ( QCP::MarginSide  side) const

Returns a list of all layout elements that have their margin side associated with this margin group.

Definition at line 613 of file qcustomplot.h.

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 1583 of file qcustomplot.cpp.

void QCPMarginGroup::removeChild ( QCP::MarginSide  side,
QCPLayoutElement element 

Definition at line 1658 of file qcustomplot.cpp.

Friends And Related Function Documentation

friend class QCPLayoutElement

Definition at line 630 of file qcustomplot.h.

Member Data Documentation

QHash<QCP::MarginSide, QList<QCPLayoutElement*> > QCPMarginGroup::mChildren

Definition at line 620 of file qcustomplot.h.

QCustomPlot* QCPMarginGroup::mParentPlot

Definition at line 619 of file qcustomplot.h.

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