Class: QgsTextFormatWidget

class qgis.gui.QgsTextFormatWidget(format: QgsTextFormat = QgsTextFormat(), mapCanvas: QgsMapCanvas = None, parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsTextFormatWidget.

Parameters:
  • format – initial formatting settings to show in widget
  • mapCanvas – associated map canvas
  • parent – parent widget

QgsTextFormatWidget(mapCanvas: QgsMapCanvas, parent: QWidget, mode: QgsTextFormatWidget.Mode) Constructor for QgsTextFormatWidget.

Parameters:
  • mapCanvas – associated map canvas
  • parent – parent widget
  • mode – widget mode

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.

New in version 3.0: Enums

Methods

actionEvent
changeEvent
childEvent
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enableDataDefinedAlignment Controls whether data defined alignment buttons are enabled.
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
format Returns the current formatting settings defined by the widget.
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
receivers
resizeEvent
sender
senderSignalIndex
setDockMode Sets whether the widget should be shown in a compact dock mode.
setFormat Sets the current formatting settings
setPreviewBackground Sets the background color for the text preview widget.
sharedPainter
showEvent
tabletEvent
timerEvent
updateLinePlacementOptions Updates line placement options to reflect current state of widget
updateMicroFocus
updatePlacementWidgets Updates label placement options to reflect current state of widget
updateWidgetForFormat Updates the widget’s state to reflect the settings in a QgsTextFormat.
wheelEvent

Signals

widgetChanged Emitted when the text format defined by the widget changes [signal]

Attributes

Labeling
Text
Labeling = 1
class Mode

Bases: int

Text = 0
actionEvent()
changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enableDataDefinedAlignment(self, enable: bool)

Controls whether data defined alignment buttons are enabled.

Parameters:enable – set to True to enable alignment controls
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
format(self) → QgsTextFormat

Returns the current formatting settings defined by the widget.

hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent()
sender()
senderSignalIndex()
setDockMode(self, enabled: bool)

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

Parameters:enabled – set to True to show in dock mode.
setFormat(self, format: QgsTextFormat)

Sets the current formatting settings

New in version 3.2.

setPreviewBackground(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the background color for the text preview widget.

Parameters:color – background color
sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateLinePlacementOptions(self)

Updates line placement options to reflect current state of widget

updateMicroFocus()
updatePlacementWidgets(self)

Updates label placement options to reflect current state of widget

updateWidgetForFormat(self, format: QgsTextFormat)

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

Parameters:format – source format
wheelEvent()
widgetChanged

Emitted when the text format defined by the widget changes [signal]