Class: QgsBrowserModel¶
-
class
qgis.core.
QgsBrowserModel
(parent: QObject = None)¶ Bases:
PyQt5.QtCore.QAbstractItemModel
Constructor for
QgsBrowserModel
, with the specifiedparent
object.Note
QgsBrowserModel
models are not initially populated and use a deferred initialization approach. After constructing aQgsBrowserModel
, a call must be made to initialize() in order to populate the model.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 aQgsBrowserModel
, a call must be made to initialize() in order to populate the model.- Parameters
parent –
-
CommentRole
= 257¶
-
class
ItemDataRole
¶ Bases:
int
-
PathRole
= 256¶
-
SortRole
= 258¶
-
addFavoriteDirectory
(self, directory: str, name: str = '')¶ 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 matchdirectory
.See also
New in version 3.0.
- Parameters
directory (str) –
name (str = '') –
-
addRootItems
(self)¶ Populates the model
-
beginInsertColumns
()¶
-
beginInsertItems
(self, parent: QgsDataItem, first: int, last: int)¶ - Parameters
parent (QgsDataItem) –
first (int) –
last (int) –
-
beginInsertRows
()¶
-
beginMoveColumns
()¶
-
beginMoveRows
()¶
-
beginRemoveColumns
()¶
-
beginRemoveItems
(self, parent: QgsDataItem, first: int, last: int)¶ - Parameters
parent (QgsDataItem) –
first (int) –
last (int) –
-
beginRemoveRows
()¶
-
beginResetModel
()¶
-
canFetchMore
(self, parent: QModelIndex) → bool¶ - Parameters
parent (QModelIndex) –
- Return type
bool
-
changePersistentIndex
()¶
-
changePersistentIndexList
()¶
-
childEvent
()¶
-
columnCount
(self, parent: QModelIndex = QModelIndex()) → int¶ - Parameters
parent (QModelIndex = QModelIndex()) –
- Return type
int
-
connectItem
(self, item: QgsDataItem)¶ Deprecated since version Deprecated: since QGIS 3.4 – this method has no effect, and is dangerous to call in earlier QGIS versions. Any usage should be removed (and will have no harmful side-effects!).
- Parameters
item (QgsDataItem) –
-
connectNotify
()¶
-
connectionsChanged
¶ Connections changed in the browser, forwarded to the widget and used to notify the provider dialogs of a changed connection [signal]
-
createIndex
()¶
-
customEvent
()¶
-
data
(self, index: QModelIndex, role: int = Qt.DisplayRole) → Any¶ - Parameters
index (QModelIndex) –
role (int = Qt.DisplayRole) –
- Return type
Any
-
dataItem
(self, idx: QModelIndex) → QgsDataItem¶ Returns the data item at the specified index, or a None if no item exists at the index.
- Parameters
idx (QModelIndex) –
- Return type
-
decodeData
()¶
-
disconnectNotify
()¶
-
dropMimeData
(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) → bool¶ - Parameters
data (QMimeData) –
action (Qt.DropAction) –
row (int) –
column (int) –
parent (QModelIndex) –
- Return type
bool
-
encodeData
()¶
-
endInsertColumns
()¶
-
endInsertItems
(self)¶
-
endInsertRows
()¶
-
endMoveColumns
()¶
-
endMoveRows
()¶
-
endRemoveColumns
()¶
-
endRemoveItems
(self)¶
-
endRemoveRows
()¶
-
endResetModel
()¶
-
fetchMore
(self, parent: QModelIndex)¶ - Parameters
parent (QModelIndex) –
-
findItem
(self, item: QgsDataItem, parent: QgsDataItem = None) → QModelIndex¶ Returns the model index corresponding to the specified data
item
. If the item was not found, an invalid QModelIndex is returned.If the
parent
item is argument is specified, then only items which are children ofparent
are searched. If noparent
is specified, then all items within the model are searched.- Parameters
item (QgsDataItem) –
parent (
QgsDataItem
= None) –
- Return type
QModelIndex
-
findPath
(self, path: str, matchFlag: Qt.MatchFlag = Qt.MatchExactly) → QModelIndex¶ Returns index of item with given path. It only searches in currently fetched items, i.e. it does not fetch children.
- Parameters
path (str) – item path
matchFlag (Qt.MatchFlag = Qt.MatchExactly) – supported is Qt.MatchExactly and Qt.MatchStartsWith which has reverse meaning, i.e. find item with the longest match from start with path (to get as close/deep as possible to deleted item).
- Return type
QModelIndex
- Returns
model index, invalid if item not found *
-
flags
(self, index: QModelIndex) → Qt.ItemFlags¶ - Parameters
index (QModelIndex) –
- Return type
Qt.ItemFlags
-
hasChildren
(self, parent: QModelIndex = QModelIndex()) → bool¶ - Parameters
parent (QModelIndex = QModelIndex()) –
- Return type
bool
-
headerData
(self, section: int, orientation: Qt.Orientation, role: int = Qt.DisplayRole) → Any¶ - Parameters
section (int) –
orientation (Qt.Orientation) –
role (int = Qt.DisplayRole) –
- Return type
Any
-
hidePath
(self, item: QgsDataItem)¶ Hide the given path in the browser model
- Parameters
item (QgsDataItem) –
-
index
(self, row: int, column: int, parent: QModelIndex = QModelIndex()) → QModelIndex¶ - Parameters
row (int) –
column (int) –
parent (QModelIndex = QModelIndex()) –
- Return type
QModelIndex
-
initialize
(self)¶ Delayed initialization, needed because the provider registry must be already populated.
See also
-
initialized
(self) → bool¶ Returns true if the model has been initialized.
See also
- Return type
bool
-
isSignalConnected
()¶
-
itemDataChanged
(self, item: QgsDataItem)¶ - Parameters
item (QgsDataItem) –
-
itemStateChanged
(self, item: QgsDataItem, oldState: QgsDataItem.State)¶ - Parameters
item (QgsDataItem) –
oldState (QgsDataItem.State) –
-
mimeData
(self, indexes: object) → QMimeData¶ - Parameters
indexes (object) –
- Return type
QMimeData
-
mimeTypes
(self) → List[str]¶ - Return type
List[str]
-
parent
(self, index: QModelIndex) → QModelIndex¶ - Parameters
index (QModelIndex) –
- Return type
QModelIndex
-
persistentIndexList
()¶
-
receivers
()¶
-
refresh
(self, path: str)¶ Refresh item specified by path
refresh(self, index: QModelIndex = QModelIndex()) Refresh item children
- Parameters
path (str) –
-
refreshDrives
(self)¶ Refreshes the list of drive items, removing any corresponding to removed drives and adding newly added drives.
New in version 3.4.
-
reload
(self)¶ Reload the whole model
-
removeFavorite
(self, index: QModelIndex)¶ Removes a favorite directory from its corresponding model index.
See also
New in version 3.0.
- Parameters
index (QModelIndex) –
-
removeRootItems
(self)¶
-
resetInternalData
()¶
-
rowCount
(self, parent: QModelIndex = QModelIndex()) → int¶ - Parameters
parent (QModelIndex = QModelIndex()) –
- Return type
int
-
sender
()¶
-
senderSignalIndex
()¶
-
setData
(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) → bool¶ - Parameters
index (QModelIndex) –
value (Any) –
role (int = Qt.EditRole) –
- Return type
bool
-
stateChanged
¶ Emitted when item children fetch was finished [signal]
-
timerEvent
()¶
-
updateProjectHome
(self)¶