QCPGrid Class Reference

Responsible for drawing the grid of a QCPAxis. More...

Inheritance diagram for QCPGrid:

Public Member Functions
	QCPGrid (QCPAxis *parentAxis)
	Creates a QCPGrid instance and sets default values.
bool	subGridVisible () const
bool	antialiasedSubGrid () const
bool	antialiasedZeroLine () const
QPen	pen () const
QPen	subGridPen () const
QPen	zeroLinePen () const
void	setSubGridVisible (bool visible)
	Sets whether grid lines at sub tick marks are drawn.
void	setAntialiasedSubGrid (bool enabled)
	Sets whether sub grid lines are drawn antialiased.
void	setAntialiasedZeroLine (bool enabled)
	Sets whether zero lines are drawn antialiased.
void	setPen (const QPen &pen)
	Sets the pen with which (major) grid lines are drawn.
void	setSubGridPen (const QPen &pen)
	Sets the pen with which sub grid lines are drawn.
void	setZeroLinePen (const QPen &pen)
	Sets the pen with which zero lines are drawn.
Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
	Creates a new QCPLayerable instance.
bool	visible () const
QCustomPlot *	parentPlot () const
QCPLayerable *	parentLayerable () const
	Returns the parent layerable of this layerable.
QCPLayer *	layer () const
bool	antialiased () const
void	setVisible (bool on)
	Sets the visibility of this layerable object.
Q_SLOT bool	setLayer (QCPLayer *layer)
	Sets the layer of this layerable object.
bool	setLayer (const QString &layerName)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name.
void	setAntialiased (bool enabled)
	Sets whether this object will be drawn antialiased or not.
virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
	This function is used to decide whether a click hits a layerable object or not.
bool	realVisibility () const
	Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of this layerable's layer into account.

Protected Member Functions
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE
virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE
void	drawGridLines (QCPPainter *painter) const
void	drawSubGridLines (QCPPainter *painter) const
Protected Member Functions inherited from QCPLayerable
virtual void	parentPlotInitialized (QCustomPlot *parentPlot)
virtual QCP::Interaction	selectionCategory () const
virtual QRect	clipRect () const
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const =0
virtual void	draw (QCPPainter *painter)=0
virtual void	selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
virtual void	deselectEvent (bool *selectionStateChanged)
virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)
	This event gets called when the user presses a mouse button while the cursor is over the layerable.
virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)
	This event gets called when the user moves the mouse while holding a mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent.
virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)
	This event gets called when the user releases the mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent.
virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)
	This event gets called when the user presses the mouse button a second time in a double-click, while the cursor is over the layerable.
virtual void	wheelEvent (QWheelEvent *event)
	This event gets called when the user turns the mouse scroll wheel while the cursor is over the layerable.
void	initializeParentPlot (QCustomPlot *parentPlot)
void	setParentLayerable (QCPLayerable *parentLayerable)
bool	moveToLayer (QCPLayer *layer, bool prepend)
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Protected Attributes
bool	mSubGridVisible
bool	mAntialiasedSubGrid
bool	mAntialiasedZeroLine
QPen	mPen
QPen	mSubGridPen
QPen	mZeroLinePen
QCPAxis *	mParentAxis
Protected Attributes inherited from QCPLayerable
bool	mVisible
QCustomPlot *	mParentPlot
QPointer< QCPLayerable >	mParentLayerable
QCPLayer *	mLayer
bool	mAntialiased

Friends
class	QCPAxis

Additional Inherited Members
Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)
	This signal is emitted when the layer of this layerable changes, i.e.

Detailed Description

Responsible for drawing the grid of a QCPAxis.

This class is tightly bound to QCPAxis. Every axis owns a grid instance and uses it to draw the grid lines, sub grid lines and zero-line. You can interact with the grid of an axis via QCPAxis::grid. Normally, you don't need to create an instance of QCPGrid yourself.

The axis and grid drawing was split into two classes to allow them to be placed on different layers (both QCPAxis and QCPGrid inherit from QCPLayerable). Thus it is possible to have the grid in the background and the axes in the foreground, and any plottables/items in between. This described situation is the default setup, see the QCPLayer documentation.

Constructor & Destructor Documentation

QCPGrid()

QCPGrid::QCPGrid ( QCPAxis *  parentAxis )

explicit

Creates a QCPGrid instance and sets default values.

You shouldn't instantiate grids on their own, since every QCPAxis brings its own QCPGrid.

Member Function Documentation

applyDefaultAntialiasingHint()

void QCPGrid::applyDefaultAntialiasingHint ( QCPPainter *  painter ) const

protectedvirtual

Implements QCPLayerable.

draw()

void QCPGrid::draw ( QCPPainter *  painter )

protectedvirtual

Implements QCPLayerable.

setSubGridVisible()

void QCPGrid::setSubGridVisible

(

bool

visible

)

Sets whether grid lines at sub tick marks are drawn.

See also

setSubGridPen

setZeroLinePen()

void QCPGrid::setZeroLinePen

(

const QPen &

pen

)

Sets the pen with which zero lines are drawn.

Zero lines are lines at value coordinate 0 which may be drawn with a different pen than other grid lines. To disable zero lines and just draw normal grid lines at zero, set pen to Qt::NoPen.

---

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

• qcustomplot.h
• qcustomplot.cpp