Classes | Public Member Functions | Protected Member Functions | Private Attributes
QwtPlotTextLabel Class Reference

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

#include <qwt_plot_textlabel.h>

Inheritance diagram for QwtPlotTextLabel:
Inheritance graph
[legend]

List of all members.

Classes

class  PrivateData

Public Member Functions

int margin () const
 QwtPlotTextLabel ()
 Constructor.
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.
virtual ~QwtPlotTextLabel ()
 Destructor.

Protected Member Functions

virtual void draw (QPainter *, const QwtScaleMap &, const QwtScaleMap &, const QRectF &) const
void invalidateCache ()
 Invalidate all internal cache.

Private Attributes

PrivateDatad_data

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

Constructor.

Initializes an text label with an empty text

Sets the following item attributes:

The z value is initialized by 150

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

Definition at line 80 of file qwt_plot_textlabel.cpp.

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 [protected, virtual]

Draw the text label

Parameters:
painterPainter
xMapx Scale Map
yMapy Scale Map
canvasRectContents 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:
marginMargin
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:
textText to be displayed
See also:
text(), QwtText::renderFlags()

Definition at line 113 of file qwt_plot_textlabel.cpp.

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:
rectCanvas rectangle with margins subtracted
textSizeSize 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

Reimplemented from QwtPlotItem.

Definition at line 71 of file qwt_plot_textlabel.h.


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


plotjuggler
Author(s): Davide Faconti
autogenerated on Fri Sep 1 2017 02:41:58