A class for drawing markers. More...

#include <qwt_plot_marker.h>

Inheritance diagram for QwtPlotMarker:

Classes
class	PrivateData
Public Types
enum	LineStyle { NoLine, HLine, VLine, Cross }
Public Member Functions
virtual QRectF	boundingRect () const
virtual void	draw (QPainter *, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &) const
QwtText	label () const
Qt::Alignment	labelAlignment () const
Qt::Orientation	labelOrientation () const
virtual QwtGraphic	legendIcon (int index, const QSizeF &) const
const QPen &	linePen () const
LineStyle	lineStyle () const
	QwtPlotMarker (const QString &title=QString::null)
	Sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.
	QwtPlotMarker (const QwtText &title)
	Sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.
virtual int	rtti () const
void	setLabel (const QwtText &)
	Set the label.
void	setLabelAlignment (Qt::Alignment)
	Set the alignment of the label.
void	setLabelOrientation (Qt::Orientation)
	Set the orientation of the label.
void	setLinePen (const QColor &, qreal width=0.0, Qt::PenStyle=Qt::SolidLine)
void	setLinePen (const QPen &p)
void	setLineStyle (LineStyle st)
	Set the line style.
void	setSpacing (int)
	Set the spacing.
void	setSymbol (const QwtSymbol *)
	Assign a symbol.
void	setValue (double, double)
	Set Value.
void	setValue (const QPointF &)
	Set Value.
void	setXValue (double)
	Set X Value.
void	setYValue (double)
	Set Y Value.
int	spacing () const
const QwtSymbol *	symbol () const
QPointF	value () const
	Return Value.
double	xValue () const
	Return x Value.
double	yValue () const
	Return y Value.
virtual	~QwtPlotMarker ()
	Destructor.
Protected Member Functions
virtual void	drawLabel (QPainter *, const QRectF &, const QPointF &) const
virtual void	drawLines (QPainter *, const QRectF &, const QPointF &) const
virtual void	drawSymbol (QPainter *, const QRectF &, const QPointF &) const
Private Attributes
PrivateData *	d_data

Detailed Description

A class for drawing markers.

A marker can be a horizontal line, a vertical line, a symbol, a label or any combination of them, which can be drawn around a center point inside a bounding rectangle.

The setSymbol() member assigns a symbol to the marker. The symbol is drawn at the specified point.

With setLabel(), a label can be assigned to the marker. The setLabelAlignment() member specifies where the label is drawn. All the Align*-constants in Qt::AlignmentFlags (see Qt documentation) are valid. The interpretation of the alignment depends on the marker's line style. The alignment refers to the center point of the marker, which means, for example, that the label would be printed left above the center point if the alignment was set to Qt::AlignLeft | Qt::AlignTop.

Note:: QwtPlotTextLabel is intended to align a text label according to the geometry of canvas ( unrelated to plot coordinates )

Definition at line 48 of file qwt_plot_marker.h.

Member Enumeration Documentation

enum QwtPlotMarker::LineStyle

Line styles.

See also:: setLineStyle(), lineStyle()

Enumerator:

NoLine	No line.
HLine	A horizontal line.
VLine	A vertical line.
Cross	A crosshair.

Definition at line 56 of file qwt_plot_marker.h.

Constructor & Destructor Documentation

QwtPlotMarker::QwtPlotMarker ( const QString & title = QString::null ) [explicit]

Sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.

Definition at line 51 of file qwt_plot_marker.cpp.

QwtPlotMarker::QwtPlotMarker ( const QwtText & title ) [explicit]

Sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.

Definition at line 59 of file qwt_plot_marker.cpp.

QwtPlotMarker::~QwtPlotMarker ( ) [virtual]

Destructor.

Definition at line 67 of file qwt_plot_marker.cpp.

Member Function Documentation

QRectF QwtPlotMarker::boundingRect ( ) const [virtual]

Returns:: An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note:: A width or height < 0.0 is ignored by the autoscaler

Reimplemented from QwtPlotItem.

Definition at line 563 of file qwt_plot_marker.cpp.

void QwtPlotMarker::draw	(	QPainter *	painter,
		const QwtScaleMap &	xMap,
		const QwtScaleMap &	yMap,
		const QRectF &	canvasRect
	)		const `[virtual]`

Draw the marker

Parameters:

painter	Painter
xMap	x Scale Map
yMap	y Scale Map
canvasRect	Contents rectangle of the canvas in painter coordinates

Implements QwtPlotItem.

Definition at line 133 of file qwt_plot_marker.cpp.

void QwtPlotMarker::drawLabel	(	QPainter *	painter,
		const QRectF &	canvasRect,
		const QPointF &	pos
	)		const `[protected, virtual]`

Align and draw the text label of the marker

Parameters:

painter	Painter
canvasRect	Contents rectangle of the canvas in painter coordinates
pos	Position of the marker, translated into widget coordinates

See also:: drawLabel(), drawSymbol()

Definition at line 223 of file qwt_plot_marker.cpp.

void QwtPlotMarker::drawLines	(	QPainter *	painter,
		const QRectF &	canvasRect,
		const QPointF &	pos
	)		const `[protected, virtual]`

Draw the lines marker

Parameters:

painter	Painter
canvasRect	Contents rectangle of the canvas in painter coordinates
pos	Position of the marker, translated into widget coordinates

See also:: drawLabel(), drawSymbol()

Definition at line 154 of file qwt_plot_marker.cpp.

void QwtPlotMarker::drawSymbol	(	QPainter *	painter,
		const QRectF &	canvasRect,
		const QPointF &	pos
	)		const `[protected, virtual]`

Draw the symbol of the marker

Parameters:

painter	Painter
canvasRect	Contents rectangle of the canvas in painter coordinates
pos	Position of the marker, translated into widget coordinates

See also:: drawLabel(), QwtSymbol::drawSymbol()

Definition at line 194 of file qwt_plot_marker.cpp.

QwtText QwtPlotMarker::label ( ) const

Returns:: the label

See also:: setLabel()

Definition at line 424 of file qwt_plot_marker.cpp.

Qt::Alignment QwtPlotMarker::labelAlignment ( ) const

Returns:: the label alignment

See also:: setLabelAlignment(), setLabelOrientation()

Definition at line 456 of file qwt_plot_marker.cpp.

Qt::Orientation QwtPlotMarker::labelOrientation ( ) const

Returns:: the label orientation

See also:: setLabelOrientation(), labelAlignment()

Definition at line 484 of file qwt_plot_marker.cpp.

QwtGraphic QwtPlotMarker::legendIcon	(	int	index,
		const QSizeF &	size
	)		const `[virtual]`

Returns:: Icon representing the marker on the legend

Parameters:

index	Index of the legend entry ( usually there is only one )
size	Icon size

See also:: setLegendIconSize(), legendData()

Reimplemented from QwtPlotItem.

Definition at line 577 of file qwt_plot_marker.cpp.

const QPen & QwtPlotMarker::linePen ( ) const

Returns:: the line pen

See also:: setLinePen()

Definition at line 558 of file qwt_plot_marker.cpp.

QwtPlotMarker::LineStyle QwtPlotMarker::lineStyle ( ) const

Returns:: the line style

See also:: setLineStyle()

Definition at line 372 of file qwt_plot_marker.cpp.

int QwtPlotMarker::rtti ( ) const [virtual]

Returns:: QwtPlotItem::Rtti_PlotMarker

Reimplemented from QwtPlotItem.

Definition at line 73 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setLabel ( const QwtText & label )

Set the label.

Parameters:

label Label text

See also:: label()

Definition at line 411 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setLabelAlignment ( Qt::Alignment align )

Set the alignment of the label.

In case of QwtPlotMarker::HLine the alignment is relative to the y position of the marker, but the horizontal flags correspond to the canvas rectangle. In case of QwtPlotMarker::VLine the alignment is relative to the x position of the marker, but the vertical flags correspond to the canvas rectangle.

In all other styles the alignment is relative to the marker's position.

Parameters:

align Alignment.

See also:: labelAlignment(), labelOrientation()

Definition at line 443 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setLabelOrientation ( Qt::Orientation orientation )

Set the orientation of the label.

When orientation is Qt::Vertical the label is rotated by 90.0 degrees ( from bottom to top ).

Parameters:

orientation Orientation of the label

See also:: labelOrientation(), setLabelAlignment()

Definition at line 471 of file qwt_plot_marker.cpp.

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

Build and assign a line pen

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

Parameters:

color	Pen color
width	Pen width
style	Pen style

See also:: pen(), brush()

Definition at line 532 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setLinePen ( const QPen & pen )

Specify a pen for the line.

Parameters:

pen New pen

See also:: linePen()

Definition at line 543 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setLineStyle ( LineStyle style )

Set the line style.

Parameters:

style Line style.

See also:: lineStyle()

Definition at line 357 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setSpacing ( int spacing )

Set the spacing.

When the label is not centered on the marker position, the spacing is the distance between the position and the label.

Parameters:

spacing Spacing

See also:: spacing(), setLabelAlignment()

Definition at line 498 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setSymbol ( const QwtSymbol * symbol )

Assign a symbol.

Parameters:

symbol New symbol

See also:: symbol()

Definition at line 382 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setValue	(	double	x,
		double	y
	)

Set Value.

Definition at line 103 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setValue ( const QPointF & pos )

Set Value.

Definition at line 97 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setXValue ( double x )

Set X Value.

Definition at line 114 of file qwt_plot_marker.cpp.

void QwtPlotMarker::setYValue ( double y )

Set Y Value.

Definition at line 120 of file qwt_plot_marker.cpp.

int QwtPlotMarker::spacing ( ) const

Returns:: the spacing

See also:: setSpacing()

Definition at line 514 of file qwt_plot_marker.cpp.

const QwtSymbol * QwtPlotMarker::symbol ( ) const

Returns:: the symbol

See also:: setSymbol(), QwtSymbol

Definition at line 401 of file qwt_plot_marker.cpp.

QPointF QwtPlotMarker::value ( ) const

Return Value.

Definition at line 79 of file qwt_plot_marker.cpp.

double QwtPlotMarker::xValue ( ) const

Return x Value.

Definition at line 85 of file qwt_plot_marker.cpp.

double QwtPlotMarker::yValue ( ) const

Return y Value.

Definition at line 91 of file qwt_plot_marker.cpp.

Member Data Documentation

PrivateData* QwtPlotMarker::d_data [private]

Reimplemented from QwtPlotItem.

Definition at line 129 of file qwt_plot_marker.h.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation