QGIS API Documentation 3.29.0-Master (006c3c0232)
Public Member Functions | Static Public Member Functions | List of all members
QgsTextDocumentMetrics Class Reference

Contains pre-calculated metrics of a QgsTextDocument. More...

#include <qgstextdocumentmetrics.h>

Public Member Functions

double ascentOffset () const
 Returns the ascent offset of the first block in the document. More...
 
double baselineOffset (int blockIndex, Qgis::TextLayoutMode mode) const
 Returns the offset from the top of the document to the text baseline for the given block index. More...
 
double blockHeight (int blockIndex) const
 Returns the height of the block at the specified index. More...
 
double blockMaximumCharacterWidth (int blockIndex) const
 Returns the maximum character width for the specified block. More...
 
double blockMaximumDescent (int blockIndex) const
 Returns the maximum descent encountered in the specified block. More...
 
double blockWidth (int blockIndex) const
 Returns the width of the block at the specified index. More...
 
QSizeF documentSize (Qgis::TextLayoutMode mode, Qgis::TextOrientation orientation) const
 Returns the overall size of the document. More...
 
double firstLineCapHeight () const
 Returns the cap height for the first line of text. More...
 
QFont fragmentFont (int blockIndex, int fragmentIndex) const
 Returns the calculated font for the fragment at the specified block and fragment indices. More...
 
double fragmentHorizontalAdvance (int blockIndex, int fragmentIndex, Qgis::TextLayoutMode mode) const
 Returns the horizontal advance of the fragment at the specified block and fragment index. More...
 
double fragmentVerticalOffset (int blockIndex, int fragmentIndex, Qgis::TextLayoutMode mode) const
 Returns the vertical offset from a text block's baseline which should be applied to the fragment at the specified index within that block. More...
 
bool isNullFontSize () const
 Returns true if the metrics could not be calculated because the text format has a null font size. More...
 
QRectF outerBounds (Qgis::TextLayoutMode mode, Qgis::TextOrientation orientation) const
 Returns the outer bounds of the document, which is the documentSize() adjusted to account for any text elements which fall outside of the usual document margins (such as super or sub script elements) More...
 
double verticalOrientationXOffset (int blockIndex) const
 Returns the vertical orientation x offset for the specified block. More...
 

Static Public Member Functions

static QgsTextDocumentMetrics calculateMetrics (const QgsTextDocument &document, const QgsTextFormat &format, const QgsRenderContext &context, double scaleFactor=1.0)
 Returns precalculated text metrics for a text document, when rendered using the given base format and render context. More...
 

Detailed Description

Contains pre-calculated metrics of a QgsTextDocument.

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

Definition at line 41 of file qgstextdocumentmetrics.h.

Member Function Documentation

◆ ascentOffset()

double QgsTextDocumentMetrics::ascentOffset ( ) const
inline

Returns the ascent offset of the first block in the document.

Definition at line 139 of file qgstextdocumentmetrics.h.

◆ baselineOffset()

double QgsTextDocumentMetrics::baselineOffset ( int  blockIndex,
Qgis::TextLayoutMode  mode 
) const

Returns the offset from the top of the document to the text baseline for the given block index.

Definition at line 419 of file qgstextdocumentmetrics.cpp.

◆ blockHeight()

double QgsTextDocumentMetrics::blockHeight ( int  blockIndex) const

Returns the height of the block at the specified index.

Definition at line 409 of file qgstextdocumentmetrics.cpp.

◆ blockMaximumCharacterWidth()

double QgsTextDocumentMetrics::blockMaximumCharacterWidth ( int  blockIndex) const

Returns the maximum character width for the specified block.

Definition at line 463 of file qgstextdocumentmetrics.cpp.

◆ blockMaximumDescent()

double QgsTextDocumentMetrics::blockMaximumDescent ( int  blockIndex) const

Returns the maximum descent encountered in the specified block.

Definition at line 468 of file qgstextdocumentmetrics.cpp.

◆ blockWidth()

double QgsTextDocumentMetrics::blockWidth ( int  blockIndex) const

Returns the width of the block at the specified index.

Definition at line 404 of file qgstextdocumentmetrics.cpp.

◆ calculateMetrics()

QgsTextDocumentMetrics QgsTextDocumentMetrics::calculateMetrics ( const QgsTextDocument document,
const QgsTextFormat format,
const QgsRenderContext context,
double  scaleFactor = 1.0 
)
static

Returns precalculated text metrics for a text document, when rendered using the given base format and render 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 33 of file qgstextdocumentmetrics.cpp.

◆ documentSize()

QSizeF QgsTextDocumentMetrics::documentSize ( Qgis::TextLayoutMode  mode,
Qgis::TextOrientation  orientation 
) const

Returns the overall size of the document.

Definition at line 347 of file qgstextdocumentmetrics.cpp.

◆ firstLineCapHeight()

double QgsTextDocumentMetrics::firstLineCapHeight ( ) const

Returns the cap height for the first line of text.

Since
QGIS 3.30

Definition at line 414 of file qgstextdocumentmetrics.cpp.

◆ fragmentFont()

QFont QgsTextDocumentMetrics::fragmentFont ( int  blockIndex,
int  fragmentIndex 
) const

Returns the calculated font for the fragment at the specified block and fragment indices.

Definition at line 473 of file qgstextdocumentmetrics.cpp.

◆ fragmentHorizontalAdvance()

double QgsTextDocumentMetrics::fragmentHorizontalAdvance ( int  blockIndex,
int  fragmentIndex,
Qgis::TextLayoutMode  mode 
) const

Returns the horizontal advance of the fragment at the specified block and fragment index.

Since
QGIS 3.30

Definition at line 437 of file qgstextdocumentmetrics.cpp.

◆ fragmentVerticalOffset()

double QgsTextDocumentMetrics::fragmentVerticalOffset ( int  blockIndex,
int  fragmentIndex,
Qgis::TextLayoutMode  mode 
) const

Returns the vertical offset from a text block's baseline which should be applied to the fragment at the specified index within that block.

Since
QGIS 3.30

Definition at line 442 of file qgstextdocumentmetrics.cpp.

◆ isNullFontSize()

bool QgsTextDocumentMetrics::isNullFontSize ( ) const
inline

Returns true if the metrics could not be calculated because the text format has a null font size.

Since
QGIS 3.30

Definition at line 61 of file qgstextdocumentmetrics.h.

◆ outerBounds()

QRectF QgsTextDocumentMetrics::outerBounds ( Qgis::TextLayoutMode  mode,
Qgis::TextOrientation  orientation 
) const

Returns the outer bounds of the document, which is the documentSize() adjusted to account for any text elements which fall outside of the usual document margins (such as super or sub script elements)

Warning
Currently this is only supported for the Qgis::TextLayoutMode::Labeling mode.
Since
QGIS 3.30

Definition at line 378 of file qgstextdocumentmetrics.cpp.

◆ verticalOrientationXOffset()

double QgsTextDocumentMetrics::verticalOrientationXOffset ( int  blockIndex) const

Returns the vertical orientation x offset for the specified block.

Definition at line 458 of file qgstextdocumentmetrics.cpp.


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