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

Public Member Functions
Qgis::TextRendererFlags	flags () const
	Returns associated text renderer flags.

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

void	setFlags (Qgis::TextRendererFlags flags)
	Sets associated text renderer flags.

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

Detailed Description

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.

Definition at line 43 of file qgstextdocumentmetrics.h.

Member Function Documentation

Qgis::TextRendererFlags QgsTextDocumentRenderContext::flags ( ) const

inline

Returns associated text renderer flags.

Definition at line 52 of file qgstextdocumentmetrics.h.

double QgsTextDocumentRenderContext::maximumWidth ( ) const

inline

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.

Definition at line 68 of file qgstextdocumentmetrics.h.

void QgsTextDocumentRenderContext::setFlags ( Qgis::TextRendererFlags flags )

inline

Sets associated text renderer flags.

Definition at line 59 of file qgstextdocumentmetrics.h.

void QgsTextDocumentRenderContext::setMaximumWidth ( double width )

inline

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.

Definition at line 77 of file qgstextdocumentmetrics.h.

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

/build/qgis-3.39.0+git20241021+e62b17dac54+99sid/src/core/textrenderer/qgstextdocumentmetrics.h