Class: QgsTextFormatWidget

A widget for customizing text formatting settings.

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

Additionally, the widget can handle labeling settings due to the large overlap between the text renderer settings and the labeling settings. This mode is possible by subclassing QgsTextFormatWidget and calling the protected constructor with a mode of Labeling.

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice
QgsExpressionContextGenerator	Abstract interface for generating an expression context.

class qgis.gui.QgsTextFormatWidget

Bases: QWidget, QgsExpressionContextGenerator

__init__(format: QgsTextFormat = QgsTextFormat(), mapCanvas: QgsMapCanvas | None = None, parent: QWidget | None = None, layer: QgsMapLayer | None = None)

Constructor for QgsTextFormatWidget.

Parameters:

• format (QgsTextFormat = QgsTextFormat()) – initial formatting settings to show in widget

• mapCanvas (Optional[QgsMapCanvas] = None) – associated map canvas

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

• layer (Optional[QgsMapLayer] = None) – associated layer (vector or mesh)

__init__(mapCanvas: QgsMapCanvas | None, parent: QWidget | None, mode: QgsTextFormatWidget.Mode, layer: QgsMapLayer | None = None)

Constructor for QgsTextFormatWidget.

Parameters:

• mapCanvas (Optional[QgsMapCanvas]) – associated map canvas

• parent (Optional[QWidget]) – parent widget

• mode (QgsTextFormatWidget.Mode) – widget mode

• layer (Optional[QgsMapLayer] = None) – associated vector layer

Labeling = 1

class Mode

Bases: int

Text = 0

signal auxiliaryFieldCreated

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

context(self) → QgsSymbolWidgetContext

Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

See also

setContext()

Added in version 3.10.

Return type:

QgsSymbolWidgetContext

deactivateField(self, key: QgsPalLayerSettings.Property)

Deactivate a field from data defined properties and update the corresponding button.

Parameters:

key (QgsPalLayerSettings.Property) – The property key to deactivate

enableDataDefinedAlignment(self, enable: bool)

Update the enabled state of the data defined alignment buttons.

Deprecated since version 3.24.

Parameters:

enable (bool)

format(self, includeDataDefinedProperties: bool = True) → QgsTextFormat

Returns the current formatting settings defined by the widget.

If includateDataDefinedProperties is True, then data defined properties specified in the widget will be included in the format definition.

Parameters:

includeDataDefinedProperties (bool = True)

Return type:

QgsTextFormat

labelGeometryType(self) → Qgis.GeometryType

Returns the geometry type which will be used by the labeling engine when registering labels for the labeling settings currently defined by the widget.

Added in version 3.16.

Return type:

Qgis.GeometryType

virtual saveFormat(self)

Saves the current text settings to a style entry.

virtual setContext(self, context: QgsSymbolWidgetContext)

Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

See also

context()

Added in version 3.10.

Parameters:

context (QgsSymbolWidgetContext)

setDockMode(self, enabled: bool)

Sets whether the widget should be shown in a compact dock mode.

Parameters:

enabled (bool) – set to True to show in dock mode.

setFormat(self, format: QgsTextFormat)

Sets the current formatting settings

Added in version 3.2.

Parameters:

format (QgsTextFormat)

virtual setFormatFromStyle(self, name: str | None, type: QgsStyle.StyleEntity, stylePath: str | None)

Sets the current text settings from a style entry.

Added in version 3.10.

Parameters:

• name (Optional[str])

• type (QgsStyle.StyleEntity)

• stylePath (Optional[str])

setPreviewBackground(self, color: QColor | Qt.GlobalColor)

Sets the background color for the text preview widget.

Parameters:

color (Union[QColor, Qt.GlobalColor]) – background color

setPropertyOverrideButtonsVisible(self, visible: bool)

Toggles whether data defined buttons should be shown in the widget.

Added in version 3.42.

Parameters:

visible (bool)

updateLinePlacementOptions(self)

Updates line placement options to reflect current state of widget

updatePlacementWidgets(self)

Updates label placement options to reflect current state of widget

updatePreview(self)

Updates the text preview.

Added in version 3.10.

updateWidgetForFormat(self, format: QgsTextFormat)

Updates the widget’s state to reflect the settings in a QgsTextFormat.

Parameters:

format (QgsTextFormat) – source format

signal widgetChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.