Class: QgsBrowserDockWidget¶
-
class
qgis.gui.
QgsBrowserDockWidget
(name: str, browserModel: QgsBrowserModel, parent: QWidget = None)¶ Bases:
qgis._gui.QgsDockWidget
Constructor for QgsBrowserDockWidget
- Parameters
name – name of the widget
browserModel – instance of the (shared) browser model
parent – parent widget
The QgsBrowserDockWidget class
New in version 3.0: Enums
Methods
Add current item to favorite.
Add directory to favorites.
Adds the layer corresponding to the specified model
index
.Add selected layers to the project
Enable/disable properties widget
Hide current item
Returns the message bar associated with the dock.
Refresh browser view model (and view)
Remove from favorite.
Selection has changed
Sets filter case sensitivity
Apply filter to the model
Sets filter syntax
Sets a message
bar
to use alongside the dock widget.Show context menu
Show event override
Show/hide filter widget
Show the layer properties
Splitter has been moved
Toggle fast scan
Update project home directory
Signals
Connections changed in the browser [signal]
Emitted when drop uri list needs to be handled [signal]
Emitted when a file needs to be opened [signal]
Attributes
-
actionEvent
()¶
-
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
-
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.
-
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
-
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
()¶
-
messageBar
(self) → QgsMessageBar¶ Returns the message bar associated with the dock.
See also
New in version 3.6.
-
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.
Deprecated since version will: be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
-
resizeEvent
()¶
-
selectionChanged
(self, selected: QItemSelection, deselected: QItemSelection)¶ Selection has changed
-
sender
()¶
-
senderSignalIndex
()¶
-
setCaseSensitive
(self, caseSensitive: bool)¶ Sets filter case sensitivity
-
setFilter
(self)¶ Apply filter to the model
-
setFilterSyntax
(self, QAction)¶ Sets filter syntax
-
setMessageBar
(self, bar: QgsMessageBar)¶ Sets a message
bar
to use alongside the dock 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
New in version 3.6.
-
showContextMenu
(self, QPoint)¶ Show context menu
-
showEvent
(self, event: QShowEvent)¶ Show event override
-
showFilterWidget
(self, visible: bool)¶ Show/hide filter widget
-
showProperties
(self)¶ Show the layer properties
-
splitterMoved
(self)¶ Splitter has been moved
-
tabletEvent
()¶
-
timerEvent
()¶
-
toggleFastScan
(self)¶ Toggle fast scan
Deprecated since version will: be removed in QGIS 4.0
-
updateMicroFocus
()¶
-
updateProjectHome
(self)¶ Update project home directory
-
wheelEvent
()¶