QwtText(3)

🎀 NAME 🎀

QwtText 💅 — straight out of the Qwt User's Guide, manual section 3, so QwtText(3) if you're keeping receipts.

---

✨ SYNOPSIS ✨

#include <qwt_text.h>

🌸 Public Types

enum LayoutAttribute { MinimumLayout =  1 }
enum PaintAttribute { PaintUsingTextFont =  1, PaintUsingTextColor =  2, PaintBackground =  4 }
enum TextFormat { AutoText =  0, PlainText, RichText, MathMLText, TeXText, OtherFormat =  100 }

🦋 Public Member Functions

• QwtText (const QString &=QString::null, TextFormat textFormat=AutoText) — the main-character constructor, makes a text
• QwtText (const QwtText &) — copy constructor, clone that vibe
• ~QwtText () — destructor, it's over bestie
• QBrush backgroundBrush () const — hands you the background brush
• QPen backgroundPen () const — hands you the background pen
• QColor color () const — hands you the color
• void draw (QPainter *painter, const QRect &rect) const — paints the text into a rect
• QFont font () const — hands you the font
• int heightForWidth (int width, const QFont &=QFont()) const — how tall is this text at this width
• bool isEmpty () const — is the text empty
• bool isNull () const — is the text null
• int operator!= (const QwtText &) const — not-equal check between two texts
• QwtText & operator= (const QwtText &) — assignment, copy the whole girl over
• int operator== (const QwtText &) const — equality check (yes it returns int, that's just how it is, periodt)
• int renderFlags () const — reads back the render flags
• void setBackgroundBrush (const QBrush &) — sets the background brush
• void setBackgroundPen (const QPen &) — sets the background pen
• void setColor (const QColor &) — sets the color
• void setFont (const QFont &) — sets the font
• void setLayoutAttribute (LayoutAttribute, bool on=true) — flips a layout attribute on/off
• void setPaintAttribute (PaintAttribute, bool on=true) — flips a paint attribute on/off
• void setRenderFlags (int flags) — sets the render flags
• void setText (const QString &, QwtText::TextFormat textFormat=AutoText) — swaps in new text content
• bool testLayoutAttribute (LayoutAttribute) const — is this layout attribute on?
• bool testPaintAttribute (PaintAttribute) const — is this paint attribute on?
• QString text () const — gives you the text back
• QSize textSize (const QFont &=QFont()) const — how big does this text need to be
• QColor usedColor (const QColor &) const — the color it actually uses
• QFont usedFont (const QFont &) const — the font it actually uses

🧚 Static Public Member Functions

• static void setTextEngine (QwtText::TextFormat, QwtTextEngine *) — plug in or replace a text engine for a format
• static const QwtTextEngine * textEngine (const QString &text, QwtText::TextFormat=AutoText) — find the engine for some text
• static const QwtTextEngine * textEngine (QwtText::TextFormat) — find the engine for a format

---

💖 Detailed Description 💖

A class representing a text.

Okay so a QwtText is literally just a text plus a whole little wardrobe of attributes telling you how to render it. It's giving text with lore.

• Format — a text might include control sequences (f.e tags) describing how to render it. Each format (f.e MathML, TeX, Qt Rich Text) has its own set of control sequences, that a QwtTextEngine for that format can handle.
• Background — a text might have a background, defined by a QPen and QBrush to improve its visibility.
• 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

---

🌈 Member Enumeration Documentation 🌈

💜 enum QwtText::LayoutAttribute

Layout Attributes. The layout attributes affects some aspects of the layout of the text. (their words, and honestly slay)

• 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. so like, no cap, it might just do nothing sometimes 🙈

💜 enum QwtText::PaintAttribute

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

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

💜 enum QwtText::TextFormat

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

• 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 is rendered like 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. The Qwt MathML extension offers such an engine based on the MathML renderer of the Qt solutions package. Unfortunately it is only available for owners of a commercial Qt license. 💀 tragic honestly
• TeXText — use a TeX (http://en.wikipedia.org/wiki/TeX) render engine to display the text.
• OtherFormat — the number of text formats can be extended using setTextEngine. Formats >= OtherFormat are not used by Qwt.

See also: QwtTextEngine, setTextEngine()

---

🫶 Constructor & Destructor Documentation 🫶

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

Constructor. ✨

Parameters:

• text — Text content
• textFormat — Text format

---

👑 Member Function Documentation 👑

⭐ QBrush QwtText::backgroundBrush () const

Returns: Background brush

See also: setBackgroundBrush(), backgroundPen()

⭐ QPen QwtText::backgroundPen () const

Returns: Background pen

See also: setBackgroundPen(), backgroundBrush()

⭐ void QwtText::draw (QPainter *painter, const QRect &rect) const

Draw a text into a rectangle.

Parameters:

• painter — Painter
• rect — Rectangle

⭐ int QwtText::heightForWidth (int width, const QFont &defaultFont = QFont()) const

Find the height for a given width.

Parameters:

• defaultFont — Font, used for the calculation if the text has no font
• width — Width

Returns: Calculated height

⭐ bool QwtText::isEmpty () const [inline]

Returns: text().isEmpty()

⭐ bool QwtText::isNull () const [inline]

Returns: text().isNull()

⭐ int QwtText::renderFlags () const

Returns: Render flags

See also: setRenderFlags()

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

Set the background brush.

Parameters:

• brush — Background brush

See also: backgroundBrush(), setBackgroundPen()

⭐ void QwtText::setBackgroundPen (const QPen &pen)

Set the background pen.

Parameters:

• pen — Background pen

See also: backgroundPen(), setBackgroundBrush()

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

Set the pen color used for painting the text.

Parameters:

• color — Color

Note: setting the color might have no effect, when the text contains control sequences for setting colors. so like, sometimes it just doesn't listen to you bestie 😭

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

Set the font.

Parameters:

• font — Font

Note: setting the font might have no effect, when the text contains control sequences for setting fonts. same energy, the control sequences are the ones in charge here 💅

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

Change a layout attribute.

Parameters:

• attribute — Layout attribute
• on — On/Off

See also: testLayoutAttribute()

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

Change a paint attribute.

Parameters:

• attribute — Paint attribute
• on — On/Off

Note: used by setFont(), setColor(), setBackgroundPen() and setBackgroundBrush()

See also: testPaintAttribute()

⭐ void QwtText::setRenderFlags (int renderFlags)

Change the render flags. The default setting is Qt::AlignCenter.

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. iykyk

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

Assign a new text content.

Parameters:

• text — Text content
• textFormat — Text format

See also: text()

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

Assign/Replace a text engine for a text format.

With setTextEngine it is possible to extend Qwt with other types of text formats.

Owner of a commercial Qt license can build the qwtmathml library, that is based on the MathML renderer, that is included in MML Widget component of the Qt solutions package.

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

Parameters:

• format — Text format
• engine — Text engine

See also: QwtMathMLTextEngine

Warning: using QwtText::AutoText does nothing. literally nothing. don't do it 🚫

⭐ bool QwtText::testLayoutAttribute (LayoutAttribute attribute) const

Test a layout attribute.

Parameters:

• attribute — Layout attribute

Returns: true, if attribute is enabled

See also: setLayoutAttribute()

⭐ bool QwtText::testPaintAttribute (PaintAttribute attribute) const

Test a paint attribute.

Parameters:

• attribute — Paint attribute

Returns: true, if attribute is enabled

See also: setPaintAttribute()

⭐ QString QwtText::text () const

Return the text.

See also: setText()

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

Find 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 returnd.

If no text engine is registered for the format QwtPlainTextEngine is returnd. (yep, "returnd", that's their spelling, not mine 😭)

Parameters:

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

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

Find the text engine for a text format. textEngine can be used to find out if a text format is supported. F.e, if one wants to use MathML labels, the MathML renderer from the commercial Qt solutions package might be required, that is not available in Qt Open Source Edition environments.

Parameters:

• format — Text format

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

⭐ QSize QwtText::textSize (const QFont &defaultFont = QFont()) const

Find the height for a given width.

Parameters:

• defaultFont — Font, used for the calculation if the text has no font

Returns: Calculated height

Returns the size, that is needed to render text.

Parameters:

• defaultFont — Font of the text

Returns: Caluclated size (again — their typo, keeping it for the record 🫶)

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

Return the color of the text, if it has one. Otherwise return defaultColor.

Parameters:

• defaultColor — Default color

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

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

Return the font of the text, if it has one. Otherwise return defaultFont.

Parameters:

• defaultFont — Default font

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

---

✨ AUTHOR ✨

okay so real talk, nobody wrote this page with their own two hands and a little mug of tea 💖 it was generated automatically by Doxygen for Qwt User's Guide from the source code. so like, the source code is the actual main character here, and Doxygen is just the little robot bestie transcribing the vibes 🎀 no cap, that's the whole author situation. the code spoke, Doxygen typed it up, and now we're all here together reading it. iconic honestly 💅

---

and that's a wrap, bestie!! 🦋✨

this page came from Version 5.2.3, dated Tue Nov 20 2012 — yeah, it's giving vintage, it's giving classic, it's giving elder emoji 💀 but the knowledge is timeless fr fr. go forth and QwtText responsibly 🫶🌸

mwah 💋