A bracket for referencing/highlighting certain parts in the plot. More...

#include <qcustomplot.h>

Inheritance diagram for QCPItemBracket:

Public Types
enum	BracketStyle { bsSquare, bsRound, bsCurly, bsCalligraphic }

Public Member Functions
double	length () const

QPen	pen () const

	QCPItemBracket (QCustomPlot *parentPlot)

QPen	selectedPen () const

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

void	setLength (double length)

void	setPen (const QPen &pen)

void	setSelectedPen (const QPen &pen)

void	setStyle (BracketStyle style)

BracketStyle	style () const

virtual	~QCPItemBracket ()

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	center

QCPItemPosition *const	left

QCPItemPosition *const	right

Protected Types
enum	AnchorIndex { aiCenter }

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

virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE

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
double	mLength

QPen	mPen

QPen	mSelectedPen

BracketStyle	mStyle

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 bracket for referencing/highlighting certain parts in the plot.

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

It has two positions, left and right, which define the span of the bracket. If left is actually farther to the left than right, the bracket is opened to the bottom, as shown in the example image.

The bracket supports multiple styles via setStyle. The length, i.e. how far the bracket stretches away from the embraced span, can be controlled with setLength.

Demonstrating the effect of different values for setLength, for styles bsCalligraphic and bsSquare. Anchors and positions are displayed for reference.

It provides an anchor center, to allow connection of other items, e.g. an arrow (QCPItemLine or QCPItemCurve) or a text label (QCPItemText), to the bracket.

Definition at line 6608 of file qcustomplot.h.

Member Enumeration Documentation

◆ AnchorIndex

enum QCPItemBracket::AnchorIndex

protected

Enumerator
aiCenter

Definition at line 6655 of file qcustomplot.h.

◆ BracketStyle

enum QCPItemBracket::BracketStyle

Defines the various visual shapes of the bracket item. The appearance can be further modified by setLength and setPen.

See also: setStyle

Enumerator
bsSquare	A brace with angled edges.
bsRound	A brace with round edges.
bsCurly	A curly brace.
bsCalligraphic	A curly brace with varying stroke width giving a calligraphic impression.

Definition at line 6624 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPItemBracket()

QCPItemBracket::QCPItemBracket ( QCustomPlot * parentPlot )

explicit

Creates a bracket 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 30008 of file qcustomplot.cpp.

◆ ~QCPItemBracket()

QCPItemBracket::~QCPItemBracket ( )

virtual

Definition at line 30023 of file qcustomplot.cpp.

Member Function Documentation

◆ anchorPixelPosition()

QPointF QCPItemBracket::anchorPixelPosition ( int anchorId ) const

protectedvirtual

Reimplemented from QCPAbstractItem.

Definition at line 30183 of file qcustomplot.cpp.

◆ draw()

void QCPItemBracket::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractItem.

Definition at line 30115 of file qcustomplot.cpp.

◆ length()

double QCPItemBracket::length ( ) const

inline

Definition at line 6637 of file qcustomplot.h.

◆ mainPen()

QPen QCPItemBracket::mainPen ( ) const

protected

Definition at line 30208 of file qcustomplot.cpp.

◆ pen()

QPen QCPItemBracket::pen ( ) const

inline

Definition at line 6635 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemBracket::selectedPen ( ) const

inline

Definition at line 6636 of file qcustomplot.h.

◆ selectTest()

double QCPItemBracket::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 30075 of file qcustomplot.cpp.

◆ setLength()

void QCPItemBracket::setLength ( double length )

Sets the length in pixels how far the bracket extends in the direction towards the embraced span of the bracket (i.e. perpendicular to the left-right-direction)

Demonstrating the effect of different values for setLength, for styles bsCalligraphic and bsSquare. Anchors and positions are displayed for reference.

Definition at line 30059 of file qcustomplot.cpp.

◆ setPen()

void QCPItemBracket::setPen ( const QPen & pen )

Sets the pen that will be used to draw the bracket.

Note that when the style is bsCalligraphic, only the color will be taken from the pen, the stroke and width are ignored. To change the apparent stroke width of a calligraphic bracket, use setLength, which has a similar effect.

See also: setSelectedPen

Definition at line 30036 of file qcustomplot.cpp.

◆ setSelectedPen()

void QCPItemBracket::setSelectedPen ( const QPen & pen )

Sets the pen that will be used to draw the bracket when selected

See also: setPen, setSelected

Definition at line 30046 of file qcustomplot.cpp.

◆ setStyle()

void QCPItemBracket::setStyle ( QCPItemBracket::BracketStyle style )

Sets the style of the bracket, i.e. the shape/visual appearance.

See also: setPen

Definition at line 30069 of file qcustomplot.cpp.

◆ style()

BracketStyle QCPItemBracket::style ( ) const

inline

Definition at line 6638 of file qcustomplot.h.

Member Data Documentation

◆ center

QCPItemAnchor* const QCPItemBracket::center

Definition at line 6651 of file qcustomplot.h.

◆ left

QCPItemPosition* const QCPItemBracket::left

Definition at line 6649 of file qcustomplot.h.

◆ mLength

double QCPItemBracket::mLength

protected

Definition at line 6657 of file qcustomplot.h.

◆ mPen

QPen QCPItemBracket::mPen

protected

Definition at line 6656 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemBracket::mSelectedPen

protected

Definition at line 6656 of file qcustomplot.h.

◆ mStyle

BracketStyle QCPItemBracket::mStyle

protected

Definition at line 6658 of file qcustomplot.h.

◆ right

QCPItemPosition* const QCPItemBracket::right

Definition at line 6650 of file qcustomplot.h.

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

Public Types

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AnchorIndex

◆ BracketStyle

Constructor & Destructor Documentation

◆ QCPItemBracket()

◆ ~QCPItemBracket()

Member Function Documentation

◆ anchorPixelPosition()

◆ draw()

◆ length()

◆ mainPen()

◆ pen()

◆ selectedPen()

◆ selectTest()

◆ setLength()

◆ setPen()

◆ setSelectedPen()

◆ setStyle()

◆ style()

Member Data Documentation

◆ center

◆ left

◆ mLength

◆ mPen

◆ mSelectedPen

◆ mStyle

◆ right