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

#include <qgstextcharacterformat.h>

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

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

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

QString	family () const
	Returns the font family name, or an empty string if the family is not set and should be inherited.

double	fontPointSize () const
	Returns the font point size, or -1 if the font size is not set and should be inherited.

int	fontWeight () const
	Returns the font weight, or -1 if the font weight is not set and should be inherited.

bool	hasVerticalAlignmentSet () const
	Returns `true` if the format has an explicit vertical alignment set.

BooleanValue	italic () const
	Returns whether the format has italic enabled.

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

void	setFamily (const QString &family)
	Sets the font family name.

void	setFontPointSize (double size)
	Sets the font point size.

void	setFontWeight (int fontWeight)
	Sets the font weight.

void	setHasVerticalAlignmentSet (bool set)
	Sets whether the format has an explicit vertical alignment set.

void	setItalic (BooleanValue enabled)
	Sets whether the format has italic enabled.

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

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

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

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

void	setVerticalAlignment (Qgis::TextCharacterVerticalAlignment alignment)
	Sets the format vertical alignment.

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

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.

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

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

Qgis::TextCharacterVerticalAlignment	verticalAlignment () const
	Returns the format vertical alignment.

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 41 of file qgstextcharacterformat.h.

Member Enumeration Documentation

◆ BooleanValue

enum class 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 56 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 45 of file qgstextcharacterformat.cpp.

Member Function Documentation

◆ family()

QString QgsTextCharacterFormat::family ( ) const

Returns the font family name, or an empty string if the family is not set and should be inherited.

See also: setFamily()

Since: QGIS 3.28

Definition at line 79 of file qgstextcharacterformat.cpp.

◆ fontPointSize()

double QgsTextCharacterFormat::fontPointSize ( ) const

Returns the font point size, or -1 if the font size is not set and should be inherited.

See also: setFontPointSize()

Since: QGIS 3.28

Definition at line 69 of file qgstextcharacterformat.cpp.

◆ fontWeight()

int QgsTextCharacterFormat::fontWeight ( ) const

Returns the font weight, or -1 if the font weight is not set and should be inherited.

See also: setFontWeight()

Since: QGIS 3.28

Definition at line 179 of file qgstextcharacterformat.cpp.

◆ hasVerticalAlignmentSet()

bool QgsTextCharacterFormat::hasVerticalAlignmentSet ( ) const

inline

Returns true if the format has an explicit vertical alignment set.

If false is returned then the vertical alignment will be inherited.

See also: setHasVerticalAlignmentSet(); verticalAlignment()

Since: QGIS 3.30

Definition at line 208 of file qgstextcharacterformat.h.

◆ italic()

QgsTextCharacterFormat::BooleanValue QgsTextCharacterFormat::italic ( ) const

Returns whether the format has italic enabled.

See also: setItalic()

Since: QGIS 3.28

Definition at line 169 of file qgstextcharacterformat.cpp.

◆ overline()

QgsTextCharacterFormat::BooleanValue QgsTextCharacterFormat::overline ( ) const

Returns whether the format has overline enabled.

See also: setUnderline()

Definition at line 109 of file qgstextcharacterformat.cpp.

◆ setFamily()

void QgsTextCharacterFormat::setFamily ( const QString & family )

Sets the font family name.

Set to an empty string if the family should be inherited.

See also: family()

Since: QGIS 3.28

Definition at line 84 of file qgstextcharacterformat.cpp.

◆ setFontPointSize()

void QgsTextCharacterFormat::setFontPointSize ( double size )

Sets the font point size.

Set size to -1 if the font size is not set and should be inherited.

See also: fontPointSize()

Since: QGIS 3.28

Definition at line 74 of file qgstextcharacterformat.cpp.

◆ setFontWeight()

void QgsTextCharacterFormat::setFontWeight ( int fontWeight )

Sets the font weight.

Set weight to -1 if the font weight is not set and should be inherited.

See also: fontWeight()

Since: QGIS 3.28

Definition at line 184 of file qgstextcharacterformat.cpp.

◆ setHasVerticalAlignmentSet()

void QgsTextCharacterFormat::setHasVerticalAlignmentSet ( bool set )

inline

Sets whether the format has an explicit vertical alignment set.

If set is false then the vertical alignment will be inherited.

See also: hasVerticalAlignmentSet(); setVerticalAlignment()

Since: QGIS 3.30

Definition at line 220 of file qgstextcharacterformat.h.

◆ setItalic()

void QgsTextCharacterFormat::setItalic ( QgsTextCharacterFormat::BooleanValue enabled )

Sets whether the format has italic enabled.

See also: italic()

Since: QGIS 3.28

Definition at line 174 of file qgstextcharacterformat.cpp.

◆ setOverline()

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

Sets whether the format has overline enabled.

See also: overline()

Definition at line 114 of file qgstextcharacterformat.cpp.

◆ setStrikeOut()

void QgsTextCharacterFormat::setStrikeOut ( BooleanValue enabled )

Sets whether the format has strikethrough enabled.

See also: strikeOut()

Definition at line 94 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 64 of file qgstextcharacterformat.cpp.

◆ setUnderline()

void QgsTextCharacterFormat::setUnderline ( BooleanValue enabled )

Sets whether the format has underline enabled.

See also: underline()

Definition at line 104 of file qgstextcharacterformat.cpp.

◆ setVerticalAlignment()

void QgsTextCharacterFormat::setVerticalAlignment ( Qgis::TextCharacterVerticalAlignment alignment )

inline

Sets the format vertical alignment.

This property is only respected if hasVerticalAlignmentSet() is true.

See also: hasVerticalAlignmentSet(); verticalAlignment()

Since: QGIS 3.30

Definition at line 244 of file qgstextcharacterformat.h.

◆ strikeOut()

QgsTextCharacterFormat::BooleanValue QgsTextCharacterFormat::strikeOut ( ) const

Returns whether the format has strikethrough enabled.

See also: setStrikeOut()

Definition at line 89 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 59 of file qgstextcharacterformat.cpp.

◆ underline()

QgsTextCharacterFormat::BooleanValue QgsTextCharacterFormat::underline ( ) const

Returns whether the format has underline enabled.

See also: setUnderline()

Definition at line 99 of file qgstextcharacterformat.cpp.

◆ updateFontForFormat()

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

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

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 119 of file qgstextcharacterformat.cpp.

◆ verticalAlignment()

Qgis::TextCharacterVerticalAlignment QgsTextCharacterFormat::verticalAlignment ( ) const

inline

Returns the format vertical alignment.

This property is only respected if hasVerticalAlignmentSet() is true.

See also: hasVerticalAlignmentSet(); setVerticalAlignment()

Since: QGIS 3.30

Definition at line 232 of file qgstextcharacterformat.h.

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

/build/qgis-3.34.0+99sid/src/core/textrenderer/qgstextcharacterformat.h
/build/qgis-3.34.0+99sid/src/core/textrenderer/qgstextcharacterformat.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ BooleanValue

Constructor & Destructor Documentation

◆ QgsTextCharacterFormat() [1/2]

◆ QgsTextCharacterFormat() [2/2]

Member Function Documentation

◆ family()

◆ fontPointSize()

◆ fontWeight()

◆ hasVerticalAlignmentSet()

◆ italic()

◆ overline()

◆ setFamily()

◆ setFontPointSize()

◆ setFontWeight()

◆ setHasVerticalAlignmentSet()

◆ setItalic()

◆ setOverline()

◆ setStrikeOut()

◆ setTextColor()

◆ setUnderline()

◆ setVerticalAlignment()

◆ strikeOut()

◆ textColor()

◆ underline()

◆ updateFontForFormat()

◆ verticalAlignment()