QgsTextRendererUtils Class Reference

Utility functions for text rendering. More...

#include <qgstextrenderer.h>

Static Public Member Functions
static QgsTextBackgroundSettings::RotationType	decodeBackgroundRotationType (const QString &string)
	Decodes a string representation of a background rotation type to a type. More...
static QgsTextBackgroundSettings::SizeType	decodeBackgroundSizeType (const QString &string)
	Decodes a string representation of a background size type to a type. More...
static QgsTextShadowSettings::ShadowPlacement	decodeShadowPlacementType (const QString &string)
	Decodes a string representation of a shadow placement type to a type. More...
static QgsTextBackgroundSettings::ShapeType	decodeShapeType (const QString &string)
	Decodes a string representation of a background shape type to a type. More...
static QgsTextFormat::TextOrientation	decodeTextOrientation (const QString &name, bool *ok=nullptr)
	Attempts to decode a string representation of a text orientation. More...
static QString	encodeTextOrientation (QgsTextFormat::TextOrientation orientation)
	Encodes a text orientation. More...

Detailed Description

Utility functions for text rendering.

Since

QGIS 3.10

Definition at line 1844 of file qgstextrenderer.h.

Member Function Documentation

decodeBackgroundRotationType()

QgsTextBackgroundSettings::RotationType QgsTextRendererUtils::decodeBackgroundRotationType ( const QString &  string )

static

Decodes a string representation of a background rotation type to a type.

Definition at line 4052 of file qgstextrenderer.cpp.

decodeBackgroundSizeType()

QgsTextBackgroundSettings::SizeType QgsTextRendererUtils::decodeBackgroundSizeType ( const QString &  string )

static

Decodes a string representation of a background size type to a type.

Definition at line 4039 of file qgstextrenderer.cpp.

decodeShadowPlacementType()

QgsTextShadowSettings::ShadowPlacement QgsTextRendererUtils::decodeShadowPlacementType ( const QString &  string )

static

Decodes a string representation of a shadow placement type to a type.

Definition at line 4069 of file qgstextrenderer.cpp.

decodeShapeType()

QgsTextBackgroundSettings::ShapeType QgsTextRendererUtils::decodeShapeType ( const QString &  string )

static

Decodes a string representation of a background shape type to a type.

Definition at line 4011 of file qgstextrenderer.cpp.

decodeTextOrientation()

QgsTextFormat::TextOrientation QgsTextRendererUtils::decodeTextOrientation ( const QString &  name, bool *  ok = nullptr  )

static

Attempts to decode a string representation of a text orientation.

Parameters

name	encoded text orientation name
ok	if specified, will be set to true if the name was successfully decoded

Returns

decoded text orientation

See also

encodeTextOrientation()

Definition at line 4104 of file qgstextrenderer.cpp.

encodeTextOrientation()

QString QgsTextRendererUtils::encodeTextOrientation ( QgsTextFormat::TextOrientation  orientation )

static

Encodes a text orientation.

Returns

encoded string

See also

decodeTextOrientation()

Definition at line 4090 of file qgstextrenderer.cpp.

---

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

• /build/qgis-3.12.1+28bionic/src/core/qgstextrenderer.h
• /build/qgis-3.12.1+28bionic/src/core/qgstextrenderer.cpp