A rectangle. More...

#include <qcustomplot.h>

Inheritance diagram for QCPItemRect:

Public Member Functions
QBrush	brush () const

QPen	pen () const

	QCPItemRect (QCustomPlot *parentPlot)

QBrush	selectedBrush () const

QPen	selectedPen () const

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE

void	setBrush (const QBrush &brush)

void	setPen (const QPen &pen)

void	setSelectedBrush (const QBrush &brush)

void	setSelectedPen (const QPen &pen)

virtual	~QCPItemRect ()

Public Member Functions inherited from QCPAbstractItem
QCPItemAnchor *	anchor (const QString &name) const

QList< QCPItemAnchor * >	anchors () const

QCPAxisRect *	clipAxisRect () const

bool	clipToAxisRect () const

bool	hasAnchor (const QString &name) const

QCPItemPosition *	position (const QString &name) const

QList< QCPItemPosition * >	positions () const

	QCPAbstractItem (QCustomPlot *parentPlot)

bool	selectable () const

bool	selected () const

void	setClipAxisRect (QCPAxisRect *rect)

void	setClipToAxisRect (bool clip)

Q_SLOT void	setSelectable (bool selectable)

Q_SLOT void	setSelected (bool selected)

virtual	~QCPAbstractItem ()

Public Member Functions inherited from QCPLayerable
bool	antialiased () const

QCPLayer *	layer () const

QCPLayerable *	parentLayerable () const

QCustomPlot *	parentPlot () const

	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

bool	realVisibility () const

void	setAntialiased (bool enabled)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setVisible (bool on)

bool	visible () const

virtual	~QCPLayerable ()

Public Attributes
QCPItemAnchor *const	bottom

QCPItemAnchor *const	bottomLeft

QCPItemPosition *const	bottomRight

QCPItemAnchor *const	left

QCPItemAnchor *const	right

QCPItemAnchor *const	top

QCPItemPosition *const	topLeft

QCPItemAnchor *const	topRight

Protected Types
enum	AnchorIndex { aiTop, aiTopRight, aiRight, aiBottom, aiBottomLeft, aiLeft }

Protected Member Functions
virtual QPointF	anchorPixelPosition (int anchorId) const Q_DECL_OVERRIDE

virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE

QBrush	mainBrush () const

QPen	mainPen () const

Protected Member Functions inherited from QCPAbstractItem
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE

virtual QRect	clipRect () const Q_DECL_OVERRIDE

QCPItemAnchor *	createAnchor (const QString &name, int anchorId)

QCPItemPosition *	createPosition (const QString &name)

virtual void	deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE

double	rectDistance (const QRectF &rect, const QPointF &pos, bool filledRect) const

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged) Q_DECL_OVERRIDE

virtual QCP::Interaction	selectionCategory () const Q_DECL_OVERRIDE

Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

void	initializeParentPlot (QCustomPlot *parentPlot)

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)

bool	moveToLayer (QCPLayer *layer, bool prepend)

virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

virtual void	wheelEvent (QWheelEvent *event)

Protected Attributes
QBrush	mBrush

QPen	mPen

QBrush	mSelectedBrush

QPen	mSelectedPen

Protected Attributes inherited from QCPAbstractItem
QList< QCPItemAnchor * >	mAnchors

QPointer< QCPAxisRect >	mClipAxisRect

bool	mClipToAxisRect

QList< QCPItemPosition * >	mPositions

bool	mSelectable

bool	mSelected

Protected Attributes inherited from QCPLayerable
bool	mAntialiased

QCPLayer *	mLayer

QPointer< QCPLayerable >	mParentLayerable

QCustomPlot *	mParentPlot

bool	mVisible

Additional Inherited Members
Signals inherited from QCPAbstractItem
void	selectableChanged (bool selectable)

void	selectionChanged (bool selected)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Detailed Description

A rectangle.

Rectangle example. Blue dotted circles are anchors, solid blue discs are positions.

It has two positions, topLeft and bottomRight, which define the rectangle.

Definition at line 6235 of file qcustomplot.h.

Member Enumeration Documentation

◆ AnchorIndex

enum QCPItemRect::AnchorIndex

protected

Enumerator
aiTop
aiTopRight
aiRight
aiBottom
aiBottomLeft
aiLeft

Definition at line 6273 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPItemRect()

QCPItemRect::QCPItemRect ( QCustomPlot * parentPlot )

explicit

Creates a rectangle item and sets default values.

The created item is automatically registered with parentPlot. This QCustomPlot instance takes ownership of the item, so do not delete it manually but use QCustomPlot::removeItem() instead.

Definition at line 28663 of file qcustomplot.cpp.

◆ ~QCPItemRect()

QCPItemRect::~QCPItemRect ( )

virtual

Definition at line 28683 of file qcustomplot.cpp.

Member Function Documentation

◆ anchorPixelPosition()

QPointF QCPItemRect::anchorPixelPosition ( int anchorId ) const

protectedvirtual

Reimplemented from QCPAbstractItem.

Definition at line 28760 of file qcustomplot.cpp.

◆ brush()

QBrush QCPItemRect::brush ( ) const

inline

Definition at line 6251 of file qcustomplot.h.

◆ draw()

void QCPItemRect::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractItem.

Definition at line 28742 of file qcustomplot.cpp.

◆ mainBrush()

QBrush QCPItemRect::mainBrush ( ) const

protected

Definition at line 28792 of file qcustomplot.cpp.

◆ mainPen()

QPen QCPItemRect::mainPen ( ) const

protected

Definition at line 28782 of file qcustomplot.cpp.

◆ pen()

QPen QCPItemRect::pen ( ) const

inline

Definition at line 6249 of file qcustomplot.h.

◆ selectedBrush()

QBrush QCPItemRect::selectedBrush ( ) const

inline

Definition at line 6252 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemRect::selectedPen ( ) const

inline

Definition at line 6250 of file qcustomplot.h.

◆ selectTest()

double QCPItemRect::selectTest	(	const QPointF &	pos,
		bool	onlySelectable,
		QVariant *	details = `0`
	)		const

virtual

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also: selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions, QCPAbstractPlottable1D::selectTestRect

Implements QCPAbstractItem.

Definition at line 28730 of file qcustomplot.cpp.

◆ setBrush()

void QCPItemRect::setBrush ( const QBrush & brush )

Sets the brush that will be used to fill the rectangle. To disable filling, set brush to Qt::NoBrush.

See also: setSelectedBrush, setPen

Definition at line 28713 of file qcustomplot.cpp.

◆ setPen()

void QCPItemRect::setPen ( const QPen & pen )

Sets the pen that will be used to draw the line of the rectangle

See also: setSelectedPen, setBrush

Definition at line 28692 of file qcustomplot.cpp.

◆ setSelectedBrush()

void QCPItemRect::setSelectedBrush ( const QBrush & brush )

Sets the brush that will be used to fill the rectangle when selected. To disable filling, set brush to Qt::NoBrush.

See also: setBrush

Definition at line 28724 of file qcustomplot.cpp.

◆ setSelectedPen()

void QCPItemRect::setSelectedPen ( const QPen & pen )

Sets the pen that will be used to draw the line of the rectangle when selected

See also: setPen, setSelected

Definition at line 28702 of file qcustomplot.cpp.

Member Data Documentation

◆ bottom

QCPItemAnchor* const QCPItemRect::bottom

Definition at line 6268 of file qcustomplot.h.

◆ bottomLeft

QCPItemAnchor* const QCPItemRect::bottomLeft

Definition at line 6269 of file qcustomplot.h.

◆ bottomRight

QCPItemPosition* const QCPItemRect::bottomRight

Definition at line 6264 of file qcustomplot.h.

◆ left

QCPItemAnchor* const QCPItemRect::left

Definition at line 6270 of file qcustomplot.h.

◆ mBrush

QBrush QCPItemRect::mBrush

protected

Definition at line 6277 of file qcustomplot.h.

◆ mPen

QPen QCPItemRect::mPen

protected

Definition at line 6276 of file qcustomplot.h.

◆ mSelectedBrush

QBrush QCPItemRect::mSelectedBrush

protected

Definition at line 6277 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemRect::mSelectedPen

protected

Definition at line 6276 of file qcustomplot.h.

◆ right

QCPItemAnchor* const QCPItemRect::right

Definition at line 6267 of file qcustomplot.h.

◆ top

QCPItemAnchor* const QCPItemRect::top

Definition at line 6265 of file qcustomplot.h.

◆ topLeft

QCPItemPosition* const QCPItemRect::topLeft

Definition at line 6263 of file qcustomplot.h.

◆ topRight

QCPItemAnchor* const QCPItemRect::topRight

Definition at line 6266 of file qcustomplot.h.

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

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AnchorIndex

Constructor & Destructor Documentation

◆ QCPItemRect()

◆ ~QCPItemRect()

Member Function Documentation

◆ anchorPixelPosition()

◆ brush()

◆ draw()

◆ mainBrush()

◆ mainPen()

◆ pen()

◆ selectedBrush()

◆ selectedPen()

◆ selectTest()

◆ setBrush()

◆ setPen()

◆ setSelectedBrush()

◆ setSelectedPen()

Member Data Documentation

◆ bottom

◆ bottomLeft

◆ bottomRight

◆ left

◆ mBrush

◆ mPen

◆ mSelectedBrush

◆ mSelectedPen

◆ right

◆ top

◆ topLeft

◆ topRight