Class: QgsLabelSettingsWidgetBase¶
- class qgis.gui.QgsLabelSettingsWidgetBase¶
Bases:
QgsPanelWidget
Base class for widgets which allow customization of label engine properties, such as label placement settings.
New in version 3.12.
QgsLabelSettingsWidgetBase(parent: QWidget = None, vl:
QgsVectorLayer
= None) Constructor for QgsLabelSettingsWidgetBase.- Parameters:
parent – parent widget
vl –
associated vector layer
Methods
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
- rtype:
QgsExpressionContext
Returns the current data defined properties state as specified in the widget.
Overridden key press event to handle the esc event on the widget.
Registers a data defined override
button
.Sets the
context
in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.Sets the current data defined properties to show in the widget.
Sets the geometry
type
of the features to customize the widget accordingly.Updates a data defined
properties
collection, correctly setting the values for any properties related to this widget.Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- actionEvent(self, QActionEvent)¶
- 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.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- changeEvent(self, QEvent)¶
- changed¶
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.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- context(self) QgsSymbolWidgetContext ¶
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
See also
- Return type:
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- createExpressionContext(self) QgsExpressionContext ¶
- Return type:
- customEvent(self, QEvent)¶
- dataDefinedProperties(self) QgsPropertyCollection ¶
Returns the current data defined properties state as specified in the widget.
See also
See also
- Return type:
- 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 ¶
- 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], PyQt5.sip.voidptr) Tuple[bool, int] ¶
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) int ¶
- registerDataDefinedButton(self, button: QgsPropertyOverrideButton, key: QgsPalLayerSettings.Property)¶
Registers a data defined override
button
. Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.- Parameters:
button (QgsPropertyOverrideButton) –
key (QgsPalLayerSettings.Property) –
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setContext(self, context: QgsSymbolWidgetContext)¶
Sets the
context
in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.See also
- Parameters:
context (QgsSymbolWidgetContext) –
- setDataDefinedProperties(self, dataDefinedProperties: QgsPropertyCollection)¶
Sets the current data defined properties to show in the widget.
See also
- Parameters:
dataDefinedProperties (QgsPropertyCollection) –
- setGeometryType(self, type: Qgis.GeometryType)¶
Sets the geometry
type
of the features to customize the widget accordingly.- Parameters:
type (Qgis.GeometryType) –
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateDataDefinedProperties(self, properties: QgsPropertyCollection)¶
Updates a data defined
properties
collection, correctly setting the values for any properties related to this widget.See also
See also
- Parameters:
properties (QgsPropertyCollection) –
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶