The abstract base class for all objects that form the layout system. More...

#include <qcustomplot.h>

Inheritance diagram for QCPLayoutElement:

[legend]

Public Types
enum	SizeConstraintRect { scrInnerRect, scrOuterRect }

enum	UpdatePhase { upPreparation, upMargins, upLayout }

Public Member Functions
QCP::MarginSides	autoMargins () const

virtual QList< QCPLayoutElement * >	elements (bool recursive) const

QCPLayout *	layout () const

QCPMarginGroup *	marginGroup (QCP::MarginSide side) const

QHash< QCP::MarginSide, QCPMarginGroup * >	marginGroups () const

QMargins	margins () const

virtual QSize	maximumOuterSizeHint () const

QSize	maximumSize () const

QMargins	minimumMargins () const

virtual QSize	minimumOuterSizeHint () const

QSize	minimumSize () const

QRect	outerRect () const

	QCPLayoutElement (QCustomPlot *parentPlot=0)

QRect	rect () const

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE

void	setAutoMargins (QCP::MarginSides sides)

void	setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group)

void	setMargins (const QMargins &margins)

void	setMaximumSize (const QSize &size)

void	setMaximumSize (int width, int height)

void	setMinimumMargins (const QMargins &margins)

void	setMinimumSize (const QSize &size)

void	setMinimumSize (int width, int height)

void	setOuterRect (const QRect &rect)

void	setSizeConstraintRect (SizeConstraintRect constraintRect)

SizeConstraintRect	sizeConstraintRect () const

virtual void	update (UpdatePhase phase)

virtual	~QCPLayoutElement ()

Public Member Functions inherited from QCPLayerable
bool	antialiased () const

QCPLayer *	layer () const

QCPLayerable *	parentLayerable () const

QCustomPlot *	parentPlot () const

	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

bool	realVisibility () const

void	setAntialiased (bool enabled)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setVisible (bool on)

bool	visible () const

virtual	~QCPLayerable ()

Protected Member Functions
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE

virtual int	calculateAutoMargin (QCP::MarginSide side)

virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE

virtual void	layoutChanged ()

virtual void	parentPlotInitialized (QCustomPlot *parentPlot) Q_DECL_OVERRIDE

Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

virtual QRect	clipRect () const

virtual void	deselectEvent (bool *selectionStateChanged)

void	initializeParentPlot (QCustomPlot *parentPlot)

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)

bool	moveToLayer (QCPLayer *layer, bool prepend)

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged)

virtual QCP::Interaction	selectionCategory () const

void	setParentLayerable (QCPLayerable *parentLayerable)

virtual void	wheelEvent (QWheelEvent *event)

Protected Attributes
QCP::MarginSides	mAutoMargins

QHash< QCP::MarginSide, QCPMarginGroup * >	mMarginGroups

QMargins	mMargins

QSize	mMaximumSize

QMargins	mMinimumMargins

QSize	mMinimumSize

QRect	mOuterRect

QCPLayout *	mParentLayout

QRect	mRect

SizeConstraintRect	mSizeConstraintRect

Protected Attributes inherited from QCPLayerable
bool	mAntialiased

QCPLayer *	mLayer

QPointer< QCPLayerable >	mParentLayerable

QCustomPlot *	mParentPlot

bool	mVisible

Friends
class	QCPLayout

class	QCPMarginGroup

class	QCustomPlot

Additional Inherited Members
Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Detailed Description

The abstract base class for all objects that form the layout system.

This is an abstract base class. As such, it can't be instantiated directly, rather use one of its subclasses.

A Layout element is a rectangular object which can be placed in layouts. It has an outer rect (QCPLayoutElement::outerRect) and an inner rect (QCPLayoutElement::rect). The difference between outer and inner rect is called its margin. The margin can either be set to automatic or manual (setAutoMargins) on a per-side basis. If a side is set to manual, that margin can be set explicitly with setMargins and will stay fixed at that value. If it's set to automatic, the layout element subclass will control the value itself (via calculateAutoMargin).

Layout elements can be placed in layouts (base class QCPLayout) like QCPLayoutGrid. The top level layout is reachable via QCustomPlot::plotLayout, and is a QCPLayoutGrid. Since QCPLayout itself derives from QCPLayoutElement, layouts can be nested.

Thus in QCustomPlot one can divide layout elements into two categories: The ones that are invisible by themselves, because they don't draw anything. Their only purpose is to manage the position and size of other layout elements. This category of layout elements usually use QCPLayout as base class. Then there is the category of layout elements which actually draw something. For example, QCPAxisRect, QCPLegend and QCPTextElement are of this category. This does not necessarily mean that the latter category can't have child layout elements. QCPLegend for instance, actually derives from QCPLayoutGrid and the individual legend items are child layout elements in the grid layout.

Definition at line 1184 of file qcustomplot.h.

Member Enumeration Documentation

◆ SizeConstraintRect

enum QCPLayoutElement::SizeConstraintRect

Defines to which rect of a layout element the size constraints that can be set via setMinimumSize and setMaximumSize apply. The outer rect (outerRect) includes the margins (e.g. in the case of a QCPAxisRect the axis labels), whereas the inner rect (rect) does not.

See also: setSizeConstraintRect

Enumerator
scrInnerRect	Minimum/Maximum size constraints apply to inner rect.
scrOuterRect	Minimum/Maximum size constraints apply to outer rect, thus include layout element margins.

Definition at line 1216 of file qcustomplot.h.

◆ UpdatePhase

enum QCPLayoutElement::UpdatePhase

Defines the phases of the update process, that happens just before a replot. At each phase, update is called with the according UpdatePhase value.

Enumerator
upPreparation	Phase used for any type of preparation that needs to be done before margin calculation and layout.
upMargins	Phase in which the margins are calculated and set.
upLayout	Final phase in which the layout system places the rects of the elements.

Definition at line 1202 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPLayoutElement()

QCPLayoutElement::QCPLayoutElement ( QCustomPlot * parentPlot = 0 )

explicit

Creates an instance of QCPLayoutElement and sets default values.

Definition at line 3181 of file qcustomplot.cpp.

◆ ~QCPLayoutElement()

QCPLayoutElement::~QCPLayoutElement ( )

virtual

Definition at line 3195 of file qcustomplot.cpp.

Member Function Documentation

◆ applyDefaultAntialiasingHint()

virtual void QCPLayoutElement::applyDefaultAntialiasingHint ( QCPPainter * painter ) const

inlineprotectedvirtual

Implements QCPLayerable.

Reimplemented in QCPColorScale, QCPTextElement, QCPLegend, QCPAbstractLegendItem, and QCPAxisRect.

Definition at line 1273 of file qcustomplot.h.

◆ autoMargins()

QCP::MarginSides QCPLayoutElement::autoMargins ( ) const

inline

Definition at line 1230 of file qcustomplot.h.

◆ calculateAutoMargin()

int QCPLayoutElement::calculateAutoMargin ( QCP::MarginSide side )

protectedvirtual

Reimplemented in QCPAxisRect.

Definition at line 3543 of file qcustomplot.cpp.

◆ draw()

virtual void QCPLayoutElement::draw ( QCPPainter * painter )

inlineprotectedvirtual

Implements QCPLayerable.

Reimplemented in QCPColorScaleAxisRectPrivate, QCPTextElement, QCPLegend, QCPPlottableLegendItem, QCPAbstractLegendItem, and QCPAxisRect.

Definition at line 1274 of file qcustomplot.h.

◆ elements()

QList< QCPLayoutElement * > QCPLayoutElement::elements ( bool recursive ) const

virtual

Returns a list of all child elements in this layout element. If recursive is true, all sub-child elements are included in the list, too.

Warning: There may be entries with value 0 in the returned list. (For example, QCPLayoutGrid may have empty cells which yield 0 at the respective index.)

Reimplemented in QCPAxisRect, QCPLayoutGrid, and QCPLayout.

Definition at line 3483 of file qcustomplot.cpp.

◆ layout()

QCPLayout * QCPLayoutElement::layout ( ) const

inline

Returns the parent layout of this layout element.

Definition at line 1225 of file qcustomplot.h.

◆ layoutChanged()

void QCPLayoutElement::layoutChanged ( )

protectedvirtual

Reimplemented in QCPAxisRect.

Definition at line 3559 of file qcustomplot.cpp.

◆ marginGroup()

QCPMarginGroup* QCPLayoutElement::marginGroup ( QCP::MarginSide side ) const

inline

Definition at line 1234 of file qcustomplot.h.

◆ marginGroups()

QHash<QCP::MarginSide, QCPMarginGroup*> QCPLayoutElement::marginGroups ( ) const

inline

Definition at line 1235 of file qcustomplot.h.

◆ margins()

QMargins QCPLayoutElement::margins ( ) const

inline

Definition at line 1228 of file qcustomplot.h.

◆ maximumOuterSizeHint()

QSize QCPLayoutElement::maximumOuterSizeHint ( ) const

virtual

Returns the suggested maximum size this layout element (the outerRect) may be expanded to, if no manual maximum size is set.

if a maximum size (setMaximumSize) was not set manually, parent layouts use the returned size (usually indirectly through QCPLayout::getFinalMaximumOuterSize) to determine the maximum allowed size of this layout element.

A manual maximum size is considered set if it is smaller than Qt's QWIDGETSIZE_MAX.

The default implementation simply returns QWIDGETSIZE_MAX for both width and height, implying no suggested maximum size. Reimplementations may use their detailed knowledge about the layout element's content to provide size hints.

Reimplemented in QCPTextElement, and QCPLayoutGrid.

Definition at line 3471 of file qcustomplot.cpp.

◆ maximumSize()

QSize QCPLayoutElement::maximumSize ( ) const

inline

Definition at line 1232 of file qcustomplot.h.

◆ minimumMargins()

QMargins QCPLayoutElement::minimumMargins ( ) const

inline

Definition at line 1229 of file qcustomplot.h.

◆ minimumOuterSizeHint()

QSize QCPLayoutElement::minimumOuterSizeHint ( ) const

virtual

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 in QCPTextElement, QCPPlottableLegendItem, and QCPLayoutGrid.

Definition at line 3452 of file qcustomplot.cpp.

◆ minimumSize()

QSize QCPLayoutElement::minimumSize ( ) const

inline

Definition at line 1231 of file qcustomplot.h.

◆ outerRect()

QRect QCPLayoutElement::outerRect ( ) const

inline

Returns the outer rect of this layout element. The outer rect is the inner rect expanded by the margins (setMargins, setAutoMargins). The outer rect is used (and set via setOuterRect) by the parent QCPLayout to control the size of this layout element.

See also: rect

Definition at line 1227 of file qcustomplot.h.

◆ parentPlotInitialized()

void QCPLayoutElement::parentPlotInitialized ( QCustomPlot * parentPlot )

protectedvirtual

Reimplemented from QCPLayerable.

Reimplemented in QCPLegend.

Definition at line 3525 of file qcustomplot.cpp.

◆ rect()

QRect QCPLayoutElement::rect ( ) const

inline

Returns the inner rect of this layout element. The inner rect is the outer rect (outerRect, setOuterRect) shrinked by the margins (setMargins, setAutoMargins).

In some cases, the area between outer and inner rect is left blank. In other cases the margin area is used to display peripheral graphics while the main content is in the inner rect. This is where automatic margin calculation becomes interesting because it allows the layout element to adapt the margins to the peripheral graphics it wants to draw. For example, QCPAxisRect draws the axis labels and tick labels in the margin area, thus needs to adjust the margins (if setAutoMargins is enabled) according to the space required by the labels of the axes.

See also: outerRect

Definition at line 1226 of file qcustomplot.h.

◆ selectTest()

double QCPLayoutElement::selectTest	(	const QPointF &	pos,
		bool	onlySelectable,
		QVariant *	details = `0`
	)		const

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 QCPLayerable.

Reimplemented in QCPTextElement, QCPLegend, QCPAbstractLegendItem, and QCPLayoutInset.

Definition at line 3500 of file qcustomplot.cpp.

◆ setAutoMargins()

void QCPLayoutElement::setAutoMargins ( QCP::MarginSides sides )

Sets on which sides the margin shall be calculated automatically. If a side is calculated automatically, a minimum margin value may be provided with setMinimumMargins. If a side is set to be controlled manually, the value may be specified with setMargins.

Margin sides that are under automatic control may participate in a QCPMarginGroup (see setMarginGroup), to synchronize (align) it with other layout elements in the plot.

See also: setMinimumMargins, setMargins, QCP::MarginSide

Definition at line 3270 of file qcustomplot.cpp.

◆ setMarginGroup()

void QCPLayoutElement::setMarginGroup	(	QCP::MarginSides	sides,
		QCPMarginGroup *	group
	)

Sets the margin group of the specified margin sides.

Margin groups allow synchronizing specified margins across layout elements, see the documentation of QCPMarginGroup.

To unset the margin group of sides, set group to 0.

Note that margin groups only work for margin sides that are set to automatic (setAutoMargins).

See also: QCP::MarginSide

Definition at line 3370 of file qcustomplot.cpp.

◆ setMargins()

void QCPLayoutElement::setMargins ( const QMargins & margins )

Sets the margins of this layout element. If setAutoMargins is disabled for some or all sides, this function is used to manually set the margin on those sides. Sides that are still set to be handled automatically are ignored and may have any value in margins.

The margin is the distance between the outer rect (controlled by the parent layout via setOuterRect) and the inner rect (which usually contains the main content of this layout element).

See also: setAutoMargins

Definition at line 3234 of file qcustomplot.cpp.

◆ setMaximumSize() [1/2]

void QCPLayoutElement::setMaximumSize ( const QSize & size )

Sets the maximum size of this layout element. A parent layout tries to respect the size here by changing row/column sizes in the layout accordingly.

Whether this constraint applies to the inner or the outer rect can be specified with setSizeConstraintRect (see rect and outerRect).

Definition at line 3316 of file qcustomplot.cpp.

◆ setMaximumSize() [2/2]

void QCPLayoutElement::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.

Whether this constraint applies to the inner or the outer rect can be specified with setSizeConstraintRect (see rect and outerRect).

Definition at line 3333 of file qcustomplot.cpp.

◆ setMinimumMargins()

void QCPLayoutElement::setMinimumMargins ( const QMargins & margins )

If setAutoMargins is enabled on some or all margins, this function is used to provide minimum values for those margins.

The minimum values are not enforced on margin sides that were set to be under manual control via setAutoMargins.

See also: setAutoMargins

Definition at line 3252 of file qcustomplot.cpp.

◆ setMinimumSize() [1/2]

void QCPLayoutElement::setMinimumSize ( const QSize & size )

Sets the minimum size of this layout element. A parent layout tries to respect the size here by changing row/column sizes in the layout accordingly.

If the parent layout size is not sufficient to satisfy all minimum size constraints of its child layout elements, the layout may set a size that is actually smaller than size. QCustomPlot propagates the layout's size constraints to the outside by setting its own minimum QWidget size accordingly, so violations of size should be exceptions.

Whether this constraint applies to the inner or the outer rect can be specified with setSizeConstraintRect (see rect and outerRect).

Definition at line 3287 of file qcustomplot.cpp.

◆ setMinimumSize() [2/2]

void QCPLayoutElement::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.

Whether this constraint applies to the inner or the outer rect can be specified with setSizeConstraintRect (see rect and outerRect).

Definition at line 3304 of file qcustomplot.cpp.

◆ setOuterRect()

void QCPLayoutElement::setOuterRect ( const QRect & rect )

Sets the outer rect of this layout element. If the layout element is inside a layout, the layout sets the position and size of this layout element using this function.

Calling this function externally has no effect, since the layout will overwrite any changes to the outer rect upon the next replot.

The layout element will adapt its inner rect by applying the margins inward to the outer rect.

See also: rect

Definition at line 3214 of file qcustomplot.cpp.

◆ setSizeConstraintRect()

void QCPLayoutElement::setSizeConstraintRect ( SizeConstraintRect constraintRect )

Sets to which rect of a layout element the size constraints apply. Size constraints can be set via setMinimumSize and setMaximumSize.

The outer rect (outerRect) includes the margins (e.g. in the case of a QCPAxisRect the axis labels), whereas the inner rect (rect) does not.

See also: setMinimumSize, setMaximumSize

Definition at line 3347 of file qcustomplot.cpp.

◆ sizeConstraintRect()

SizeConstraintRect QCPLayoutElement::sizeConstraintRect ( ) const

inline

Definition at line 1233 of file qcustomplot.h.

◆ update()

void QCPLayoutElement::update ( UpdatePhase phase )

virtual

Updates the layout element and sub-elements. This function is automatically called before every replot by the parent layout element. It is called multiple times, once for every UpdatePhase. The phases are run through in the order of the enum values. For details about what happens at the different phases, see the documentation of UpdatePhase.

Layout elements that have child elements should call the update method of their child elements, and pass the current phase unchanged.

The default implementation executes the automatic margin mechanism in the upMargins phase. Subclasses should make sure to call the base class implementation.

Reimplemented in QCPColorScale, QCPAxisRect, and QCPLayout.

Definition at line 3411 of file qcustomplot.cpp.

Friends And Related Function Documentation

◆ QCPLayout

friend class QCPLayout

friend

Definition at line 1281 of file qcustomplot.h.

◆ QCPMarginGroup

friend class QCPMarginGroup

friend

Definition at line 1282 of file qcustomplot.h.

◆ QCustomPlot

friend class QCustomPlot

friend

Definition at line 1280 of file qcustomplot.h.

Member Data Documentation

◆ mAutoMargins

QCP::MarginSides QCPLayoutElement::mAutoMargins

protected

Definition at line 1265 of file qcustomplot.h.

◆ mMarginGroups

QHash<QCP::MarginSide, QCPMarginGroup*> QCPLayoutElement::mMarginGroups

protected

Definition at line 1266 of file qcustomplot.h.

◆ mMargins

QMargins QCPLayoutElement::mMargins

protected

Definition at line 1264 of file qcustomplot.h.

◆ mMaximumSize

QSize QCPLayoutElement::mMaximumSize

protected

Definition at line 1261 of file qcustomplot.h.

◆ mMinimumMargins

QMargins QCPLayoutElement::mMinimumMargins

protected

Definition at line 1264 of file qcustomplot.h.

◆ mMinimumSize

QSize QCPLayoutElement::mMinimumSize

protected

Definition at line 1261 of file qcustomplot.h.

◆ mOuterRect

QRect QCPLayoutElement::mOuterRect

protected

Definition at line 1263 of file qcustomplot.h.

◆ mParentLayout

QCPLayout* QCPLayoutElement::mParentLayout

protected

Definition at line 1260 of file qcustomplot.h.

◆ mRect

QRect QCPLayoutElement::mRect

protected

Definition at line 1263 of file qcustomplot.h.

◆ mSizeConstraintRect

SizeConstraintRect QCPLayoutElement::mSizeConstraintRect

protected

Definition at line 1262 of file qcustomplot.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SizeConstraintRect

◆ UpdatePhase

Constructor & Destructor Documentation

◆ QCPLayoutElement()

◆ ~QCPLayoutElement()

Member Function Documentation

◆ applyDefaultAntialiasingHint()

◆ autoMargins()

◆ calculateAutoMargin()

◆ draw()

◆ elements()

◆ layout()

◆ layoutChanged()

◆ marginGroup()

◆ marginGroups()

◆ margins()

◆ maximumOuterSizeHint()

◆ maximumSize()

◆ minimumMargins()

◆ minimumOuterSizeHint()

◆ minimumSize()

◆ outerRect()

◆ parentPlotInitialized()

◆ rect()

◆ selectTest()

◆ setAutoMargins()

◆ setMarginGroup()

◆ setMargins()

◆ setMaximumSize() [1/2]

◆ setMaximumSize() [2/2]

◆ setMinimumMargins()

◆ setMinimumSize() [1/2]

◆ setMinimumSize() [2/2]

◆ setOuterRect()

◆ setSizeConstraintRect()

◆ sizeConstraintRect()

◆ update()

Friends And Related Function Documentation

◆ QCPLayout

◆ QCPMarginGroup

◆ QCustomPlot

Member Data Documentation

◆ mAutoMargins

◆ mMarginGroups

◆ mMargins

◆ mMaximumSize

◆ mMinimumMargins

◆ mMinimumSize

◆ mOuterRect

◆ mParentLayout

◆ mRect

◆ mSizeConstraintRect