Stores information relating to individual character formatting. More...

#include <qgstextcharacterformat.h>

Public Types
enum	BooleanValue { BooleanValue::NotSet, BooleanValue::SetTrue, BooleanValue::SetFalse }
	Status values for boolean format properties. More...

Public Member Functions
	QgsTextCharacterFormat ()=default
	Constructor for QgsTextCharacterFormat. More...

	QgsTextCharacterFormat (const QTextCharFormat &format)
	Constructor for QgsTextCharacterFormat, based on the specified QTextCharFormat format. More...

BooleanValue	overline () const
	Returns whether the format has overline enabled. More...

void	setOverline (BooleanValue enabled)
	Sets whether the format has overline enabled. More...

void	setStrikeOut (BooleanValue enabled)
	Sets whether the format has strikethrough enabled. More...

void	setTextColor (const QColor &textColor)
	Sets the character's text color. More...

void	setUnderline (BooleanValue enabled)
	Sets whether the format has underline enabled. More...

BooleanValue	strikeOut () const
	Returns whether the format has strikethrough enabled. More...

QColor	textColor () const
	Returns the character's text color, or an invalid color if no color override is set and the default format color should be used. More...

BooleanValue	underline () const
	Returns whether the format has underline enabled. More...

void	updateFontForFormat (QFont &font, double scaleFactor=1.0) const
	Updates the specified font in place, applying character formatting options which are applicable on a font level. More...

Detailed Description

Stores information relating to individual character formatting.

These options encapsulate formatting options which override the default settings from a QgsTextFormat for individual characters (or sets of characters).

Warning: This API is not considered stable and may change in future QGIS versions.

Since: QGIS 3.14

Definition at line 39 of file qgstextcharacterformat.h.

Member Enumeration Documentation

◆ BooleanValue

enum QgsTextCharacterFormat::BooleanValue

strong

Status values for boolean format properties.

Enumerator
NotSet	Property is not set.
SetTrue	Property is set and `true`.
SetFalse	Property is set and `false`.

Definition at line 54 of file qgstextcharacterformat.h.

Constructor & Destructor Documentation

◆ QgsTextCharacterFormat() [1/2]

QgsTextCharacterFormat::QgsTextCharacterFormat ( )

default

Constructor for QgsTextCharacterFormat.

◆ QgsTextCharacterFormat() [2/2]

QgsTextCharacterFormat::QgsTextCharacterFormat ( const QTextCharFormat & format )

Constructor for QgsTextCharacterFormat, based on the specified QTextCharFormat format.

Definition at line 20 of file qgstextcharacterformat.cpp.

Member Function Documentation

◆ overline()

QgsTextCharacterFormat::BooleanValue QgsTextCharacterFormat::overline ( ) const

Returns whether the format has overline enabled.

See also: setUnderline()

Definition at line 65 of file qgstextcharacterformat.cpp.

◆ setOverline()

void QgsTextCharacterFormat::setOverline ( QgsTextCharacterFormat::BooleanValue enabled )

Sets whether the format has overline enabled.

See also: overline()

Definition at line 70 of file qgstextcharacterformat.cpp.

◆ setStrikeOut()

void QgsTextCharacterFormat::setStrikeOut ( BooleanValue enabled )

Sets whether the format has strikethrough enabled.

See also: strikeOut()

Definition at line 50 of file qgstextcharacterformat.cpp.

◆ setTextColor()

void QgsTextCharacterFormat::setTextColor ( const QColor & textColor )

Sets the character's text color.

Set color to an invalid color if no color override is desired and the default format color should be used.

See also: textColor()

Definition at line 40 of file qgstextcharacterformat.cpp.

◆ setUnderline()

void QgsTextCharacterFormat::setUnderline ( BooleanValue enabled )

Sets whether the format has underline enabled.

See also: underline()

Definition at line 60 of file qgstextcharacterformat.cpp.

◆ strikeOut()

QgsTextCharacterFormat::BooleanValue QgsTextCharacterFormat::strikeOut ( ) const

Returns whether the format has strikethrough enabled.

See also: setStrikeOut()

Definition at line 45 of file qgstextcharacterformat.cpp.

◆ textColor()

QColor QgsTextCharacterFormat::textColor ( ) const

Returns the character's text color, or an invalid color if no color override is set and the default format color should be used.

See also: setTextColor()

Definition at line 35 of file qgstextcharacterformat.cpp.

◆ underline()

QgsTextCharacterFormat::BooleanValue QgsTextCharacterFormat::underline ( ) const

Returns whether the format has underline enabled.

See also: setUnderline()

Definition at line 55 of file qgstextcharacterformat.cpp.

◆ updateFontForFormat()

void QgsTextCharacterFormat::updateFontForFormat	(	QFont &	font,
		double	scaleFactor = `1.0`
	)		const

Updates the specified font in place, applying character formatting options which are applicable on a font level.

The optional scaleFactor parameter can specify a font size scaling factor. It is recommended to set this to QgsTextRenderer::FONT_WORKAROUND_SCALE and then manually calculations based on the resultant font metrics. Failure to do so will result in poor quality text rendering at small font sizes.

Definition at line 75 of file qgstextcharacterformat.cpp.

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

/build/qgis-3.16.0+99unstable/src/core/textrenderer/qgstextcharacterformat.h
/build/qgis-3.16.0+99unstable/src/core/textrenderer/qgstextcharacterformat.cpp

Public Types

Public Member Functions