Class: QgsBrowserDockWidget

class qgis.gui.QgsBrowserDockWidget(name: str, browserModel: QgsBrowserModel, parent: QWidget = None)

Bases: QgsDockWidget

Constructor for QgsBrowserDockWidget

Parameters
  • name (str) – name of the widget

  • browserModel (QgsBrowserModel) – instance of the (shared) browser model

  • parent (QWidget = None) – parent widget

The QgsBrowserDockWidget class

Methods

actionEvent

addFavorite

Add current item to favorite

addFavoriteDirectory

Add directory to favorites

addLayerAtIndex

Add layer at 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

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

setCaseSensitive

Sets filter case sensitivity

setFilter

Apply filter to the model

setFilterSyntax

Sets filter syntax

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()
addFavorite(self)

Add current item to favorite

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

Add directory to favorites

addFavoriteDirectory(self) Add directory from file dialog to favorite

Parameters
  • favDir (str) –

  • name (str = '') –

addLayerAtIndex(self, index: QModelIndex)

Add layer at index

Parameters

index (QModelIndex) –

addSelectedLayers(self)

Add selected layers to the project

changeEvent()
childEvent()
closeEvent()
connectNotify()
connectionsChanged

Connections changed in the browser [signal]

contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enablePropertiesWidget(self, enable: bool)

Enable/disable properties widget

Parameters

enable (bool) –

enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
handleDropUriList

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

hideEvent()
hideItem(self)

Hide current item

initPainter()
initStyleOption()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
openFile

Emitted when a file needs to be opened [signal]

paintEvent()
receivers()
refresh(self)

Refresh browser view model (and view)

removeFavorite(self)

Remove from favorite

resizeEvent()
selectionChanged(self, selected: QItemSelection, deselected: QItemSelection)

Selection has changed

Parameters
  • selected (QItemSelection) –

  • deselected (QItemSelection) –

sender()
senderSignalIndex()
setCaseSensitive(self, caseSensitive: bool)

Sets filter case sensitivity

Parameters

caseSensitive (bool) –

setFilter(self)

Apply filter to the model

setFilterSyntax(self, QAction)

Sets filter syntax

sharedPainter()
showContextMenu(self, QPoint)

Show context menu

showEvent(self, event: QShowEvent)

Show event override

Parameters

event (QShowEvent) –

showFilterWidget(self, visible: bool)

Show/hide filter widget

Parameters

visible (bool) –

showProperties(self)

Show the layer properties

splitterMoved(self)

Splitter has been moved

tabletEvent()
timerEvent()
toggleFastScan(self)

Toggle fast scan

updateMicroFocus()
updateProjectHome(self)

Update project home directory

wheelEvent()