QwtPlotTextLabel(3)

QwtPlotTextLabel(3) πŸ’…βœ¨

okay bestie, welcome to the Library Functions Manual page for QwtPlotTextLabel(3) β€” manual name folded in right here like a little name tag, no cap. 🫢

✨ NAME ✨

QwtPlotTextLabel β€” a plot item, which displays a text label. πŸ’–

πŸ¦‹ SYNOPSIS πŸ¦‹

#include <qwt_plot_textlabel.h>

Inherits QwtPlotItem β€” yes, she’s part of the plot-item family. 🌸

πŸ’– Public Member Functions πŸ’–

  • QwtPlotTextLabel () β€” Constructor.
  • virtual ~QwtPlotTextLabel () β€” Destructor.
  • virtual int rtti () const override
  • void setText (const QwtText &)
  • QwtText text () const
  • void setMargin (int margin)
  • int margin () const
  • virtual QRectF textRect (const QRectF &, const QSizeF &) const β€” Align the text label.

🌈 Public Member Functions inherited from QwtPlotItem 🌈

  • QwtPlotItem ()
  • QwtPlotItem (const QString &title)
  • QwtPlotItem (const QwtText &title)
  • virtual ~QwtPlotItem () β€” Destroy the QwtPlotItem.
  • void attach (QwtPlot *plot) β€” Attach the item to a plot.
  • void detach () β€” This method detaches a QwtPlotItem from any QwtPlot it has been associated with.
  • QwtPlot * plot () const β€” Return attached plot.
  • void setTitle (const QString &title)
  • void setTitle (const QwtText &title)
  • const QwtText & title () const
  • void setItemAttribute (ItemAttribute, bool on=true)
  • bool testItemAttribute (ItemAttribute) const
  • void setItemInterest (ItemInterest, bool on=true)
  • bool testItemInterest (ItemInterest) const
  • void setRenderHint (RenderHint, bool on=true)
  • bool testRenderHint (RenderHint) const
  • void setRenderThreadCount (uint numThreads)
  • uint renderThreadCount () const
  • void setLegendIconSize (const QSize &)
  • QSize legendIconSize () const
  • double z () const
  • void setZ (double z) β€” Set the z value.
  • void show () β€” Show the item.
  • void hide () β€” Hide the item.
  • virtual void setVisible (bool)
  • bool isVisible () const
  • void setAxes (QwtAxisId xAxis, QwtAxisId yAxis)
  • void setXAxis (QwtAxisId)
  • QwtAxisId xAxis () const β€” Return xAxis.
  • void setYAxis (QwtAxisId)
  • QwtAxisId yAxis () const β€” Return yAxis.
  • virtual void itemChanged ()
  • virtual void legendChanged ()
  • virtual QRectF boundingRect () const
  • virtual void getCanvasMarginHint (const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, double &left, double &top, double &right, double &bottom) const β€” Calculate a hint for the canvas margin.
  • virtual void updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &) β€” Update the item to changes of the axes scale division.
  • virtual void updateLegend (const QwtPlotItem *, const QList< QwtLegendData > &) β€” Update the item to changes of the legend info.
  • QRectF scaleRect (const QwtScaleMap &, const QwtScaleMap &) const β€” Calculate the bounding scale rectangle of 2 maps.
  • QRectF paintRect (const QwtScaleMap &, const QwtScaleMap &) const β€” Calculate the bounding paint rectangle of 2 maps.
  • virtual QList< QwtLegendData > legendData () const β€” Return all information, that is needed to represent the item on the legend.
  • virtual QwtGraphic legendIcon (int index, const QSizeF &) const

πŸŽ€ Protected Member Functions πŸŽ€

  • virtual void draw (QPainter *, const QwtScaleMap &, const QwtScaleMap &, const QRectF &) const override
  • void invalidateCache () β€” Invalidate all internal cache.

🧚 Protected Member Functions inherited from QwtPlotItem 🧚

  • QwtGraphic defaultIcon (const QBrush &, const QSizeF &) const β€” Return a default icon from a brush.

πŸ‘‘ Additional Inherited Members πŸ‘‘

πŸ’œ Public Types inherited from QwtPlotItem πŸ’œ

  • enum RttiValues { Rtti_PlotItem = 0, Rtti_PlotGrid, Rtti_PlotScale, Rtti_PlotLegend, Rtti_PlotMarker, Rtti_PlotCurve, Rtti_PlotSpectroCurve, Rtti_PlotIntervalCurve, Rtti_PlotHistogram, Rtti_PlotSpectrogram, Rtti_PlotGraphic, Rtti_PlotTradingCurve, Rtti_PlotBarChart, Rtti_PlotMultiBarChart, Rtti_PlotShape, Rtti_PlotTextLabel, Rtti_PlotZone, Rtti_PlotVectorField, Rtti_PlotUserItem = 1000 } β€” Runtime type information.
  • enum ItemAttribute { Legend = 0x01, AutoScale = 0x02, Margins = 0x04 } β€” Plot Item Attributes.
  • enum ItemInterest { ScaleInterest = 0x01, LegendInterest = 0x02 } β€” Plot Item Interests.
  • enum RenderHint { RenderAntialiased = 0x1 } β€” Render hints.
  • typedef QFlags< ItemAttribute > ItemAttributes
  • typedef QFlags< ItemInterest > ItemInterests
  • typedef QFlags< RenderHint > RenderHints

🌟 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( plot );

πŸ”₯ 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 82 of file qwt_plot_textlabel.cpp.

QwtPlotTextLabel::~QwtPlotTextLabel () [virtual]

Destructor.

Definition at line 94 of file qwt_plot_textlabel.cpp.

πŸ’€ Member Function Documentation πŸ’€

void QwtPlotTextLabel::draw (QPainter * painter, const QwtScaleMap & xMap, const QwtScaleMap & yMap, const QRectF & canvasRect) const [override], [protected], [virtual]

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 176 of file qwt_plot_textlabel.cpp.

void QwtPlotTextLabel::invalidateCache () [protected]

Invalidate all internal cache.

Definition at line 270 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 160 of file qwt_plot_textlabel.cpp.

int QwtPlotTextLabel::rtti () const [override], [virtual]

Returns QwtPlotItem::Rtti_PlotTextLabel.

Reimplemented from QwtPlotItem.

Definition at line 100 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 146 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 115 of file qwt_plot_textlabel.cpp.

QwtText QwtPlotTextLabel::text () const

Returns Text to be displayed.

See also setText().

Definition at line 130 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 263 of file qwt_plot_textlabel.cpp.

πŸ™ˆ Author πŸ™ˆ

Generated automatically by Doxygen for Qwt User's Guide from the source code.


xoxo, bestie β€” the footer situation is Qwt User's Guide + QwtPlotTextLabel(3), and there’s no date printed on this page, so I’m not inventing one. πŸ’–πŸ«Ά

πŸ“¦ where this page comes from