A class representing a text. More...

#include <qwt_text.h>

Classes
class	LayoutCache

class	PrivateData

Public Types
enum	LayoutAttribute { MinimumLayout = 0x01 }
	Layout Attributes The layout attributes affects some aspects of the layout of the text. More...

enum	PaintAttribute { PaintUsingTextFont = 0x01, PaintUsingTextColor = 0x02, PaintBackground = 0x04 }
	Paint Attributes. More...

enum	TextFormat { AutoText = 0, PlainText, RichText, MathMLText, TeXText, OtherFormat = 100 }
	Text format. More...

Public Member Functions
QBrush	backgroundBrush () const

QPen	borderPen () const

double	borderRadius () const

QColor	color () const
	Return the pen color, used for painting the text. More...

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

QFont	font () const
	Return the font. More...

double	heightForWidth (double width) const

double	heightForWidth (double width, const QFont &) const

bool	isEmpty () const

bool	isNull () const

bool	operator!= (const QwtText &) const
	Relational operator. More...

QwtText &	operator= (const QwtText &)
	Assignment operator. More...

bool	operator== (const QwtText &) const
	Relational operator. More...

	QwtText ()

	QwtText (const QString &, TextFormat textFormat=AutoText)

	QwtText (const QwtText &)
	Copy constructor. More...

int	renderFlags () const

void	setBackgroundBrush (const QBrush &)

void	setBorderPen (const QPen &)

void	setBorderRadius (double)

void	setColor (const QColor &)

void	setFont (const QFont &)

void	setLayoutAttribute (LayoutAttribute, bool on=true)

void	setPaintAttribute (PaintAttribute, bool on=true)

void	setRenderFlags (int)
	Change the render flags. More...

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

bool	testLayoutAttribute (LayoutAttribute) const

bool	testPaintAttribute (PaintAttribute) const

QString	text () const

QSizeF	textSize () const

QSizeF	textSize (const QFont &) const

QColor	usedColor (const QColor &) const

QFont	usedFont (const QFont &) const

	~QwtText ()
	Destructor. More...

Static Public Member Functions
static void	setTextEngine (QwtText::TextFormat, QwtTextEngine *)

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

static const QwtTextEngine *	textEngine (QwtText::TextFormat)
	Find the text engine for a text format. More...

Private Attributes
PrivateData *	m_data

LayoutCache *	m_layoutCache

Detailed Description

A class representing a text.

A QwtText is a text including a set of attributes how to render it.

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 can be handles by a special QwtTextEngine for this format.
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 Enumeration Documentation

◆ LayoutAttribute

enum QwtText::LayoutAttribute

Layout Attributes The layout attributes affects 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.

◆ PaintAttribute

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.

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.

◆ TextFormat

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 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() [1/3]

QwtText::QwtText ( )

Constructor

Definition at line 201 of file qwt_text.cpp.

◆ QwtText() [2/3]

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() [3/3]

QwtText::QwtText ( const QwtText & other )

Copy constructor.

Definition at line 225 of file qwt_text.cpp.

◆ ~QwtText()

QwtText::~QwtText ( )

Destructor.

Definition at line 235 of file qwt_text.cpp.

Member Function Documentation

◆ backgroundBrush()

QBrush QwtText::backgroundBrush ( ) const

Returns: Background brush

See also: setBackgroundBrush(), borderPen()

Definition at line 451 of file qwt_text.cpp.

◆ borderPen()

QPen QwtText::borderPen ( ) const

Returns: Background pen

See also: setBorderPen(), backgroundBrush()

Definition at line 430 of file qwt_text.cpp.

◆ borderRadius()

double QwtText::borderRadius ( ) const

Returns: Radius for the corners of the border frame

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

Definition at line 409 of file qwt_text.cpp.

◆ color()

QColor QwtText::color ( ) const

Return the pen color, used for painting the text.

Definition at line 372 of file qwt_text.cpp.

◆ draw()

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

Draw a text into a rectangle

Parameters

painter	Painter
rect	Rectangle

Definition at line 615 of file qwt_text.cpp.

◆ font()

QFont QwtText::font ( ) const

Return the font.

Definition at line 336 of file qwt_text.cpp.

◆ heightForWidth() [1/2]

double QwtText::heightForWidth ( double width ) const

Find the height for a given width

Parameters

width Width

Returns: Calculated height

Definition at line 522 of file qwt_text.cpp.

◆ heightForWidth() [2/2]

double QwtText::heightForWidth	(	double	width,
		const QFont &	defaultFont
	)		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

Definition at line 535 of file qwt_text.cpp.

◆ isEmpty()

bool QwtText::isEmpty ( ) const

Returns: text().isEmpty()

Definition at line 739 of file qwt_text.cpp.

◆ isNull()

bool QwtText::isNull ( ) const

Returns: text().isNull()

Definition at line 733 of file qwt_text.cpp.

◆ operator!=()

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

Relational operator.

Definition at line 264 of file qwt_text.cpp.

◆ operator=()

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

Assignment operator.

Definition at line 242 of file qwt_text.cpp.

◆ operator==()

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

Relational operator.

Definition at line 250 of file qwt_text.cpp.

◆ renderFlags()

int QwtText::renderFlags ( ) const

Returns: Render flags

See also: setRenderFlags()

Definition at line 317 of file qwt_text.cpp.

◆ setBackgroundBrush()

void QwtText::setBackgroundBrush ( const QBrush & brush )

Set the background brush

Parameters

brush Background brush

See also: backgroundBrush(), setBorderPen()

Definition at line 441 of file qwt_text.cpp.

◆ setBorderPen()

void QwtText::setBorderPen ( const QPen & pen )

Set the background pen

Parameters

pen	Background pen

See also: borderPen(), setBackgroundBrush()

Definition at line 420 of file qwt_text.cpp.

◆ setBorderRadius()

void QwtText::setBorderRadius ( double radius )

Set the radius for the corners of the border frame

Parameters

radius Radius of a rounded corner

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

Definition at line 400 of file qwt_text.cpp.

◆ setColor()

void QwtText::setColor ( const QColor & color )

Set the pen color used for drawing the text.

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.

◆ setFont()

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.

Definition at line 329 of file qwt_text.cpp.

◆ setLayoutAttribute()

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

Change a layout attribute

Parameters

attribute	Layout attribute
on	On/Off

See also: testLayoutAttribute()

Definition at line 494 of file qwt_text.cpp.

◆ setPaintAttribute()

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

Change a paint attribute

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.

◆ setRenderFlags()

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.

Definition at line 304 of file qwt_text.cpp.

◆ setText()

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()

Definition at line 277 of file qwt_text.cpp.

◆ setTextEngine()

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.

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.

◆ testLayoutAttribute()

bool QwtText::testLayoutAttribute ( LayoutAttribute attribute ) const

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

◆ testPaintAttribute()

bool QwtText::testPaintAttribute ( PaintAttribute attribute ) const

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

◆ text()

QString QwtText::text ( ) const

Returns: Text as QString.

See also: setText()

Definition at line 289 of file qwt_text.cpp.

◆ textEngine() [1/2]

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

◆ textEngine() [2/2]

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.

Parameters

format Text format

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

Definition at line 727 of file qwt_text.cpp.

◆ textSize() [1/2]

QSizeF QwtText::textSize ( ) const

Returns the size, that is needed to render text

Returns: Calculated size

Definition at line 570 of file qwt_text.cpp.

◆ textSize() [2/2]

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

Returns the size, that is needed to render text

Parameters

defaultFont Font of the text

Returns: Calculated size

Definition at line 581 of file qwt_text.cpp.

◆ usedColor()

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

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

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.

◆ usedFont()

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

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

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.

Member Data Documentation

◆ m_data

PrivateData* QwtText::m_data

private

Definition at line 206 of file qwt_text.h.

◆ m_layoutCache

LayoutCache* QwtText::m_layoutCache

private

Definition at line 209 of file qwt_text.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ LayoutAttribute

◆ PaintAttribute

◆ TextFormat

Constructor & Destructor Documentation

◆ QwtText() [1/3]

◆ QwtText() [2/3]

◆ QwtText() [3/3]

◆ ~QwtText()

Member Function Documentation

◆ backgroundBrush()

◆ borderPen()

◆ borderRadius()

◆ color()

◆ draw()

◆ font()

◆ heightForWidth() [1/2]

◆ heightForWidth() [2/2]

◆ isEmpty()

◆ isNull()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ renderFlags()

◆ setBackgroundBrush()

◆ setBorderPen()

◆ setBorderRadius()

◆ setColor()

◆ setFont()

◆ setLayoutAttribute()

◆ setPaintAttribute()

◆ setRenderFlags()

◆ setText()

◆ setTextEngine()

◆ testLayoutAttribute()

◆ testPaintAttribute()

◆ text()

◆ textEngine() [1/2]

◆ textEngine() [2/2]

◆ textSize() [1/2]

◆ textSize() [2/2]

◆ usedColor()

◆ usedFont()

Member Data Documentation

◆ m_data

◆ m_layoutCache