QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsTextDocumentRenderContext Class Reference

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

#include <qgstextdocumentmetrics.h>

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.
Since
QGIS 3.40

Definition at line 43 of file qgstextdocumentmetrics.h.

Member Function Documentation

◆ flags()

Qgis::TextRendererFlags QgsTextDocumentRenderContext::flags ( ) const
inline

Returns associated text renderer flags.

See also
setFlags()

Definition at line 52 of file qgstextdocumentmetrics.h.

◆ maximumWidth()

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.

See also
setMaximumWidth()

Definition at line 68 of file qgstextdocumentmetrics.h.

◆ setFlags()

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

Sets associated text renderer flags.

See also
flags()

Definition at line 59 of file qgstextdocumentmetrics.h.

◆ setMaximumWidth()

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.

See also
maximumWidth()

Definition at line 77 of file qgstextdocumentmetrics.h.


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