QwtText(3)

📦
version 6.3.0 · 6 versions
, in alpine 3.24

🎀 NAME 🎀

okay bestie, welcome to QwtText(3) from the Library Functions Manual 💖

QwtText — a class representing a text. That’s the name section, and it’s honestly iconic.

✨ SYNOPSIS ✨

#include <qwt_text.h>

🌈 Public Types 🌈

  • enum TextFormat { AutoText = 0, PlainText, RichText, MathMLText, TeXText, OtherFormat = 100 } — Text format.
  • enum PaintAttribute { PaintUsingTextFont = 0x01, PaintUsingTextColor = 0x02, PaintBackground = 0x04 } — Paint Attributes.
  • enum LayoutAttribute { MinimumLayout = 0x01 } — Layout Attributes. These affect some aspects of the layout of the text.
  • typedef QFlags< PaintAttribute > PaintAttributes
  • typedef QFlags< LayoutAttribute > LayoutAttributes

💅 Public Member Functions 💅

  • QwtText ()
  • QwtText (const QString &, TextFormat textFormat=AutoText)
  • QwtText (const QwtText &) — Copy constructor.
  • ~QwtText () — Destructor.
  • QwtText & operator= (const QwtText &) — Assignment operator.
  • bool operator== (const QwtText &) const — Relational operator.
  • bool operator!= (const QwtText &) const — Relational operator.
  • void setText (const QString &, QwtText::TextFormat textFormat=AutoText)
  • QString text () const
  • bool isNull () const
  • bool isEmpty () const
  • void setFont (const QFont &)
  • QFont font () const — Return the font.
  • QFont usedFont (const QFont &) const
  • void setRenderFlags (int) — Change the render flags.
  • int renderFlags () const
  • void setColor (const QColor &)
  • QColor color () const — Return the pen color, used for painting the text.
  • QColor usedColor (const QColor &) const
  • void setBorderRadius (double)
  • double borderRadius () const
  • void setBorderPen (const QPen &)
  • QPen borderPen () const
  • void setBackgroundBrush (const QBrush &)
  • QBrush backgroundBrush () const
  • void setPaintAttribute (PaintAttribute, bool on=true)
  • bool testPaintAttribute (PaintAttribute) const
  • void setLayoutAttribute (LayoutAttribute, bool on=true)
  • bool testLayoutAttribute (LayoutAttribute) const
  • double heightForWidth (double width) const
  • double heightForWidth (double width, const QFont &) const
  • QSizeF textSize () const
  • QSizeF textSize (const QFont &) const
  • void draw (QPainter *painter, const QRectF &rect) const

🦋 Static Public Member Functions 🦋

  • static const QwtTextEngine * textEngine (const QString &text, QwtText::TextFormat=AutoText)
  • static const QwtTextEngine * textEngine (QwtText::TextFormat) — Find the text engine for a text format.
  • static void setTextEngine (QwtText::TextFormat, QwtTextEngine *)

💖 Detailed Description 💖

A QwtText is literally a text plus the set of attributes that say how to render it.

  • Format — A text might include control sequences (for example tags) describing how to render it. Each format (for example MathML, TeX, Qt Rich Text) has its own set of control sequences, which a special QwtTextEngine for that format can handle.
  • Background — A text might have a background, defined by a QPen and QBrush to improve its visibility. The corners of the background might be rounded.
  • Font — A text might have an individual font.
  • Color — A text might have an individual color.
  • Render Flags — Flags from Qt::AlignmentFlag and Qt::TextFlag used like in QPainter::drawText().
See also: QwtTextEngine, QwtTextLabel

Definition at line 51 of file qwt_text.h.

🧵 Member Typedef Documentation 🧵

  • typedef QFlags<LayoutAttribute > QwtText::LayoutAttributes — an ORed combination of LayoutAttribute values. Definition at line 143 of file qwt_text.h.
  • typedef QFlags<PaintAttribute > QwtText::PaintAttributes — an ORed combination of PaintAttribute values. Definition at line 126 of file qwt_text.h.

🔮 Member Enumeration Documentation 🔮

enum QwtText::LayoutAttribute

Layout Attributes. These affect some aspects of the layout of the text.

Enumerator

  • MinimumLayout — Layout the text without its margins. This mode is useful if a text needs to be aligned accurately, like the tick labels of a scale. If QwtTextEngine::textMargins is not implemented for the format of the text, MinimumLayout has no effect.

Definition at line 132 of file qwt_text.h.

enum QwtText::PaintAttribute

Paint Attributes. Font, color, and background are optional attributes of a QwtText. The paint attributes hold the information about whether they’re set.

Enumerator

  • PaintUsingTextFont — The text has an individual font.
  • PaintUsingTextColor — The text has an individual color.
  • PaintBackground — The text has an individual background.

Definition at line 114 of file qwt_text.h.

enum QwtText::TextFormat

Text format. The text format defines the QwtTextEngine that is used to render the text.

See also: QwtTextEngine, setTextEngine()

Enumerator

  • AutoText — The text format is determined using QwtTextEngine::mightRender() for all available text engines in increasing order > PlainText. If none of the text engines can render the text, it is rendered like QwtText::PlainText.
  • PlainText — Draw the text as it is, using a QwtPlainTextEngine.
  • RichText — Use the Scribe framework (Qt Rich Text) to render the text.
  • MathMLText — Use a MathML (http://en.wikipedia.org/wiki/MathML) render engine to display the text. In earlier versions of Qwt such an engine was included — since Qwt 6.2 it can be found here: https://github.com/uwerat/qwt-mml-dev

To enable MathML support the following code needs to be added to the application: QwtText::setTextEngine( QwtText::MathMLText, new QwtMathMLTextEngine() );

  • TeXText — Use a TeX (http://en.wikipedia.org/wiki/TeX) render engine to display the text ( not implemented yet ).
  • OtherFormat — The number of text formats can be extended using setTextEngine. Formats >= QwtText::OtherFormat are not used by Qwt.

Definition at line 64 of file qwt_text.h.

🛠️ Constructor & Destructor Documentation 🛠️

QwtText::QwtText ()

Constructor.

Definition at line 201 of file qwt_text.cpp.

QwtText::QwtText (const QString & text, QwtText::TextFormat textFormat = AutoText)

Constructor.

Parameters

  • text — Text content
  • textFormat — Text format

Definition at line 215 of file qwt_text.cpp.

QwtText::QwtText (const QwtText & other)

Copy constructor.

Definition at line 225 of file qwt_text.cpp.

QwtText::~QwtText ()

Destructor.

Definition at line 235 of file qwt_text.cpp.

🎀 Member Function Documentation 🎀

okay bestie, every single function is getting its moment now — no skips, no “we’ll come back to it,” periodt. 💅

🌸 QBrush QwtText::backgroundBrush () const

This one hands you the background brush, no cap.

Returns: background brush.

See also: setBackgroundBrush(), borderPen().

Definition at line 451 of file qwt_text.cpp.

🌸 QPen QwtText::borderPen () const

Gives you the background pen — yes, that’s literally what it returns.

Returns: background pen.

See also: setBorderPen(), backgroundBrush().

Definition at line 430 of file qwt_text.cpp.

🌸 double QwtText::borderRadius () const

Returns the radius for the corners of the border frame. Cute little rounded-corner situation 💅

Returns: radius for the corners of the border frame.

See also: setBorderRadius(), borderPen(), backgroundBrush().

Definition at line 409 of file qwt_text.cpp.

🌸 QColor QwtText::color () const

Returns the pen color used for painting the text. color moment 🎨

Returns: the pen color, used for painting the text.

Definition at line 372 of file qwt_text.cpp.

🌸 void QwtText::draw (QPainter * painter, const QRectF & rect) const

Draws a text into a rectangle. Main-character drawing behavior ✨

Parameters:

  • painter — painter.
  • rect — rectangle.

Definition at line 615 of file qwt_text.cpp.

🌸 QFont QwtText::font () const

Returns the font. font reveal 🫶

Returns: the font.

Definition at line 336 of file qwt_text.cpp.

🌸 double QwtText::heightForWidth (double width) const

Finds the height for a given width. It’s giving “math but make it useful” 😭

Parameters:

  • width — width.

Returns: calculated height.

Definition at line 522 of file qwt_text.cpp.

🌸 double QwtText::heightForWidth (double width, const QFont & defaultFont) const

Same height-for-width situation, but with a fallback font in the mix.

Parameters:

  • defaultFont — font used for the calculation if the text has no font.
  • width — width.

Returns: calculated height.

Definition at line 535 of file qwt_text.cpp.

🌸 bool QwtText::isEmpty () const

Literally returns text().isEmpty(). The emptiness check is delegated, and it ate 💅

Returns: text().isEmpty().

Definition at line 739 of file qwt_text.cpp.

🌸 bool QwtText::isNull () const

Returns text().isNull(). Null check, but make it text-coded.

Returns: text().isNull().

Definition at line 733 of file qwt_text.cpp.

🌸 bool QwtText::operator!= (const QwtText & other) const

Relational operator. The “are these two not matching?” vibe check between texts.

Returns: relational operator result.

Definition at line 264 of file qwt_text.cpp.

🌸 QwtText & QwtText::operator= (const QwtText & other)

Assignment operator. Copies the assignment vibe from other, bestie.

Definition at line 242 of file qwt_text.cpp.

🌸 bool QwtText::operator== (const QwtText & other) const

Relational operator. The “are these two matching?” vibe check between texts.

Returns: relational operator result.

Definition at line 250 of file qwt_text.cpp.

🌸 int QwtText::renderFlags () const

Returns the render flags. flags unlocked 🚩

Returns: render flags.

See also: setRenderFlags().

Definition at line 317 of file qwt_text.cpp.

🌸 void QwtText::setBackgroundBrush (const QBrush & brush)

Sets the background brush. brush upgrade 🖌️

Parameters:

  • brush — background brush.

See also: backgroundBrush(), setBorderPen().

Definition at line 441 of file qwt_text.cpp.

🌸 void QwtText::setBorderPen (const QPen & pen)

Sets the background pen. Yes, “background pen,” that’s the wording — we respect the lore.

Parameters:

  • pen — background pen.

See also: borderPen(), setBackgroundBrush().

Definition at line 420 of file qwt_text.cpp.

🌸 void QwtText::setBorderRadius (double radius)

Sets the radius for the corners of the border frame. Rounded corners are a personality 💅

Parameters:

  • radius — radius of a rounded corner.

See also: borderRadius(), setBorderPen(), setBackgroundBrush().

Definition at line 400 of file qwt_text.cpp.

🌸 void QwtText::setColor (const QColor & color)

Sets the pen color used for drawing the text. color assignment 🎨

Parameters:

  • color — color.
Note: Setting the color might have no effect, when the text contains control sequences for setting colors.

Definition at line 365 of file qwt_text.cpp.

🌸 void QwtText::setFont (const QFont & font)

Sets the font. font assignment ✨

Parameters:

  • font — font.
Note: Setting the font might have no effect, when the text contains control sequences for setting fonts.

Definition at line 329 of file qwt_text.cpp.

🌸 void QwtText::setLayoutAttribute (LayoutAttribute attribute, bool on = true)

Changes a layout attribute. Toggle it on or off, bestie.

Parameters:

  • attribute — layout attribute.
  • on — on/off.

See also: testLayoutAttribute().

Definition at line 494 of file qwt_text.cpp.

🌸 void QwtText::setPaintAttribute (PaintAttribute attribute, bool on = true)

Changes a paint attribute. Toggle it on or off, same energy.

Parameters:

  • attribute — paint attribute.
  • on — on/off.
Note: Used by setFont(), setColor(), setBorderPen() and setBackgroundBrush().

See also: testPaintAttribute().

Definition at line 466 of file qwt_text.cpp.

🌸 void QwtText::setRenderFlags (int renderFlags)

Changes the render flags. The default setting is Qt::AlignCenter — iconic default behavior 👑

Parameters:

  • renderFlags — bitwise OR of the flags used like in QPainter::drawText().

See also: renderFlags(), QwtTextEngine::draw().

Note: Some renderFlags might have no effect, depending on the text format.

Definition at line 304 of file qwt_text.cpp.

🌸 void QwtText::setText (const QString & text, QwtText::TextFormat textFormat = AutoText)

Assigns a new text content. New text, who dis? 💖

Parameters:

  • text — text content.
  • textFormat — text format.

See also: text().

Definition at line 277 of file qwt_text.cpp.

🌸 void QwtText::setTextEngine (QwtText::TextFormat format, QwtTextEngine * engine) [static]

Assigns/replaces a text engine for a text format. With setTextEngine it is possible to extend Qwt with other types of text formats. extend the lore 🌈

For QwtText::PlainText it is not allowed to assign a engine == NULL.

Parameters:

  • format — text format.
  • engine — text engine.
Warning: Using QwtText::AutoText does nothing.

Definition at line 713 of file qwt_text.cpp.

🌸 bool QwtText::testLayoutAttribute (LayoutAttribute attribute) const

Tests a layout attribute.

Parameters:

  • attribute — layout attribute.

Returns: true, if attribute is enabled.

See also: setLayoutAttribute().

Definition at line 510 of file qwt_text.cpp.

🌸 bool QwtText::testPaintAttribute (PaintAttribute attribute) const

Tests a paint attribute.

Parameters:

  • attribute — paint attribute.

Returns: true, if attribute is enabled.

See also: setPaintAttribute().

Definition at line 482 of file qwt_text.cpp.

🌸 QString QwtText::text () const

Returns the text as a QString. The raw text reveal moment 🫶

Returns: text as QString.

See also: setText().

Definition at line 289 of file qwt_text.cpp.

🌸 const QwtTextEngine * QwtText::textEngine (const QString & text, QwtText::TextFormat format = AutoText) [static]

Finds the text engine for a text format. In case of QwtText::AutoText the first text engine (beside QwtPlainTextEngine) is returned, where QwtTextEngine::mightRender returns true. If there is none QwtPlainTextEngine is returned.

If no text engine is registered for the format QwtPlainTextEngine is returned.

Parameters:

  • text — text, needed in case of AutoText.
  • format — text format.

Returns: corresponding text engine.

Definition at line 694 of file qwt_text.cpp.

🌸 const QwtTextEngine * QwtText::textEngine (QwtText::TextFormat format) [static]

Finds the text engine for a text format. textEngine can be used to find out if a text format is supported. Detective behavior 🔍

Parameters:

  • format — text format.

Returns: the text engine, or NULL if no engine is available.

Definition at line 727 of file qwt_text.cpp.

🌸 QSizeF QwtText::textSize () const

Returns the size that is needed to render text. Size check, but make it texty 📐

Returns: calculated size.

Definition at line 570 of file qwt_text.cpp.

🌸 QSizeF QwtText::textSize (const QFont & defaultFont) const

Returns the size that is needed to render text, with a default font in the mix.

Parameters:

  • defaultFont — font of the text.

Returns: calculated size.

Definition at line 581 of file qwt_text.cpp.

🌸 QColor QwtText::usedColor (const QColor & defaultColor) const

Returns the color of the text if it has one. Otherwise returns defaultColor. Fallback color behavior, slay 🎀

Parameters:

  • defaultColor — default color.

Returns: color used for drawing the text.

See also: setColor(), color(), PaintAttributes.

Definition at line 386 of file qwt_text.cpp.

🌸 QFont QwtText::usedFont (const QFont & defaultFont) const

Returns the font of the text if it has one. Otherwise returns defaultFont. Fallback font behavior, iconic 💅

Parameters:

  • defaultFont — default font.

Returns: font used for drawing the text.

See also: setFont(), font(), PaintAttributes.

Definition at line 350 of file qwt_text.cpp.

👑 Author 👑

Generated automatically by Doxygen for Qwt User’s Guide from the source code. Robots did the typing, and honestly? They ate. 🤖✨

Byeee bestie 🫶 — footer shoutout to the Qwt User’s Guide source/version, the QwtText(3) page, and the build date doing its little timestamp moment at the bottom. Periodt. 💅🌈

📦 where this page comes from