Class: QgsTextPreview

A widget for previewing text formatting settings.

QgsTextPreview provides a widget for previewing the appearance of text rendered using QgsTextRenderer. The preview includes all settings contained within a QgsTextFormat, including shadow, background and buffer.

In order to preview the exact appearance of text which uses sizes in map units, the scale and map units must be set by calling setScale() and setMapUnits().

Class Hierarchy

Base classes

QLabel
QFrame
QWidget
QObject
QPaintDevice

Methods

format	Returns the text format used for previewing text in the widget.
mapUnits	Returns the map unit type used for previewing format sizes in map units.
scale	Returns the scale used for previewing format sizes in map units.
setFormat	Sets the text format for previewing in the widget.
setMapUnits	Sets the map unit type for previewing format sizes in map units.
setScale	Sets the scale to use for previewing format sizes in map units.

class qgis.gui.QgsTextPreview

Bases: QLabel

__init__(parent: QWidget | None = None)

Constructor for QgsTextPreview

Parameters:

parent (Optional[QWidget] = None) – parent widget

format(self) → QgsTextFormat

Returns the text format used for previewing text in the widget.

See also

setFormat()

Return type:

QgsTextFormat

mapUnits(self) → Qgis.DistanceUnit

Returns the map unit type used for previewing format sizes in map units.

See also

setMapUnits()

See also

scale()

Return type:

Qgis.DistanceUnit

scale(self) → float

Returns the scale used for previewing format sizes in map units. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

setScale()

See also

mapUnits()

Return type:

float

setFormat(self, format: QgsTextFormat)

Sets the text format for previewing in the widget.

Parameters:

format (QgsTextFormat) – text format

See also

format()

setMapUnits(self, unit: Qgis.DistanceUnit)

Sets the map unit type for previewing format sizes in map units.

Parameters:

unit (Qgis.DistanceUnit) – map units

See also

mapUnits()

See also

setScale()

setScale(self, scale: float)

Sets the scale to use for previewing format sizes in map units. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

scale()

See also

setMapUnits()

Parameters:

scale (float)