Class: QgsStyleItemsListWidget¶
- class qgis.gui.QgsStyleItemsListWidget(parent: QWidget)¶
Bases:
PyQt5.QtWidgets.QWidget
Constructor for
QgsStyleItemsListWidget
, with the specifiedparent
widget.A reusable widget for showing a filtered list of entities from a
QgsStyle
database.New in version 3.10:
Methods
Returns the type of the item currently selected in the widget.
Returns the name of the item currently selected in the widget.
Returns the current tag filter set for the widget, if any is set.
Sets the
type
of style entity to show in the widget.Sets the layer
type
to show in the widget.Sets the
style
database associated with the widget.Sets the
type
of symbols to show in the widget.- param event
Signals
Emitted when the user has opted to save a new entity to the style database, by clicking the "Save" button in the widget.
Emitted when the selected item is changed 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)¶
- currentEntityType(self) QgsStyle.StyleEntity ¶
Returns the type of the item currently selected in the widget.
See also
- Return type
- currentItemName(self) str ¶
Returns the name of the item currently selected in the widget.
See also
- Return type
str
- currentTagFilter(self) str ¶
Returns the current tag filter set for the widget, if any is set.
- Return type
str
- 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 ¶
- 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)¶
- saveEntity¶
Emitted when the user has opted to save a new entity to the style database, by clicking the “Save” button in the widget.
It is the caller’s responsibility to handle this in an appropriate manner given the context of the widget. [signal]
- selectionChanged¶
Emitted when the selected item is changed in the widget.
- Parameters
name (str) – Newly selected item name
type (QgsStyle.StyleEntity) – Newly selected item type [signal]
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setEntityType(self, type: QgsStyle.StyleEntity)¶
Sets the
type
of style entity to show in the widget.See also
- Parameters
type (QgsStyle.StyleEntity) –
- setLayerType(self, type: QgsWkbTypes.GeometryType)¶
Sets the layer
type
to show in the widget. Settype
to QgsWkbTypes.UnknownGeometry if no layer type filter is desired.This setting only applies to label settings and 3d style entities.
- Parameters
type (QgsWkbTypes.GeometryType) –
- setStyle(self, style: QgsStyle)¶
Sets the
style
database associated with the widget.Ownership of
style
is not transferred, and the caller is responsible for ensuring that it exists for the lifetime of the widget.- Parameters
style (QgsStyle) –
- setSymbolType(self, type: QgsSymbol.SymbolType)¶
Sets the
type
of symbols to show in the widget.See also
- Parameters
type (QgsSymbol.SymbolType) –
- showEvent(self, event: QShowEvent)¶
- Parameters
event (QShowEvent) –
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶