Subgroup: Browser

Class: QgsBrowserDockWidget¶

class qgis.gui.QgsBrowserDockWidget¶

Bases: qgis._gui.QgsDockWidget

The QgsBrowserDockWidget class

New in version 3.0: Methods

`acceptDrops`
`accessibleDescription`
`accessibleName`
`actionEvent`
`actions`
`activateWindow`
`addAction`
`addActions`
`addFavorite`	Add current item to favorite
`addFavoriteDirectory`	Add directory to favorites
`addLayerAtIndex`	Add layer at index
`addSelectedLayers`	Add selected layers to the project
`adjustSize`
`allowedAreas`
`autoFillBackground`
`backgroundRole`
`baseSize`
`blockSignals`
`changeEvent`
`childAt`	childAt(self, int, int) -> QWidget
`childEvent`
`children`
`childrenRect`
`childrenRegion`
`clearFocus`
`clearMask`
`close`
`closeEvent`
`colorCount`
`connectNotify`
`contentsMargins`
`contentsRect`
`contextMenuEvent`
`contextMenuPolicy`
`create`
`createWindowContainer`
`cursor`
`customEvent`
`deleteLater`
`depth`
`destroy`
`devType`
`devicePixelRatio`
`devicePixelRatioF`
`devicePixelRatioFScale`
`disconnect`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`effectiveWinId`
`enablePropertiesWidget`	Enable/disable properties widget
`ensurePolished`
`enterEvent`
`event`
`eventFilter`
`features`
`find`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPolicy`
`focusPreviousChild`
`focusProxy`
`focusWidget`
`font`
`fontInfo`
`fontMetrics`
`foregroundRole`
`frameGeometry`
`frameSize`
`geometry`
`getContentsMargins`
`grab`
`grabGesture`
`grabKeyboard`
`grabMouse`	grabMouse(self, Union[QCursor, Qt.CursorShape])
`grabShortcut`
`graphicsEffect`
`graphicsProxyWidget`
`hasFocus`
`hasHeightForWidth`
`hasMouseTracking`
`hasTabletTracking`
`height`
`heightForWidth`
`heightMM`
`hide`
`hideEvent`
`hideItem`	Hide current item
`inherits`
`initPainter`
`initStyleOption`
`inputMethodEvent`
`inputMethodHints`
`inputMethodQuery`
`insertAction`
`insertActions`
`installEventFilter`
`isActiveWindow`
`isAncestorOf`
`isAreaAllowed`
`isEnabled`
`isEnabledTo`
`isFloating`
`isFullScreen`
`isHidden`
`isLeftToRight`
`isMaximized`
`isMinimized`
`isModal`
`isRightToLeft`
`isSignalConnected`
`isUserVisible`	Returns true if the dock is both opened and raised to the front (ie not hidden by any other tabs.
`isVisible`
`isVisibleTo`
`isWidgetType`
`isWindow`
`isWindowModified`
`isWindowType`
`keyPressEvent`
`keyReleaseEvent`
`keyboardGrabber`
`killTimer`
`layout`
`layoutDirection`
`leaveEvent`
`locale`
`logicalDpiX`
`logicalDpiY`
`lower`
`mapFrom`
`mapFromGlobal`
`mapFromParent`
`mapTo`
`mapToGlobal`
`mapToParent`
`mask`
`maximumHeight`
`maximumSize`
`maximumWidth`
`metaObject`
`metric`
`minimumHeight`
`minimumSize`
`minimumSizeHint`
`minimumWidth`
`mouseDoubleClickEvent`
`mouseGrabber`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`move`	move(self, int, int)
`moveEvent`
`moveToThread`
`nativeEvent`
`nativeParentWidget`
`nextInFocusChain`
`normalGeometry`
`objectName`
`overrideWindowFlags`
`overrideWindowState`
`paintEngine`
`paintEvent`
`paintingActive`
`palette`
`parent`
`parentWidget`
`physicalDpiX`
`physicalDpiY`
`pos`
`previousInFocusChain`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`raise_`
`receivers`
`rect`
`refresh`	Refresh browser view model (and view)
`releaseKeyboard`
`releaseMouse`
`releaseShortcut`
`removeAction`
`removeEventFilter`
`removeFavorite`	Remove from favorite
`render`	render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground\|QWidget.DrawChildren))
`repaint`	repaint(self, int, int, int, int)
`resize`	resize(self, int, int)
`resizeEvent`
`restoreGeometry`
`saveGeometry`
`scroll`	scroll(self, int, int, QRect)
`selectionChanged`	Selection has changed
`sender`
`senderSignalIndex`
`setAcceptDrops`
`setAccessibleDescription`
`setAccessibleName`
`setAllowedAreas`
`setAttribute`
`setAutoFillBackground`
`setBackgroundRole`
`setBaseSize`	setBaseSize(self, QSize)
`setCaseSensitive`	Set filter case sensitivity
`setContentsMargins`	setContentsMargins(self, QMargins)
`setContextMenuPolicy`
`setCursor`
`setDisabled`
`setEnabled`
`setFeatures`
`setFilter`	Apply filter to the model
`setFilterSyntax`	Set filter syntax
`setFixedHeight`
`setFixedSize`	setFixedSize(self, int, int)
`setFixedWidth`
`setFloating`
`setFocus`	setFocus(self, Qt.FocusReason)
`setFocusPolicy`
`setFocusProxy`
`setFont`
`setForegroundRole`
`setGeometry`	setGeometry(self, int, int, int, int)
`setGraphicsEffect`
`setHidden`
`setInputMethodHints`
`setLayout`
`setLayoutDirection`
`setLocale`
`setMask`	setMask(self, QRegion)
`setMaximumHeight`
`setMaximumSize`	setMaximumSize(self, QSize)
`setMaximumWidth`
`setMinimumHeight`
`setMinimumSize`	setMinimumSize(self, QSize)
`setMinimumWidth`
`setMouseTracking`
`setObjectName`
`setPalette`
`setParent`	setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
`setProperty`
`setShortcutAutoRepeat`
`setShortcutEnabled`
`setSizeIncrement`	setSizeIncrement(self, QSize)
`setSizePolicy`	setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
`setStatusTip`
`setStyle`
`setStyleSheet`
`setTabOrder`
`setTabletTracking`
`setTitleBarWidget`
`setToolTip`
`setToolTipDuration`
`setUpdatesEnabled`
`setUserVisible`	Sets the dock widget as visible to a user, ie both shown and raised to the front.
`setVisible`
`setWhatsThis`
`setWidget`
`setWindowFilePath`
`setWindowFlag`
`setWindowFlags`
`setWindowIcon`
`setWindowIconText`
`setWindowModality`
`setWindowModified`
`setWindowOpacity`
`setWindowRole`
`setWindowState`
`setWindowTitle`
`sharedPainter`
`show`
`showContextMenu`	Show context menu
`showEvent`	Show event override
`showFilterWidget`	Show/hide filter widget
`showFullScreen`
`showMaximized`
`showMinimized`
`showNormal`
`showProperties`	Show the layer properties
`signalsBlocked`
`size`
`sizeHint`
`sizeIncrement`
`sizePolicy`
`splitterMoved`	Splitter has been moved
`stackUnder`
`startTimer`
`statusTip`
`style`
`styleSheet`
`tabletEvent`
`testAttribute`
`thread`
`timerEvent`
`titleBarWidget`
`toggleFastScan`	Toggle fast scan
`toggleViewAction`
`toolTip`
`toolTipDuration`
`tr`
`underMouse`
`ungrabGesture`
`unsetCursor`
`unsetLayoutDirection`
`unsetLocale`
`update`	update(self, QRect)
`updateGeometry`
`updateMicroFocus`
`updateProjectHome`	Update project home directory
`updatesEnabled`
`visibleRegion`
`whatsThis`
`wheelEvent`
`widget`
`width`
`widthMM`
`winId`
`window`
`windowFilePath`
`windowFlags`
`windowHandle`
`windowIcon`
`windowIconText`
`windowModality`
`windowOpacity`
`windowRole`
`windowState`
`windowTitle`
`windowType`
`x`
`y`

Attributes

`AllDockWidgetFeatures`
`DockWidgetClosable`
`DockWidgetFloatable`
`DockWidgetMovable`
`DockWidgetVerticalTitleBar`
`DrawChildren`
`DrawWindowBackground`
`IgnoreMask`
`NoDockWidgetFeatures`
`PdmDepth`
`PdmDevicePixelRatio`
`PdmDevicePixelRatioScaled`
`PdmDpiX`
`PdmDpiY`
`PdmHeight`
`PdmHeightMM`
`PdmNumColors`
`PdmPhysicalDpiX`
`PdmPhysicalDpiY`
`PdmWidth`
`PdmWidthMM`
`closed`	Emitted when dock widget is closed.
`closedStateChanged`	Emitted when dock widget is closed (or opened).
`connectionsChanged`	Connections changed in the browser [signal]
`customContextMenuRequested`	customContextMenuRequested(self, QPoint) [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`featuresChanged`	featuresChanged(self, Union[QDockWidget.DockWidgetFeatures, QDockWidget.DockWidgetFeature]) [signal]
`handleDropUriList`	Emitted when drop uri list needs to be handled [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`openFile`	Emitted when a file needs to be opened [signal]
`opened`	Emitted when dock widget is opened.
`openedStateChanged`	Emitted when dock widget is opened (or closed).
`staticMetaObject`
`topLevelChanged`	topLevelChanged(self, bool) [signal]
`visibilityChanged`	visibilityChanged(self, bool) [signal]
`windowIconChanged`	windowIconChanged(self, QIcon) [signal]
`windowIconTextChanged`	windowIconTextChanged(self, str) [signal]
`windowTitleChanged`	windowTitleChanged(self, str) [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

addLayerAtIndex(self, index: QModelIndex)¶: Add layer at index

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

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

sender()¶

senderSignalIndex()¶

setCaseSensitive(self, caseSensitive: bool)¶: Set filter case sensitivity

setFilter(self)¶: Apply filter to the model

setFilterSyntax(self, QAction)¶: Set filter syntax

sharedPainter()¶

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

updateMicroFocus()¶

updateProjectHome(self)¶: Update project home directory

wheelEvent()¶