Class: QgsBrowserModel¶

A model for showing available data sources and other items in a structured tree.

QgsBrowserModel is the foundation for the QGIS browser panel, and includes items for the different data providers and folders accessible to users.

QgsBrowserModel models are not initially populated and use a deferred initialization approach. After constructing a QgsBrowserModel, a call must be made to initialize() in order to populate the model.

Note

Since QGIS 3.10 it is recommended to use QgsBrowserGuiModel from GUI library. Implementation of data items used from QgsBrowserModel should not trigger any GUI operations such as opening of widgets/dialogs or showing message boxes. Such actions should be implemented in a new QgsDataItemGuiProvider subclass which is used by QgsBrowserGuiModel (but not by QgsBrowserModel).

Class Hierarchy¶

Base classes¶

QAbstractItemModel
QObject

Subclasses¶

QgsBrowserGuiModel

A model for showing available data sources and other items in a structured tree.

Enums

`CustomRole`	Custom model roles.
`ItemDataRole`	alias of `CustomRole`

Methods

`addFavoriteDirectory`	Adds a directory to the favorites group.
`addRootItems`	Populates the model
`beginInsertItems`
`beginRemoveItems`
`connectItem`
`dataItem`	Returns the data item at the specified index, or `None` if no item exists at the index.
`driveItems`	Returns a map of the root drive items shown in the browser.
`endInsertItems`
`endRemoveItems`
`findItem`	Returns the model index corresponding to the specified data item.
`findPath`	Returns index of item with given path.
`findUri`	Returns index of layer item with given uri.
`hidePath`	Hide the given path in the browser model
`initialize`	Delayed initialization, needed because the provider registry must be already populated.
`initialized`	Returns `True` if the model has been initialized.
`itemDataChanged`
`itemStateChanged`	Emitted when an item's state is changed.
`refresh`	Refresh item specified by path
`refreshDrives`	Refreshes the list of drive items, removing any corresponding to removed drives and adding newly added drives.
`reload`	Reload the whole model
`removeFavorite`	Removes a favorite directory from its corresponding model index.
`removeRootItems`
`rootItems`	Returns the root items for the model.
`updateProjectHome`

Signals

`connectionsChanged`	Emitted when connections for the specified providerKey have changed in the browser.
`stateChanged`	Emitted when item children fetch was finished

class qgis.core.QgsBrowserModel[source]¶

Bases: QAbstractItemModel

__init__(parent: QObject | None = None)

Constructor for QgsBrowserModel, with the specified parent object.

Note

QgsBrowserModel models are not initially populated and use a deferred initialization approach. After constructing a QgsBrowserModel, a call must be made to initialize() in order to populate the model.

Parameters:: parent (Optional[QObject] = None)

class CustomRole(*values)¶

Bases: IntEnum

Custom model roles.

Note

Prior to QGIS 3.36 this was available as QgsBrowserModel.ItemDataRole

Added in version 3.36.

Path: Item path used to access path in the tree, see QgsDataItem.mPath

Available as QgsBrowserModel.PathRole in older QGIS releases.
Comment: Item comment

Available as QgsBrowserModel.CommentRole in older QGIS releases.
Sort: Custom sort role, see QgsDataItem.sortKey()

Available as QgsBrowserModel.SortRole in older QGIS releases.
ProviderKey: Data item provider key that created the item, see QgsDataItem.providerKey()

Added in version 3.12.

Available as QgsBrowserModel.ProviderKeyRole in older QGIS releases.
LayerMetadata:

Available as QgsBrowserModel.LayerMetadataRole in older QGIS releases.

ItemDataRole¶: alias of CustomRole

addFavoriteDirectory(self, directory: str | None, name: str | None = '')[source]¶

Adds a directory to the favorites group.

If name is specified, it will be used as the favorite’s name. Otherwise the name will be set to match directory.