QCPMarginGroup Class Reference

Inheritance diagram for QCPMarginGroup:

Public Member Functions
	QCPMarginGroup (QCustomPlot *parentPlot)
void	clear ()
QList< QCPLayoutElement * >	elements (QCP::MarginSide side) const
bool	isEmpty () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

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 Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
QHash< QCP::MarginSide, QList< QCPLayoutElement * > >	mChildren
QCustomPlot *	mParentPlot

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

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.

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

Constructor & Destructor Documentation

QCPMarginGroup()

QCPMarginGroup::QCPMarginGroup ( QCustomPlot * parentPlot )

explicit

Creates a new QCPMarginGroup instance in parentPlot.

Definition at line 3041 of file qcustomplot.cpp.

~QCPMarginGroup()

QCPMarginGroup::~QCPMarginGroup ( )

virtual

Definition at line 3051 of file qcustomplot.cpp.

Member Function Documentation

addChild()

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

protected

Adds element to the internal list of child elements, for the margin side.

This function does not modify the margin group property of element.

Definition at line 3120 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 3076 of file qcustomplot.cpp.

commonMargin()

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

protectedvirtual

Returns the synchronized common margin for side. This is the margin value that will be used by the layout element on the respective side, if it is part of this margin group.

The common margin is calculated by requesting the automatic margin (QCPLayoutElement::calculateAutoMargin) of each element associated with side in this margin group, and choosing the largest returned value. (QCPLayoutElement::minimumMargins is taken into account, too.)

Definition at line 3099 of file qcustomplot.cpp.

elements()

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

inline

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

Definition at line 1215 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 3060 of file qcustomplot.cpp.

removeChild()

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

protected

Removes element from the internal list of child elements, for the margin side.

This function does not modify the margin group property of element.

Definition at line 3134 of file qcustomplot.cpp.

Member Data Documentation

mChildren

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

protected

Definition at line 1222 of file qcustomplot.h.

mParentPlot

QCustomPlot* QCPMarginGroup::mParentPlot

protected

Definition at line 1221 of file qcustomplot.h.

---

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

• qcustomplot.h
• qcustomplot.cpp