Controls how a plottable's data selection is drawn. More...

#include <qcustomplot.h>

Inheritance diagram for QCPSelectionDecorator:

Collaboration diagram for QCPSelectionDecorator:

[legend]

Public Member Functions
	QCPSelectionDecorator ()

virtual	~QCPSelectionDecorator ()

QPen	pen () const

QBrush	brush () const

QCPScatterStyle	scatterStyle () const

QCPScatterStyle::ScatterProperties	usedScatterProperties () const

void	setPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setScatterStyle (const QCPScatterStyle &scatterStyle, QCPScatterStyle::ScatterProperties usedProperties=QCPScatterStyle::spPen)

void	setUsedScatterProperties (const QCPScatterStyle::ScatterProperties &properties)

void	applyPen (QCPPainter *painter) const

void	applyBrush (QCPPainter *painter) const

QCPScatterStyle	getFinalScatterStyle (const QCPScatterStyle &unselectedStyle) const

virtual void	copyFrom (const QCPSelectionDecorator *other)

virtual void	drawDecoration (QCPPainter *painter, QCPDataSelection selection)

Protected Member Functions
virtual bool	registerWithPlottable (QCPAbstractPlottable *plottable)

Protected Attributes
QPen	mPen

QBrush	mBrush

QCPScatterStyle	mScatterStyle

QCPScatterStyle::ScatterProperties	mUsedScatterProperties

QCPAbstractPlottable *	mPlottable

Friends
class	QCPAbstractPlottable

Detailed Description

Controls how a plottable's data selection is drawn.

Each QCPAbstractPlottable instance has one QCPSelectionDecorator (accessible via QCPAbstractPlottable::selectionDecorator) and uses it when drawing selected segments of its data.

The selection decorator controls both pen (setPen) and brush (setBrush), as well as the scatter style (setScatterStyle) if the plottable draws scatters. Since a QCPScatterStyle is itself composed of different properties such as color shape and size, the decorator allows specifying exactly which of those properties shall be used for the selected data point, via setUsedScatterProperties.

A QCPSelectionDecorator subclass instance can be passed to a plottable via QCPAbstractPlottable::setSelectionDecorator, allowing greater customizability of the appearance of selected segments.

Use copyFrom to easily transfer the settings of one decorator to another one. This is especially useful since plottables take ownership of the passed selection decorator, and thus the same decorator instance can not be passed to multiple plottables.

Selection decorators can also themselves perform drawing operations by reimplementing drawDecoration, which is called by the plottable's draw method. The base class QCPSelectionDecorator does not make use of this however. For example, QCPSelectionDecoratorBracket draws brackets around selected data segments.

Definition at line 3209 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPSelectionDecorator::QCPSelectionDecorator ( )

Creates a new QCPSelectionDecorator instance with default values

Definition at line 10077 of file qcustomplot.cpp.

QCPSelectionDecorator::~QCPSelectionDecorator ( )

virtual

Definition at line 10086 of file qcustomplot.cpp.

Member Function Documentation

void QCPSelectionDecorator::applyBrush ( QCPPainter * painter ) const

Sets the brush of painter to the brush of this selection decorator.

See also: applyPen, getFinalScatterStyle

Definition at line 10144 of file qcustomplot.cpp.

void QCPSelectionDecorator::applyPen ( QCPPainter * painter ) const

Sets the pen of painter to the pen of this selection decorator.

See also: applyBrush, getFinalScatterStyle

Definition at line 10134 of file qcustomplot.cpp.

QBrush QCPSelectionDecorator::brush ( ) const

inline

Definition at line 3218 of file qcustomplot.h.

void QCPSelectionDecorator::copyFrom ( const QCPSelectionDecorator * other )

virtual

Copies all properties (e.g. color, fill, scatter style) of the other selection decorator to this selection decorator.

Definition at line 10175 of file qcustomplot.cpp.

void QCPSelectionDecorator::drawDecoration	(	QCPPainter *	painter,
		QCPDataSelection	selection
	)

virtual

This method is called by all plottables' draw methods to allow custom selection decorations to be drawn. Use the passed painter to perform the drawing operations. selection carries the data selection for which the decoration shall be drawn.

The default base class implementation of QCPSelectionDecorator has no special decoration, so this method does nothing.

Reimplemented in QCPSelectionDecoratorBracket.

Definition at line 10190 of file qcustomplot.cpp.

QCPScatterStyle QCPSelectionDecorator::getFinalScatterStyle ( const QCPScatterStyle & unselectedStyle ) const

Returns the scatter style that the parent plottable shall use for selected scatter points. The plottable's original (unselected) scatter style must be passed as unselectedStyle. Depending on the setting of setUsedScatterProperties, the returned scatter style is a mixture of this selecion decorator's scatter style (setScatterStyle), and unselectedStyle.

See also: applyPen, applyBrush, setScatterStyle

Definition at line 10157 of file qcustomplot.cpp.

QPen QCPSelectionDecorator::pen ( ) const

inline

Definition at line 3217 of file qcustomplot.h.

bool QCPSelectionDecorator::registerWithPlottable ( QCPAbstractPlottable * plottable )

protectedvirtual

Definition at line 10205 of file qcustomplot.cpp.

QCPScatterStyle QCPSelectionDecorator::scatterStyle ( ) const

inline

Definition at line 3219 of file qcustomplot.h.

void QCPSelectionDecorator::setBrush ( const QBrush & brush )

Sets the brush that will be used by the parent plottable to draw selected data segments.

Definition at line 10101 of file qcustomplot.cpp.

void QCPSelectionDecorator::setPen ( const QPen & pen )

Sets the pen that will be used by the parent plottable to draw selected data segments.

Definition at line 10093 of file qcustomplot.cpp.

void QCPSelectionDecorator::setScatterStyle	(	const QCPScatterStyle &	scatterStyle,
		QCPScatterStyle::ScatterProperties	usedProperties = `QCPScatterStyle::spPen`
	)

Sets the scatter style that will be used by the parent plottable to draw scatters in selected data segments.

usedProperties specifies which parts of the passed scatterStyle will be used by the plottable. The used properties can also be changed via setUsedScatterProperties.

Definition at line 10113 of file qcustomplot.cpp.

void QCPSelectionDecorator::setUsedScatterProperties ( const QCPScatterStyle::ScatterProperties & properties )

Use this method to define which properties of the scatter style (set via setScatterStyle) will be used for selected data segments. All properties of the scatter style that are not specified in properties will remain as specified in the plottable's original scatter style.

Definition at line 10124 of file qcustomplot.cpp.

QCPScatterStyle::ScatterProperties QCPSelectionDecorator::usedScatterProperties ( ) const

inline

Definition at line 3220 of file qcustomplot.h.

Friends And Related Function Documentation

friend class QCPAbstractPlottable

friend

Definition at line 3251 of file qcustomplot.h.

Member Data Documentation

QBrush QCPSelectionDecorator::mBrush

protected

Definition at line 3240 of file qcustomplot.h.

QPen QCPSelectionDecorator::mPen

protected

Definition at line 3239 of file qcustomplot.h.

QCPAbstractPlottable* QCPSelectionDecorator::mPlottable

protected

Definition at line 3244 of file qcustomplot.h.

QCPScatterStyle QCPSelectionDecorator::mScatterStyle

protected

Definition at line 3241 of file qcustomplot.h.

QCPScatterStyle::ScatterProperties QCPSelectionDecorator::mUsedScatterProperties

protected

Definition at line 3242 of file qcustomplot.h.

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

Workflow/GRAPHICS/qcustomplot.h
Workflow/GRAPHICS/qcustomplot.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation