A plot item, which displays a zone. More...

#include <qwt_plot_zoneitem.h>

Inheritance diagram for QwtPlotZoneItem:

Classes
class	PrivateData

Public Member Functions
	QwtPlotZoneItem ()
	Constructor.

virtual int	rtti () const override
	Get the runtime type information.

void	setOrientation (Qt::Orientation)
	Set the orientation of the zone.

Qt::Orientation	orientation () const
	Get the orientation of the zone.

void	setInterval (double min, double max)
	Set the interval of the zone.

void	setInterval (const QwtInterval &)
	Set the interval of the zone.

QwtInterval	interval () const
	Get the interval of the zone.

void	setPen (const QColor &, qreal width=0.0, Qt::PenStyle=Qt::SolidLine)
	Build and assign a pen.

void	setPen (const QPen &)
	Assign a pen.

const QPen &	pen () const
	Get the pen used to draw the border lines.

void	setBrush (const QBrush &)
	Assign a brush.

const QBrush &	brush () const
	Get the brush used to fill the zone.

virtual void	draw (QPainter *, const QwtScaleMap &, const QwtScaleMap &, const QRectF &canvasRect) const override
	Draw the zone.

virtual QRectF	boundingRect () const override
	Get the bounding rectangle.

Public Member Functions inherited from QwtPlotItem
	QwtPlotItem ()
	Default constructor.

	QwtPlotItem (const QString &title)
	Constructor with title as QString.

	QwtPlotItem (const QwtText &title)
	Constructor with title as QwtText.

virtual	~QwtPlotItem ()
	Destructor.

virtual void	attach (QwtPlot *plot)
	Attach the item to a plot.

void	detach ()
	Detach the item from the plot.

QwtPlot *	plot () const
	Get the plot the item is attached to.

void	setTitle (const QString &title)
	Set the title using a QString.

void	setTitle (const QwtText &title)
	Set the title using a QwtText.

const QwtText &	title () const
	Get the title.

void	setItemAttribute (ItemAttribute, bool on=true)
	Set an item attribute.

bool	testItemAttribute (ItemAttribute) const
	Test an item attribute.

void	setItemInterest (ItemInterest, bool on=true)
	Set an item interest.

bool	testItemInterest (ItemInterest) const
	Test an item interest.

void	setRenderHint (RenderHint, bool on=true)
	Set a render hint.

bool	testRenderHint (RenderHint) const
	Test a render hint.

void	setRenderThreadCount (uint numThreads)
	Set the number of render threads.

uint	renderThreadCount () const
	Get the number of render threads.

void	setLegendIconSize (const QSize &)
	Set the legend icon size.

QSize	legendIconSize () const
	Get the legend icon size.

double	z () const
	Get the z-value.

void	setZ (double z)
	Set the z-value.

void	show ()
	Show the item.

void	hide ()
	Hide the item.

virtual void	setVisible (bool)
	Set the visibility.

bool	isVisible () const
	Check if the item is visible.

void	setAxes (QwtAxisId xAxis, QwtAxisId yAxis)
	Set both axes.

void	setXAxis (QwtAxisId)
	Set the x-axis.

QwtAxisId	xAxis () const
	Get the x-axis.

void	setYAxis (QwtAxisId)
	Set the y-axis.

QwtAxisId	yAxis () const
	Get the y-axis.

virtual void	itemChanged ()
	Notify the plot that the item has changed.

virtual void	legendChanged ()
	Notify the item that the legend has changed.

virtual void	getCanvasMarginHint (const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, double &left, double &top, double &right, double &bottom) const
	Get margin hints for the canvas.

virtual void	updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &)
	Update the item with new scale divisions.

virtual void	updateLegend (const QwtPlotItem *, const QList< QwtLegendData > &)
	Update the item with changes of the legend.

QRectF	scaleRect (const QwtScaleMap &, const QwtScaleMap &) const
	Calculate the scale rectangle.

QRectF	paintRect (const QwtScaleMap &, const QwtScaleMap &) const
	Calculate the paint rectangle.

virtual QList< QwtLegendData >	legendData () const
	Return legend data.

virtual QwtGraphic	legendIcon (int index, const QSizeF &) const
	Return a legend icon.

Additional Inherited Members
Public Types inherited from QwtPlotItem
enum	RttiValues { Rtti_PlotItem = 0 , Rtti_PlotGrid , Rtti_PlotScale , Rtti_PlotLegend , Rtti_PlotMarker , Rtti_PlotCurve , Rtti_PlotSpectroCurve , Rtti_PlotIntervalCurve , Rtti_PlotHistogram , Rtti_PlotSpectrogram , Rtti_PlotGraphic , Rtti_PlotTradingCurve , Rtti_PlotBarChart , Rtti_PlotMultiBarChart , Rtti_PlotShape , Rtti_PlotTextLabel , Rtti_PlotZone , Rtti_PlotVectorField , Rtti_PlotArrowMarker , Rtti_PlotBoxChart , Rtti_PlotUserItem = 1000 }
	Runtime type information. More...

enum	ItemAttribute { Legend = 0x01 , AutoScale = 0x02 , Margins = 0x04 }
	Plot Item Attributes. More...

enum	ItemInterest { ScaleInterest = 0x01 , LegendInterest = 0x02 }
	Plot Item Interests. More...

enum	RenderHint { RenderAntialiased = 0x1 }
	Render hints. More...

Protected Member Functions inherited from QwtPlotItem
QwtGraphic	defaultIcon (const QBrush &, const QSizeF &) const
	Create a default icon.

Detailed Description

A plot item, which displays a zone.

A horizontal zone highlights an interval of the y axis - a vertical zone an interval of the x axis - and is unbounded in the opposite direction. It is filled with a brush and its border lines are optionally displayed with a pen.

Note: For displaying an area that is bounded for x and y coordinates use QwtPlotShapeItem

Constructor & Destructor Documentation

◆ QwtPlotZoneItem()

QwtPlotZoneItem::QwtPlotZoneItem ( )

explicit

Constructor.

Initializes the zone with no pen and a semi transparent gray brush. Sets the following item attributes:

QwtPlotItem::AutoScale: false
QwtPlotItem::Legend: false The z value is initialized by 5.
See also
QwtPlotItem::setItemAttribute(), QwtPlotItem::setZ()
Destructor

Member Function Documentation

◆ boundingRect()

QRectF QwtPlotZoneItem::boundingRect ( ) const

overridevirtual

Get the bounding rectangle.

The bounding rectangle is built from the interval in one direction and something invalid for the opposite direction.

Returns: An invalid rectangle with valid boundaries in one direction

Reimplemented from QwtPlotItem.

◆ brush()

const QBrush & QwtPlotZoneItem::brush ( ) const

Get the brush used to fill the zone.

Returns: Brush used to fill the zone

See also: setPen(), brush()

◆ draw()

void QwtPlotZoneItem::draw	(	QPainter *	painter,
		const QwtScaleMap &	xMap,
		const QwtScaleMap &	yMap,
		const QRectF &	canvasRect
	)		const

overridevirtual

Draw the zone.

Parameters

[in]	painter	Painter
[in]	xMap	x Scale Map
[in]	yMap	y Scale Map
[in]	canvasRect	Contents rectangle of the canvas in painter coordinates

Implements QwtPlotItem.

◆ interval()

QwtInterval QwtPlotZoneItem::interval ( ) const

Get the interval of the zone.

Returns: Zone interval

See also: setInterval(), orientation()

◆ orientation()

Qt::Orientation QwtPlotZoneItem::orientation ( ) const

Get the orientation of the zone.

Returns: Orientation of the zone

See also: setOrientation()

◆ pen()

const QPen & QwtPlotZoneItem::pen ( ) const

Get the pen used to draw the border lines.

Returns: Pen used to draw the border lines

See also: setPen(), brush()

◆ rtti()

int QwtPlotZoneItem::rtti ( ) const

overridevirtual

Get the runtime type information.

Returns: QwtPlotItem::Rtti_PlotZone

Reimplemented from QwtPlotItem.

◆ setBrush()

void QwtPlotZoneItem::setBrush ( const QBrush & brush )

Assign a brush.

Parameters

[in] brush Brush

The brush is used to fill the zone.

See also: pen(), setBrush()

◆ setInterval() [1/2]

void QwtPlotZoneItem::setInterval ( const QwtInterval & interval )

Set the interval of the zone.

Parameters

[in] interval Zone interval

For a horizontal zone the interval is related to the y axis, for a vertical zone it is related to the x axis.

See also: interval(), setOrientation()

◆ setInterval() [2/2]

void QwtPlotZoneItem::setInterval	(	double	min,
		double	max
	)

Set the interval of the zone.

Parameters

[in]	min	Minimum of the interval
[in]	max	Maximum of the interval

For a horizontal zone the interval is related to the y axis, for a vertical zone it is related to the x axis.

See also: interval(), setOrientation()

◆ setOrientation()

void QwtPlotZoneItem::setOrientation ( Qt::Orientation orientation )

Set the orientation of the zone.

Parameters

[in] orientation Orientation

A horizontal zone highlights an interval of the y axis, a vertical zone of the x axis. It is unbounded in the opposite direction.

See also: orientation(), QwtPlotItem::setAxes()

◆ setPen() [1/2]

void QwtPlotZoneItem::setPen	(	const QColor &	color,
		qreal	width = `0.0`,
		Qt::PenStyle	style = `Qt::SolidLine`
	)

Build and assign a pen.

Parameters

[in]	color	Pen color
[in]	width	Pen width
[in]	style	Pen style

In Qt5 the default pen width is 1.0 ( 0.0 in Qt4 ) what makes it non cosmetic. This method has been introduced to hide this incompatibility.

See also: pen(), brush()

◆ setPen() [2/2]

void QwtPlotZoneItem::setPen ( const QPen & pen )

Assign a pen.

Parameters

[in] pen Pen

The pen is used to draw the border lines of the zone.

See also: pen(), setBrush()

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

/home/runner/work/QWT/QWT/src/plot/qwt_plot_zoneitem.h
/home/runner/work/QWT/QWT/src/plot/qwt_plot_zoneitem.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QwtPlotZoneItem()

Member Function Documentation

◆ boundingRect()

◆ brush()

◆ draw()

◆ interval()

◆ orientation()

◆ pen()

◆ rtti()

◆ setBrush()

◆ setInterval() [1/2]

◆ setInterval() [2/2]

◆ setOrientation()

◆ setPen() [1/2]

◆ setPen() [2/2]