A plot item, which displays a text label. More...

#include <qwt_plot_textlabel.h>

Inheritance diagram for QwtPlotTextLabel:

Classes
class	PrivateData

Public Member Functions
int	margin () const

	QwtPlotTextLabel ()
	Constructor. More...

virtual int	rtti () const

void	setMargin (int margin)

void	setText (const QwtText &)

QwtText	text () const

virtual QRectF	textRect (const QRectF &, const QSizeF &) const
	Align the text label. More...

virtual	~QwtPlotTextLabel ()
	Destructor. More...

Public Member Functions inherited from QwtPlotItem
void	attach (QwtPlot *plot)
	Attach the item to a plot. More...

virtual QRectF	boundingRect () const

void	detach ()
	This method detaches a QwtPlotItem from any QwtPlot it has been associated with. More...

virtual void	getCanvasMarginHint (const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasSize, double &left, double &top, double &right, double &bottom) const
	Calculate a hint for the canvas margin. More...

void	hide ()
	Hide the item. More...

bool	isVisible () const

virtual void	itemChanged ()

virtual void	legendChanged ()

virtual QList< QwtLegendData >	legendData () const
	Return all information, that is needed to represent the item on the legend. More...

virtual QwtGraphic	legendIcon (int index, const QSizeF &) const

QSize	legendIconSize () const

QRectF	paintRect (const QwtScaleMap &, const QwtScaleMap &) const
	Calculate the bounding paint rectangle of 2 maps. More...

QwtPlot *	plot () const
	Return attached plot. More...

	QwtPlotItem (const QwtText &title=QwtText())

uint	renderThreadCount () const

QRectF	scaleRect (const QwtScaleMap &, const QwtScaleMap &) const
	Calculate the bounding scale rectangle of 2 maps. More...

void	setAxes (int xAxis, int yAxis)

void	setItemAttribute (ItemAttribute, bool on=true)

void	setItemInterest (ItemInterest, bool on=true)

void	setLegendIconSize (const QSize &)

void	setRenderHint (RenderHint, bool on=true)

void	setRenderThreadCount (uint numThreads)

void	setTitle (const QString &title)

void	setTitle (const QwtText &title)

virtual void	setVisible (bool)

void	setXAxis (int axis)

void	setYAxis (int axis)

void	setZ (double z)
	Set the z value. More...

void	show ()
	Show the item. More...

bool	testItemAttribute (ItemAttribute) const

bool	testItemInterest (ItemInterest) const

bool	testRenderHint (RenderHint) const

const QwtText &	title () const

virtual void	updateLegend (const QwtPlotItem *, const QList< QwtLegendData > &)
	Update the item to changes of the legend info. More...

virtual void	updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &)
	Update the item to changes of the axes scale division. More...

int	xAxis () const
	Return xAxis. More...

int	yAxis () const
	Return yAxis. More...

double	z () const

virtual	~QwtPlotItem ()
	Destroy the QwtPlotItem. More...

Protected Member Functions
virtual void	draw (QPainter *, const QwtScaleMap &, const QwtScaleMap &, const QRectF &) const

void	invalidateCache ()
	Invalidate all internal cache. More...

Protected Member Functions inherited from QwtPlotItem
QwtGraphic	defaultIcon (const QBrush &, const QSizeF &) const
	Return a default icon from a brush. More...

Private Attributes
PrivateData *	d_data

Additional Inherited Members
Public Types inherited from QwtPlotItem
enum	ItemAttribute { Legend = 0x01, AutoScale = 0x02, Margins = 0x04 }
	Plot Item Attributes. More...

typedef QFlags< ItemAttribute >	ItemAttributes
	Plot Item Attributes. More...

enum	ItemInterest { ScaleInterest = 0x01, LegendInterest = 0x02 }
	Plot Item Interests. More...

typedef QFlags< ItemInterest >	ItemInterests
	Plot Item Interests. More...

enum	RenderHint { RenderAntialiased = 0x1 }
	Render hints. More...

typedef QFlags< RenderHint >	RenderHints
	Render hints. More...

enum	RttiValues { Rtti_PlotItem = 0, Rtti_PlotGrid, Rtti_PlotScale, Rtti_PlotLegend, Rtti_PlotMarker, Rtti_PlotCurve, Rtti_PlotSpectroCurve, Rtti_PlotIntervalCurve, Rtti_PlotHistogram, Rtti_PlotSpectrogram, Rtti_PlotSVG, Rtti_PlotTradingCurve, Rtti_PlotBarChart, Rtti_PlotMultiBarChart, Rtti_PlotShape, Rtti_PlotTextLabel, Rtti_PlotZone, Rtti_PlotUserItem = 1000 }
	Runtime type information. More...

Detailed Description

A plot item, which displays a text label.

QwtPlotTextLabel displays a text label aligned to the plot canvas.

In opposite to QwtPlotMarker the position of the label is unrelated to plot coordinates.

As drawing a text is an expensive operation the label is cached in a pixmap to speed up replots.

Example: The following code shows how to add a title.

    QwtText title( "Plot Title" );
    title.setRenderFlags( Qt::AlignHCenter | Qt::AlignTop );

    QFont font;
    font.setBold( true );
    title.setFont( font );

    QwtPlotTextLabel *titleItem = new QwtPlotTextLabel();
    titleItem->setText( title );
    titleItem->attach( this );

See also: QwtPlotMarker

Definition at line 47 of file qwt_plot_textlabel.h.

Constructor & Destructor Documentation

QwtPlotTextLabel::QwtPlotTextLabel ( )

Constructor.

Initializes an text label with an empty text

Sets the following item attributes:

QwtPlotItem::AutoScale: true
QwtPlotItem::Legend: false

The z value is initialized by 150

See also: QwtPlotItem::setItemAttribute(), QwtPlotItem::setZ()

Definition at line 80 of file qwt_plot_textlabel.cpp.

QwtPlotTextLabel::~QwtPlotTextLabel ( )

virtual

Destructor.

Definition at line 92 of file qwt_plot_textlabel.cpp.

Member Function Documentation

void QwtPlotTextLabel::draw	(	QPainter *	painter,
		const QwtScaleMap &	xMap,
		const QwtScaleMap &	yMap,
		const QRectF &	canvasRect
	)		const

protectedvirtual

Draw the text label

Parameters

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

See also: textRect()

Implements QwtPlotItem.

Definition at line 174 of file qwt_plot_textlabel.cpp.

void QwtPlotTextLabel::invalidateCache ( )

protected

Invalidate all internal cache.

Definition at line 268 of file qwt_plot_textlabel.cpp.

int QwtPlotTextLabel::margin ( ) const

Returns: Margin added to the contentsMargins() of the canvas

See also: setMargin()

Definition at line 158 of file qwt_plot_textlabel.cpp.

int QwtPlotTextLabel::rtti ( ) const

virtual

Returns: QwtPlotItem::Rtti_PlotTextLabel

Reimplemented from QwtPlotItem.

Definition at line 98 of file qwt_plot_textlabel.cpp.

void QwtPlotTextLabel::setMargin ( int margin )

Set the margin

The margin is the distance between the contentsRect() of the plot canvas and the rectangle where the label can be displayed.

Parameters

margin Margin

See also: margin(), textRect()

Definition at line 144 of file qwt_plot_textlabel.cpp.

void QwtPlotTextLabel::setText ( const QwtText & text )

Set the text

The label will be aligned to the plot canvas according to the alignment flags of text.

Parameters

text	Text to be displayed

See also: text(), QwtText::renderFlags()

Definition at line 113 of file qwt_plot_textlabel.cpp.

QwtText QwtPlotTextLabel::text ( ) const

Returns: Text to be displayed

See also: setText()

Definition at line 128 of file qwt_plot_textlabel.cpp.

QRectF QwtPlotTextLabel::textRect	(	const QRectF &	rect,
		const QSizeF &	textSize
	)		const

virtual

Align the text label.

Parameters

rect	Canvas rectangle with margins subtracted
textSize	Size required to draw the text

Returns: A rectangle aligned according the the alignment flags of the text.

See also: setMargin(), QwtText::renderFlags(), QwtText::textSize()

Definition at line 261 of file qwt_plot_textlabel.cpp.

Member Data Documentation

PrivateData* QwtPlotTextLabel::d_data

private

Definition at line 71 of file qwt_plot_textlabel.h.

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

Classes

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation