Class: QgsTextFormatPanelWidget

A panel widget for customizing text formatting settings.

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

Class Hierarchy

Base classes

QgsPanelWidgetWrapper	Wrapper widget for existing widgets which can’t have the inheritance tree changed, e.g dialogs.
QgsPanelWidget	Base class for any widget that can be shown as an inline panel.
QWidget
QObject
QPaintDevice

Methods

format	Returns the current formatting settings defined by the widget.
setContext	Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
setFormat	Sets the format to show in the widget.

class qgis.gui.QgsTextFormatPanelWidget

Bases: QgsPanelWidgetWrapper

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

Constructor for QgsTextFormatPanelWidget.

Parameters:

• format (QgsTextFormat) – initial format settings to show in dialog

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

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

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

format(self) → QgsTextFormat

Returns the current formatting settings defined by the widget.

Return type:

QgsTextFormat

setContext(self, context: QgsSymbolWidgetContext)

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

Added in version 3.10.

Parameters:

context (QgsSymbolWidgetContext)

setFormat(self, format: QgsTextFormat)

Sets the format to show in the widget.

Added in version 3.16.

Parameters:

format (QgsTextFormat)