Class: QgsBrowserWidget¶
- class qgis.gui.QgsBrowserWidget¶
Bases:
QgsPanelWidget
A widget showing a browser tree view along with toolbar and toggleable properties pane.
New in version 3.22.
QgsBrowserWidget(browserModel:
QgsBrowserGuiModel
, parent: QWidget = None) Constructor for QgsBrowserWidget- Parameters
browserModel – instance of the (shared) browser model
parent –
parent widget
Methods
Overridden key press event to handle the esc event on the widget.
Returns the message bar associated with the widget.
Refreshes the browser model and view.
Sets the customization for data items based on item's data provider key
Sets a message
bar
to use alongside the widget.- param event
- 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 ¶
- 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)¶
- messageBar(self) QgsMessageBar ¶
Returns the message bar associated with the widget.
See also
- Return type
- 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 ¶
- refresh(self)¶
Refreshes the browser model and view.
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setDisabledDataItemsKeys(self, filter: Iterable[str])¶
Sets the customization for data items based on item’s data provider key
By default browser model shows all items from all available data items provider and few special items (e.g. Favorites). To customize the behavior, set the filter to not load certain data items. The items that are not based on data item providers (e.g. Favorites, Home) have prefix “special:”
Used in the proxy browser model to hide items
- Parameters
filter (Iterable[str]) –
- setMessageBar(self, bar: QgsMessageBar)¶
Sets a message
bar
to use alongside the widget. Setting this allows items to utilize the message bar to provide non-blocking feedback to users, e.g. success or failure of actions.See also
- Parameters
bar (QgsMessageBar) –
- showEvent(self, event: QShowEvent)¶
- Parameters
event (QShowEvent) –
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶