Layout engine for QwtPlot. More...

#include <qwt_plot_layout.h>

Public Types
enum	Option { AlignScales = 0x01, IgnoreScrollbars = 0x02, IgnoreFrames = 0x04, IgnoreLegend = 0x08, IgnoreTitle = 0x10, IgnoreFooter = 0x20 }

typedef QFlags< Option >	Options
	Layout options.

Public Member Functions
	QwtPlotLayout ()
	Constructor.

virtual	~QwtPlotLayout ()
	Destructor.

void	setCanvasMargin (int margin, int axis=-1)

int	canvasMargin (int axisId) const

void	setAlignCanvasToScales (bool)
	Set the align-canvas-to-axis-scales flag for all axes. More...

void	setAlignCanvasToScale (int axisId, bool)

bool	alignCanvasToScale (int axisId) const

void	setSpacing (int)

int	spacing () const

void	setLegendPosition (QwtPlot::LegendPosition pos, double ratio)
	Specify the position of the legend. More...

void	setLegendPosition (QwtPlot::LegendPosition pos)
	Specify the position of the legend. More...

QwtPlot::LegendPosition	legendPosition () const

void	setLegendRatio (double ratio)

double	legendRatio () const

virtual QSize	minimumSizeHint (const QwtPlot *) const

virtual void	activate (const QwtPlot *, const QRectF &plotRect, Options options=Options())
	Recalculate the geometry of all components. More...

virtual void	invalidate ()

QRectF	titleRect () const

QRectF	footerRect () const

QRectF	legendRect () const

QRectF	scaleRect (int axis) const

QRectF	canvasRect () const

Protected Member Functions
void	setTitleRect (const QRectF &)
	Set the geometry for the title. More...

void	setFooterRect (const QRectF &)
	Set the geometry for the footer. More...

void	setLegendRect (const QRectF &)
	Set the geometry for the legend. More...

void	setScaleRect (int axis, const QRectF &)
	Set the geometry for an axis. More...

void	setCanvasRect (const QRectF &)
	Set the geometry for the canvas. More...

QRectF	layoutLegend (Options options, const QRectF &) const

QRectF	alignLegend (const QRectF &canvasRect, const QRectF &legendRect) const

void	expandLineBreaks (Options options, const QRectF &rect, int &dimTitle, int &dimFooter, int dimAxes[QwtPlot::axisCnt]) const

void	alignScales (Options options, QRectF &canvasRect, QRectF scaleRect[QwtPlot::axisCnt]) const

Detailed Description

Layout engine for QwtPlot.

It is used by the QwtPlot widget to organize its internal widgets or by QwtPlot::print() to render its content to a QPaintDevice like a QPrinter, QPixmap/QImage or QSvgRenderer.

See also: QwtPlot::setPlotLayout()

Member Enumeration Documentation

◆ Option

enum QwtPlotLayout::Option

Options to configure the plot layout engine

See also: activate(), QwtPlotRenderer

Enumerator
AlignScales	Unused.
IgnoreScrollbars	Ignore the dimension of the scrollbars. There are no scrollbars, when the plot is not rendered to widgets.
IgnoreFrames	Ignore all frames.
IgnoreLegend	Ignore the legend.
IgnoreTitle	Ignore the title.
IgnoreFooter	Ignore the footer.

Member Function Documentation

◆ activate()

void QwtPlotLayout::activate	(	const QwtPlot *	plot,
		const QRectF &	plotRect,
		Options	options = `Options()`
	)

virtual

Recalculate the geometry of all components.

Parameters

plot	Plot to be layout
plotRect	Rectangle where to place the components
options	Layout options

See also: invalidate(), titleRect(), footerRect() legendRect(), scaleRect(), canvasRect()

◆ alignCanvasToScale()

bool QwtPlotLayout::alignCanvasToScale ( int axisId ) const

Return the align-canvas-to-axis-scales setting. The canvas may:

extend beyond the axis scale ends to maximize its size
align with the axis scale ends to control its size.

Parameters

axisId Axis index

Returns: align-canvas-to-axis-scales setting

See also: setAlignCanvasToScale(), setAlignCanvasToScale(), setCanvasMargin()

◆ alignLegend()

QRectF QwtPlotLayout::alignLegend	(	const QRectF &	canvasRect,
		const QRectF &	legendRect
	)		const

protected

Align the legend to the canvas

Parameters

canvasRect	Geometry of the canvas
legendRect	Maximum geometry for the legend

Returns: Geometry for the aligned legend

◆ alignScales()

void QwtPlotLayout::alignScales	(	Options	options,
		QRectF &	canvasRect,
		QRectF	scaleRect[QwtPlot::axisCnt]
	)		const

protected

Align the ticks of the axis to the canvas borders using the empty corners.

Parameters

options	Layout options
canvasRect	Geometry of the canvas ( IN/OUT )
scaleRect	Geometries of the scales ( IN/OUT )

See also: Options

◆ canvasMargin()

int QwtPlotLayout::canvasMargin ( int axisId ) const

Parameters

axisId Axis index

Returns: Margin around the scale tick borders

See also: setCanvasMargin()

◆ canvasRect()

QRectF QwtPlotLayout::canvasRect ( ) const

Returns: Geometry for the canvas

See also: activate(), invalidate()

◆ expandLineBreaks()

void QwtPlotLayout::expandLineBreaks	(	Options	options,
		const QRectF &	rect,
		int &	dimTitle,
		int &	dimFooter,
		int	dimAxes[QwtPlot::axisCnt]
	)		const

protected

Expand all line breaks in text labels, and calculate the height of their widgets in orientation of the text.

Parameters

options	Options how to layout the legend
rect	Bounding rectangle for title, footer, axes and canvas.
dimTitle	Expanded height of the title widget
dimFooter	Expanded height of the footer widget
dimAxes	Expanded heights of the axis in axis orientation.

See also: Options

◆ footerRect()

QRectF QwtPlotLayout::footerRect ( ) const

Returns: Geometry for the footer

See also: activate(), invalidate()

◆ invalidate()

void QwtPlotLayout::invalidate ( )

virtual

Invalidate the geometry of all components.

See also: activate()

◆ layoutLegend()

QRectF QwtPlotLayout::layoutLegend	(	Options	options,
		const QRectF &	rect
	)		const

protected

Find the geometry for the legend

Parameters

options	Options how to layout the legend
rect	Rectangle where to place the legend

Returns: Geometry for the legend

See also: Options

◆ legendPosition()

QwtPlot::LegendPosition QwtPlotLayout::legendPosition ( ) const

Returns: Position of the legend

See also: setLegendPosition(), QwtPlot::setLegendPosition(), QwtPlot::legendPosition()

◆ legendRatio()

double QwtPlotLayout::legendRatio ( ) const

Returns: The relative size of the legend in the plot.

See also: setLegendPosition()

◆ legendRect()

QRectF QwtPlotLayout::legendRect ( ) const

Returns: Geometry for the legend

See also: activate(), invalidate()

◆ minimumSizeHint()

QSize QwtPlotLayout::minimumSizeHint ( const QwtPlot * plot ) const

virtual

Returns: Minimum size hint

Parameters

plot	Plot widget

See also: QwtPlot::minimumSizeHint()

◆ scaleRect()

QRectF QwtPlotLayout::scaleRect ( int axis ) const

Parameters

axis	Axis index

Returns: Geometry for the scale

See also: activate(), invalidate()

◆ setAlignCanvasToScale()

void QwtPlotLayout::setAlignCanvasToScale	(	int	axisId,
		bool	on
	)

Change the align-canvas-to-axis-scales setting. The canvas may:

extend beyond the axis scale ends to maximize its size,
align with the axis scale ends to control its size.

The axisId parameter is somehow confusing as it identifies a border of the plot and not the axes, that are aligned. F.e when QwtPlot::yLeft is set, the left end of the the x-axes ( QwtPlot::xTop, QwtPlot::xBottom ) is aligned.

Parameters

axisId	Axis index
on	New align-canvas-to-axis-scales setting

See also: setCanvasMargin(), alignCanvasToScale(), setAlignCanvasToScales()

Warning: In case of on == true canvasMargin() will have no effect

◆ setAlignCanvasToScales()

void QwtPlotLayout::setAlignCanvasToScales ( bool on )

Set the align-canvas-to-axis-scales flag for all axes.

Parameters

on	True/False

See also: setAlignCanvasToScale(), alignCanvasToScale()

◆ setCanvasMargin()

void QwtPlotLayout::setCanvasMargin	(	int	margin,
		int	axis = `-1`
	)

Change a margin of the canvas. The margin is the space above/below the scale ticks. A negative margin will be set to -1, excluding the borders of the scales.

Parameters

margin	New margin
axis	One of QwtPlot::Axis. Specifies where the position of the margin. -1 means margin at all borders.

See also: canvasMargin()

Warning: The margin will have no effect when alignCanvasToScale() is true

◆ setCanvasRect()

void QwtPlotLayout::setCanvasRect ( const QRectF & rect )

protected

Set the geometry for the canvas.

This method is intended to be used from derived layouts overloading activate()

See also: canvasRect(), activate()

◆ setFooterRect()

void QwtPlotLayout::setFooterRect ( const QRectF & rect )

protected

Set the geometry for the footer.

This method is intended to be used from derived layouts overloading activate()

See also: footerRect(), activate()

◆ setLegendPosition() [1/2]

void QwtPlotLayout::setLegendPosition ( QwtPlot::LegendPosition pos )

Specify the position of the legend.

Parameters

pos	The legend's position. Valid values are `QwtPlot::LeftLegend`, `QwtPlot::RightLegend`, `QwtPlot::TopLegend`, `QwtPlot::BottomLegend`.

See also: QwtPlot::setLegendPosition()

◆ setLegendPosition() [2/2]

void QwtPlotLayout::setLegendPosition	(	QwtPlot::LegendPosition	pos,
		double	ratio
	)

Specify the position of the legend.

Parameters

pos	The legend's position.
ratio	Ratio between legend and the bounding rectangle of title, footer, canvas and axes. The legend will be shrunk if it would need more space than the given ratio. The ratio is limited to ]0.0 .. 1.0]. In case of <= 0.0 it will be reset to the default ratio. The default vertical/horizontal ratio is 0.33/0.5.

See also: QwtPlot::setLegendPosition()

◆ setLegendRatio()

void QwtPlotLayout::setLegendRatio ( double ratio )

Specify the relative size of the legend in the plot

Parameters

ratio Ratio between legend and the bounding rectangle of title, footer, canvas and axes. The legend will be shrunk if it would need more space than the given ratio. The ratio is limited to ]0.0 .. 1.0]. In case of <= 0.0 it will be reset to the default ratio. The default vertical/horizontal ratio is 0.33/0.5.

◆ setLegendRect()

void QwtPlotLayout::setLegendRect ( const QRectF & rect )

protected

Set the geometry for the legend.

This method is intended to be used from derived layouts overloading activate()

Parameters

rect	Rectangle for the legend

See also: legendRect(), activate()

◆ setScaleRect()

void QwtPlotLayout::setScaleRect	(	int	axis,
		const QRectF &	rect
	)

protected

Set the geometry for an axis.

This method is intended to be used from derived layouts overloading activate()

Parameters

axis	Axis index
rect	Rectangle for the scale

See also: scaleRect(), activate()

◆ setSpacing()

void QwtPlotLayout::setSpacing ( int spacing )

Change the spacing of the plot. The spacing is the distance between the plot components.

Parameters

spacing New spacing

See also: setCanvasMargin(), spacing()

◆ setTitleRect()

void QwtPlotLayout::setTitleRect ( const QRectF & rect )

protected

Set the geometry for the title.

This method is intended to be used from derived layouts overloading activate()

See also: titleRect(), activate()

◆ spacing()

int QwtPlotLayout::spacing ( ) const

Returns: Spacing

See also: margin(), setSpacing()

◆ titleRect()

QRectF QwtPlotLayout::titleRect ( ) const

Returns: Geometry for the title

See also: activate(), invalidate()

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Option

Member Function Documentation

◆ activate()

◆ alignCanvasToScale()

◆ alignLegend()

◆ alignScales()

◆ canvasMargin()

◆ canvasRect()

◆ expandLineBreaks()

◆ footerRect()

◆ invalidate()

◆ layoutLegend()

◆ legendPosition()

◆ legendRatio()

◆ legendRect()

◆ minimumSizeHint()

◆ scaleRect()

◆ setAlignCanvasToScale()

◆ setAlignCanvasToScales()

◆ setCanvasMargin()

◆ setCanvasRect()

◆ setFooterRect()

◆ setLegendPosition() [1/2]

◆ setLegendPosition() [2/2]

◆ setLegendRatio()

◆ setLegendRect()

◆ setScaleRect()

◆ setSpacing()

◆ setTitleRect()

◆ spacing()

◆ titleRect()