Class: QgsTextFormatDialog

class qgis.gui.QgsTextFormatDialog(format: QgsTextFormat, mapCanvas: QgsMapCanvas = None, parent: QWidget = None, fl: Union[Qt.WindowFlags, Qt.WindowType] = QgsGuiUtils.ModalDialogFlags, layer: QgsVectorLayer = None)

Bases: PyQt5.QtWidgets.QDialog

Constructor for QgsTextFormatDialog.

  • format – initial format settings to show in dialog

  • mapCanvas – optional associated map canvas

  • parent – parent widget

  • fl – window flags for dialog

  • layer – associated vector layer

A simple dialog for customizing text formatting settings.

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

actionEvent(self, QActionEvent)

Returns a reference to the dialog’s button box.

New in version 3.10.

Return type


changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent)bool
eventFilter(self, QObject, QEvent)bool
focusInEvent(self, QFocusEvent)
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)

Returns the current formatting settings defined by the widget.

Return type


hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL)int
resizeEvent(self, QResizeEvent)
setContext(self, context: QgsSymbolWidgetContext)

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

New in version 3.10.


context (QgsSymbolWidgetContext) –

showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
wheelEvent(self, QWheelEvent)