#include <qgstextfragment.h>

Public Member Functions
	QgsTextFragment (const QString &text=QString(), const QgsTextCharacterFormat &format=QgsTextCharacterFormat())
	Constructor for QgsTextFragment, with the specified text and optional character format. More...

	QgsTextFragment (const QTextFragment &fragment)
	Constructor for QgsTextFragment, based on the specified QTextFragment fragment. More...

const QgsTextCharacterFormat &	characterFormat () const
	Returns the character formatting for the fragment. More...

double	horizontalAdvance (const QFont &font, bool fontHasBeenUpdatedForFragment=false) const
	Returns the horizontal advance associated with this fragment, when rendered using the specified base font. More...

void	setCharacterFormat (const QgsTextCharacterFormat &format)
	Sets the character format for the fragment. More...

void	setText (const QString &text)
	Sets the text content of the fragment. More...

QString	text () const
	Returns the text content of the fragment. More...

Detailed Description

Stores a fragment of text along with formatting overrides to be used when rendering the fragment.

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

Since: QGIS 3.14

Definition at line 34 of file qgstextfragment.h.

Constructor & Destructor Documentation

◆ QgsTextFragment() [1/2]

QgsTextFragment::QgsTextFragment	(	const QString &	text = `QString()`,
		const QgsTextCharacterFormat &	format = `QgsTextCharacterFormat()`
	)

explicit

Constructor for QgsTextFragment, with the specified text and optional character format.

Definition at line 20 of file qgstextfragment.cpp.

◆ QgsTextFragment() [2/2]

QgsTextFragment::QgsTextFragment ( const QTextFragment & fragment )

explicit

Constructor for QgsTextFragment, based on the specified QTextFragment fragment.

Definition at line 25 of file qgstextfragment.cpp.

Member Function Documentation

◆ characterFormat()

const QgsTextCharacterFormat& QgsTextFragment::characterFormat ( ) const

inline

Returns the character formatting for the fragment.

See also: setCharacterFormat()

Definition at line 67 of file qgstextfragment.h.

◆ horizontalAdvance()

double QgsTextFragment::horizontalAdvance	(	const QFont &	font,
		bool	fontHasBeenUpdatedForFragment = `false`
	)		const

Returns the horizontal advance associated with this fragment, when rendered using the specified base font.

Set fontHasBeenUpdatedForFragment to true if font already represents the character format for this fragment.

Definition at line 47 of file qgstextfragment.cpp.

◆ setCharacterFormat()

void QgsTextFragment::setCharacterFormat ( const QgsTextCharacterFormat & format )

Sets the character format for the fragment.

See also: characterFormat()

Definition at line 42 of file qgstextfragment.cpp.

◆ setText()

void QgsTextFragment::setText ( const QString & text )

Sets the text content of the fragment.

See also: text()

Definition at line 37 of file qgstextfragment.cpp.

◆ text()

QString QgsTextFragment::text ( ) const

Returns the text content of the fragment.

See also: setText()

Definition at line 32 of file qgstextfragment.cpp.

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

/build/qgis-3.14.0+99unstable/src/core/textrenderer/qgstextfragment.h
/build/qgis-3.14.0+99unstable/src/core/textrenderer/qgstextfragment.cpp

Public Member Functions