Class: QgsTextDocumentRenderContext

Encapsulates the context in which a text document is to be rendered.

Warning

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

Added in version 3.40.

Methods

flags

Returns associated text renderer flags.

maximumWidth

Returns the maximum width (in painter units) for rendered text.

setFlags

Sets associated text renderer flags.

setMaximumWidth

Sets the maximum width (in painter units) for rendered text.
class qgis.core.QgsTextDocumentRenderContext[source]

Bases: object

flags(self) → Qgis.TextRendererFlags[source]

Returns associated text renderer flags.

See also

setFlags()

Return type:

Qgis.TextRendererFlags

maximumWidth(self) → float[source]

Returns the maximum width (in painter units) for rendered text.

This is used to control text wrapping, when the Qgis.TextRendererFlag.WrapLines flag is set.

See also

setMaximumWidth()

Return type:

float

setFlags(self, flags: Qgis.TextRendererFlags | Qgis.TextRendererFlag)[source]

Sets associated text renderer flags.

See also

flags()

Parameters:

flags (Union[Qgis.TextRendererFlags, Qgis.TextRendererFlag])

setMaximumWidth(self, width: float)[source]

Sets the maximum width (in painter units) for rendered text.

This is used to control text wrapping, when the Qgis.TextRendererFlag.WrapLines flag is set.

See also

maximumWidth()

Parameters:

width (float)