Class: QgsTextFormatPanelWidget¶
- class qgis.gui.QgsTextFormatPanelWidget¶
Bases:
QgsPanelWidgetWrapper
A panel widget for customizing text formatting settings.
QgsTextFormatPanelWidget
provides a panel widget for controlling the appearance of text rendered usingQgsTextRenderer
. The dialog includes all settings contained within aQgsTextFormat
, including shadow, background and buffer.New in version 3.0.
QgsTextFormatPanelWidget(format:
QgsTextFormat
, mapCanvas:QgsMapCanvas
= None, parent: QWidget = None, layer:QgsVectorLayer
= None) Constructor for QgsTextFormatPanelWidget.- Parameters
format – initial format settings to show in dialog
mapCanvas – optional associated map canvas
parent – parent widget
layer –
associated layer
Methods
Returns the current formatting settings defined by the widget.
Overridden key press event to handle the esc event on the widget.
Sets the
context
in which the widget is shown, e.g., the associated map canvas and expression contexts.- param dockMode
Sets the
format
to show in the widget.
- actionEvent(self, QActionEvent)¶
- 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 ¶
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- format(self) QgsTextFormat ¶
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, event: QKeyEvent)¶
Overridden key press event to handle the esc event on the widget.
- Parameters
event – The key event
- 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)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- 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.
- Parameters
context (QgsSymbolWidgetContext) –
- setDockMode(self, dockMode: bool)¶
- Parameters
dockMode (bool) –
- setFormat(self, format: QgsTextFormat)¶
Sets the
format
to show in the widget.New in version 3.16.
- Parameters
format (QgsTextFormat) –
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶