A class which draws a coordinate grid. More...

#include <qwt_plot_grid.h>

Inheritance diagram for QwtPlotGrid:

Classes
class	PrivateData

Public Member Functions
	QwtPlotGrid ()
	Constructor.

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

void	enableX (bool)
	Enable or disable vertical grid lines.

bool	xEnabled () const
	Check if vertical grid lines are enabled.

void	enableY (bool)
	Enable or disable horizontal grid lines.

bool	yEnabled () const
	Check if horizontal grid lines are enabled.

void	enableXMin (bool)
	Enable or disable minor vertical grid lines.

bool	xMinEnabled () const
	Check if minor vertical grid lines are enabled.

void	enableYMin (bool)
	Enable or disable minor horizontal grid lines.

bool	yMinEnabled () const
	Check if minor horizontal grid lines are enabled.

void	setXDiv (const QwtScaleDiv &)
	Assign an x axis scale division.

const QwtScaleDiv &	xScaleDiv () const
	Get the scale division of the x axis.

void	setYDiv (const QwtScaleDiv &)
	Assign a y axis scale division.

const QwtScaleDiv &	yScaleDiv () const
	Get the scale division of the y axis.

void	setPen (const QColor &, qreal width=0.0, Qt::PenStyle=Qt::SolidLine)
	Build and assign a pen for both major and minor grid lines.

void	setPen (const QPen &)
	Assign a pen for both major and minor grid lines.

void	setMajorPen (const QColor &, qreal width=0.0, Qt::PenStyle=Qt::SolidLine)
	Build and assign a pen for major grid lines.

void	setMajorPen (const QPen &)
	Assign a pen for the major grid lines.

const QPen &	majorPen () const
	Get the pen for the major grid lines.

void	setMinorPen (const QColor &, qreal width=0.0, Qt::PenStyle=Qt::SolidLine)
	Build and assign a pen for the minor grid lines.

void	setMinorPen (const QPen &)
	Assign a pen for the minor grid lines.

const QPen &	minorPen () const
	Get the pen for the minor grid lines.

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

virtual void	updateScaleDiv (const QwtScaleDiv &xScaleDiv, const QwtScaleDiv &yScaleDiv) override
	Update the grid to changes of the axes scale division.

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 QRectF	boundingRect () const
	Get the bounding rectangle.

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	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 class which draws a coordinate grid.

The QwtPlotGrid class can be used to draw a coordinate grid. A coordinate grid consists of major and minor vertical and horizontal grid lines. The locations of the grid lines are determined by the X and Y scale divisions which can be assigned with setXDiv() and setYDiv(). The draw() member draws the grid within a bounding rectangle.

Constructor & Destructor Documentation

◆ QwtPlotGrid()

QwtPlotGrid::QwtPlotGrid ( )

explicit

Constructor.

Enables major grid, disables minor grid

Destructor

Member Function Documentation

◆ draw()

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

overridevirtual

Draw the grid.

The grid is drawn into the bounding rectangle such that grid lines begin and end at the rectangle's borders. The X and Y maps are used to map the scale divisions into the drawing region screen.

Parameters

[in]	painter	Painter
[in]	xMap	X axis map
[in]	yMap	Y axis
[in]	canvasRect	Contents rectangle of the plot canvas

Implements QwtPlotItem.

◆ enableX()

void QwtPlotGrid::enableX ( bool on )

Enable or disable vertical grid lines.

Parameters

[in] on Enable (true) or disable

See also: Minor grid lines can be enabled or disabled with enableXMin()

◆ enableXMin()

void QwtPlotGrid::enableXMin ( bool on )

Enable or disable minor vertical grid lines.

Parameters

[in] on Enable (true) or disable

See also: enableX()

◆ enableY()

void QwtPlotGrid::enableY ( bool on )

Enable or disable horizontal grid lines.

Parameters

[in] on Enable (true) or disable

See also: Minor grid lines can be enabled or disabled with enableYMin()

◆ enableYMin()

void QwtPlotGrid::enableYMin ( bool on )

Enable or disable minor horizontal grid lines.

Parameters

[in] on Enable (true) or disable

See also: enableY()

◆ majorPen()

const QPen & QwtPlotGrid::majorPen ( ) const

Get the pen for the major grid lines.

Returns: Pen for major grid lines

See also: setMajorPen(), setMinorPen(), setPen()

◆ minorPen()

const QPen & QwtPlotGrid::minorPen ( ) const

Get the pen for the minor grid lines.

Returns: Pen for minor grid lines

See also: setMinorPen(), setMajorPen(), setPen()

◆ rtti()

int QwtPlotGrid::rtti ( ) const

overridevirtual

Get the runtime type information.

Returns: QwtPlotItem::Rtti_PlotGrid

Reimplemented from QwtPlotItem.

◆ setMajorPen() [1/2]

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

Build and assign a pen for major grid lines.

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

Parameters

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

See also: pen(), brush()

◆ setMajorPen() [2/2]

void QwtPlotGrid::setMajorPen ( const QPen & pen )

Assign a pen for the major grid lines.

Parameters

[in] pen Pen

See also: majorPen(), setMinorPen(), setPen()

◆ setMinorPen() [1/2]

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

Build and assign a pen for the minor grid lines.

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

Parameters

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

See also: pen(), brush()

◆ setMinorPen() [2/2]

void QwtPlotGrid::setMinorPen ( const QPen & pen )

Assign a pen for the minor grid lines.

Parameters

[in] pen Pen

See also: minorPen(), setMajorPen(), setPen()

◆ setPen() [1/2]

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

Build and assign a pen for both major and minor grid lines.

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

Parameters

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

See also: pen(), brush()

◆ setPen() [2/2]

void QwtPlotGrid::setPen ( const QPen & pen )

Assign a pen for both major and minor grid lines.

Parameters

[in] pen Pen

See also: setMajorPen(), setMinorPen()

◆ setXDiv()

void QwtPlotGrid::setXDiv ( const QwtScaleDiv & scaleDiv )

Assign an x axis scale division.

Parameters

[in] scaleDiv Scale division

◆ setYDiv()

void QwtPlotGrid::setYDiv ( const QwtScaleDiv & scaleDiv )

Assign a y axis scale division.

Parameters

[in] scaleDiv Scale division

◆ updateScaleDiv()

void QwtPlotGrid::updateScaleDiv	(	const QwtScaleDiv &	xScaleDiv,
		const QwtScaleDiv &	yScaleDiv
	)

overridevirtual

Update the grid to changes of the axes scale division.

Parameters

[in]	xScaleDiv	Scale division of the x-axis
[in]	yScaleDiv	Scale division of the y-axis

See also: QwtPlot::updateAxes()

Reimplemented from QwtPlotItem.

◆ xEnabled()

bool QwtPlotGrid::xEnabled ( ) const

Check if vertical grid lines are enabled.

Returns: true if vertical grid lines are enabled

See also: enableX()

◆ xMinEnabled()

bool QwtPlotGrid::xMinEnabled ( ) const

Check if minor vertical grid lines are enabled.

Returns: true if minor vertical grid lines are enabled

See also: enableXMin()

◆ xScaleDiv()

const QwtScaleDiv & QwtPlotGrid::xScaleDiv ( ) const

Get the scale division of the x axis.

Returns: Scale division of the x axis

◆ yEnabled()

bool QwtPlotGrid::yEnabled ( ) const

Check if horizontal grid lines are enabled.

Returns: true if horizontal grid lines are enabled

See also: enableY()

◆ yMinEnabled()

bool QwtPlotGrid::yMinEnabled ( ) const

Check if minor horizontal grid lines are enabled.

Returns: true if minor horizontal grid lines are enabled

See also: enableYMin()

◆ yScaleDiv()

const QwtScaleDiv & QwtPlotGrid::yScaleDiv ( ) const

Get the scale division of the y axis.

Returns: Scale division of the y axis

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

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

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QwtPlotGrid()

Member Function Documentation

◆ draw()

◆ enableX()

◆ enableXMin()

◆ enableY()

◆ enableYMin()

◆ majorPen()

◆ minorPen()

◆ rtti()

◆ setMajorPen() [1/2]

◆ setMajorPen() [2/2]

◆ setMinorPen() [1/2]

◆ setMinorPen() [2/2]

◆ setPen() [1/2]

◆ setPen() [2/2]

◆ setXDiv()

◆ setYDiv()

◆ updateScaleDiv()

◆ xEnabled()

◆ xMinEnabled()

◆ xScaleDiv()

◆ yEnabled()

◆ yMinEnabled()

◆ yScaleDiv()