Class: QgsBrowserDockWidget¶

class qgis.gui.QgsBrowserDockWidget¶

Bases: QgsDockWidget

The QgsBrowserDockWidget class

New in version 3.0.

QgsBrowserDockWidget(name: str, browserModel: QgsBrowserGuiModel, parent: QWidget = None) Constructor for QgsBrowserDockWidget

Parameters

name – name of the widget
browserModel – instance of the (shared) browser model

parent –

parent widget

Methods

`actionEvent`
`addFavorite`	Add current item to favorite.
`addFavoriteDirectory`	Add directory to favorites.
`addLayerAtIndex`	Adds the layer corresponding to the specified model `index`.
`addSelectedLayers`	Add selected layers to the project
`changeEvent`
`childEvent`
`closeEvent`
`connectNotify`
`contextMenuEvent`
`create`
`customEvent`
`destroy`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`enablePropertiesWidget`	Enable/disable properties widget
`enterEvent`
`event`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`hideEvent`
`hideItem`	Hide current item
`initPainter`
`initStyleOption`
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`
`keyReleaseEvent`
`leaveEvent`
`messageBar`	Returns the message bar associated with the dock.
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`nativeEvent`
`paintEvent`
`receivers`
`refresh`	Refresh browser view model (and view)
`removeFavorite`	Remove from favorite.
`resizeEvent`
`selectionChanged`	Selection has changed
`sender`
`senderSignalIndex`
`setActiveIndex`	Sets the selection to `index` and expand it
`setCaseSensitive`	Sets filter case sensitivity
`setDisabledDataItemsKeys`	Sets the customization for data items based on item's data provider key
`setFilter`	Apply filter to the model
`setFilterSyntax`	Sets filter syntax
`setMessageBar`	Sets a message `bar` to use alongside the dock widget.
`sharedPainter`
`showContextMenu`	Show context menu
`showEvent`	Show event override
`showFilterWidget`	Show/hide filter widget
`showProperties`	Show the layer properties
`splitterMoved`	Splitter has been moved
`tabletEvent`
`timerEvent`
`toggleFastScan`	Toggle fast scan
`updateMicroFocus`
`updateProjectHome`	Update project home directory
`wheelEvent`

Signals

`connectionsChanged`	Connections changed in the browser [signal]
`handleDropUriList`	Emitted when drop uri list needs to be handled [signal]
`openFile`	Emitted when a file needs to be opened [signal]

actionEvent(self, QActionEvent)¶

addFavorite(self)¶: Add current item to favorite.

Deprecated since version will: be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead

addFavoriteDirectory(self, favDir: str, name: str = '')¶

Add directory to favorites.

Deprecated since version will: be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead

addFavoriteDirectory(self) Add directory from file dialog to favorite.

Deprecated since version will: be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead

Parameters

favDir (str) –
name (str = '') –

addLayerAtIndex(self, index: QModelIndex) → bool¶

Adds the layer corresponding to the specified model index.

Returns True if the index was successfully intrepreted as a map layer and loaded, or False if the index is not a map layer or could not be loaded.

Deprecated since version will: be removed in QGIS 4.0 - retrieve the QgsLayerItem itself and manually add to project.

Parameters: index (QModelIndex) –
Return type: bool

addSelectedLayers(self)¶: Add selected layers to the project

changeEvent(self, QEvent)¶

childEvent(self, QChildEvent)¶

closeEvent(self, QCloseEvent)¶

connectNotify(self, QMetaMethod)¶

connectionsChanged¶: Connections changed in the browser [signal]

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)¶

enablePropertiesWidget(self, enable: bool)¶

Enable/disable properties widget

Parameters: enable (bool) –

enterEvent(self, QEvent)¶

event(self, QEvent) → bool¶

focusInEvent(self, QFocusEvent)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, bool) → bool¶

focusOutEvent(self, QFocusEvent)¶

focusPreviousChild(self) → bool¶

handleDropUriList¶: Emitted when drop uri list needs to be handled [signal]

hideEvent(self, QHideEvent)¶

hideItem(self)¶: Hide current item

initPainter(self, QPainter)¶

initStyleOption(self, QStyleOptionDockWidget)¶

inputMethodEvent(self, QInputMethodEvent)¶

isSignalConnected(self, QMetaMethod) → bool¶

keyPressEvent(self, QKeyEvent)¶

keyReleaseEvent(self, QKeyEvent)¶

leaveEvent(self, QEvent)¶

messageBar(self) → QgsMessageBar¶

Returns the message bar associated with the dock.