QwtPolarLayout Class Reference

Layout class for QwtPolarPlot. More...

#include <qwt_polar_layout.h>

Classes
class	LayoutData
class	PrivateData

Public Types
enum	Option { IgnoreScrollbars = 0x01 , IgnoreFrames = 0x02 , IgnoreTitle = 0x04 , IgnoreLegend = 0x08 }
	Options to configure the plot layout engine. More...

Public Member Functions
	QwtPolarLayout ()
	Constructor.
virtual	~QwtPolarLayout ()
	Destructor.
void	setLegendPosition (QwtPolarPlot::LegendPosition pos, double ratio)
	Set the legend position with ratio.
void	setLegendPosition (QwtPolarPlot::LegendPosition pos)
	Set the legend position.
QwtPolarPlot::LegendPosition	legendPosition () const
	Get the legend position.
void	setLegendRatio (double ratio)
	Set the legend ratio.
double	legendRatio () const
	Get the legend ratio.
virtual void	activate (const QwtPolarPlot *, const QRectF &rect, Options options=Options())
	Activate the layout.
virtual void	invalidate ()
	Invalidate the layout.
const QRectF &	titleRect () const
	Get the title rectangle.
const QRectF &	legendRect () const
	Get the legend rectangle.
const QRectF &	canvasRect () const
	Get the canvas rectangle.

Protected Member Functions
QRectF	layoutLegend (Options options, QRectF &) const
	Find the geometry for the legend.

Detailed Description

Layout class for QwtPolarPlot.

Organizes the geometry for the different QwtPolarPlot components. It is used by the QwtPolar widget to organize its internal widgets or by QwtPolarRenderer to render its content to a QPaintDevice like a QPrinter, QPixmap/QImage or QSvgRenderer.

Member Enumeration Documentation

Option

enum QwtPolarLayout::Option

Options to configure the plot layout engine.

Enumerator
IgnoreScrollbars	Ignore the dimension of the scrollbars.
IgnoreFrames	Ignore all frames.
IgnoreTitle	Ignore the title.
IgnoreLegend	Ignore the legend.

Constructor & Destructor Documentation

QwtPolarLayout()

QwtPolarLayout::QwtPolarLayout ( )

explicit

Constructor.

Destructor

Member Function Documentation

activate()

void QwtPolarLayout::activate ( const QwtPolarPlot *  plot, const QRectF &  boundingRect, Options  options = Options()  )

virtual

Activate the layout.

Recalculate the geometry of all components.

Parameters

plot	Plot to be layout
boundingRect	Rect where to place the components
options	Options

See also

invalidate(), titleRect(), legendRect(), canvasRect()

canvasRect()

const QRectF & QwtPolarLayout::canvasRect

(

)

const

Get the canvas rectangle.

Get geometry for the canvas.

Returns

Geometry for the canvas

See also

activate(), invalidate()

invalidate()

void QwtPolarLayout::invalidate ( )

virtual

Invalidate the layout.

Invalidate the geometry of all components.

See also

activate()

layoutLegend()

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

protected

Find the geometry for the legend.

Parameters

	options	Options how to layout the legend
[in,out]	rect	Rectangle where to place the legend

Returns

Geometry for the legend

legendPosition()

QwtPolarPlot::LegendPosition QwtPolarLayout::legendPosition

(

)

const

Get the legend position.

Get the position of the legend.

Returns

Position of the legend

See also

setLegendPosition(), QwtPolarPlot::setLegendPosition(), QwtPolarPlot::legendPosition()

legendRatio()

double QwtPolarLayout::legendRatio

(

)

const

Get the legend ratio.

Get the relative size of the legend in the plot.

Returns

The relative size of the legend in the plot

See also

setLegendPosition()

legendRect()

const QRectF & QwtPolarLayout::legendRect

(

)

const

Get the legend rectangle.

Get geometry for the legend.

Returns

Geometry for the legend

See also

activate(), invalidate()

setLegendPosition() [1/2]

void QwtPolarLayout::setLegendPosition

(

QwtPolarPlot::LegendPosition

pos

)

Set the legend position.

Specify the position of the legend.

Parameters

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

See also

QwtPolarPlot::setLegendPosition()

setLegendPosition() [2/2]

void QwtPolarLayout::setLegendPosition	(	QwtPolarPlot::LegendPosition	pos,
		double	ratio
	)

Set the legend position with ratio.

Specify the position of the legend.

Parameters

pos	The legend's position
ratio	Ratio between legend and the bounding rect of title, 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

QwtPolarPlot::setLegendPosition()

setLegendRatio()

void QwtPolarLayout::setLegendRatio

(

double

ratio

)

Set the legend ratio.

Specify the relative size of the legend in the plot.

Parameters

ratio

Ratio between legend and the bounding rect of title, 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

setLegendPosition()

titleRect()

const QRectF & QwtPolarLayout::titleRect

(

)

const

Get the title rectangle.

Get geometry for the title.

Returns

Geometry for the title

See also

activate(), invalidate()

---

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

• /home/runner/work/QWT/QWT/src/plot/qwt_polar_layout.h
• /home/runner/work/QWT/QWT/src/plot/qwt_polar_layout.cpp