Class: QgsLayerPropertiesWidget¶
- class qgis.gui.QgsLayerPropertiesWidget(layer: QgsSymbolLayer, symbol: QgsSymbol, vl: QgsVectorLayer, parent: QWidget = None)¶
Bases:
QgsPanelWidget
,QgsExpressionContextGenerator
Constructor for QgsLayerPropertiesWidget.
- Parameters
layer – the symbol layer
symbol – the symbol
vl – associated vector layer
parent –
parent widget
Methods
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
- rtype
QgsExpressionContext
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.
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs
- param layer
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- actionEvent(self, QActionEvent)¶
- changeEvent(self, QEvent)¶
- changeLayer¶
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
- 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
New in version 3.0.
- 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)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- emitSignalChanged(self)¶
- 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)¶
- layerTypeChanged(self)¶
- 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)¶
- populateLayerTypes(self)¶
- receivers(self, PYQT_SIGNAL) int ¶
- registerDataDefinedButton(self, button: QgsPropertyOverrideButton, key: QgsSymbolLayer.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.
New in version 3.0.
- Parameters
button (QgsPropertyOverrideButton) –
key (QgsSymbolLayer.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.
- Parameters
context (QgsSymbolWidgetContext) – symbol widget context
See also
New in version 3.0.
- setDockMode(self, dockMode: bool)¶
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs
- Parameters
dockMode (bool) –
True
to enable dock mode.
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- updateSymbolLayerWidget(self, layer: QgsSymbolLayer)¶
- Parameters
layer (QgsSymbolLayer) –
- wheelEvent(self, QWheelEvent)¶