QGIS API Documentation
3.2.0-Bonn (bc43194)
|
A model for showing available data sources and other items in a structured tree. More...
#include <qgsbrowsermodel.h>
Public Types | |
enum | ItemDataRole { PathRole = Qt::UserRole, CommentRole = Qt::UserRole + 1, SortRole } |
Public Slots | |
void | addFavoriteDirectory (const QString &directory, const QString &name=QString()) |
Adds a directory to the favorites group. More... | |
void | beginInsertItems (QgsDataItem *parent, int first, int last) |
void | beginRemoveItems (QgsDataItem *parent, int first, int last) |
void | endInsertItems () |
void | endRemoveItems () |
void | hidePath (QgsDataItem *item) |
Hide the given path in the browser model. More... | |
void | initialize () |
Delayed initialization, needed because the provider registry must be already populated. More... | |
void | itemDataChanged (QgsDataItem *item) |
void | itemStateChanged (QgsDataItem *item, QgsDataItem::State oldState) |
void | reload () |
Reload the whole model. More... | |
void | removeFavorite (const QModelIndex &index) |
Removes a favorite directory from its corresponding model index. More... | |
void | updateProjectHome () |
Signals | |
void | connectionsChanged () |
Connections changed in the browser, forwarded to the widget and used to notify the provider dialogs of a changed connection. More... | |
void | stateChanged (const QModelIndex &index, QgsDataItem::State oldState) |
Emitted when item children fetch was finished. More... | |
Public Member Functions | |
QgsBrowserModel (QObject *parent=nullptr) | |
Constructor for QgsBrowserModel, with the specified parent object. More... | |
~QgsBrowserModel () override | |
bool | canFetchMore (const QModelIndex &parent) const override |
int | columnCount (const QModelIndex &parent=QModelIndex()) const override |
void | connectItem (QgsDataItem *item) |
QVariant | data (const QModelIndex &index, int role=Qt::DisplayRole) const override |
QgsDataItem * | dataItem (const QModelIndex &idx) const |
bool | dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override |
void | fetchMore (const QModelIndex &parent) override |
QModelIndex | findItem (QgsDataItem *item, QgsDataItem *parent=nullptr) const |
QModelIndex | findPath (const QString &path, Qt::MatchFlag matchFlag=Qt::MatchExactly) |
Returns index of item with given path. More... | |
Qt::ItemFlags | flags (const QModelIndex &index) const override |
bool | hasChildren (const QModelIndex &parent=QModelIndex()) const override |
QVariant | headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override |
QModelIndex | index (int row, int column, const QModelIndex &parent=QModelIndex()) const override |
bool | initialized () const |
Returns true if the model has been initialized. More... | |
QMimeData * | mimeData (const QModelIndexList &indexes) const override |
QStringList | mimeTypes () const override |
QModelIndex | parent (const QModelIndex &index) const override |
void | refresh (const QString &path) |
Refresh item specified by path. More... | |
void | refresh (const QModelIndex &index=QModelIndex()) |
Refresh item children. More... | |
int | rowCount (const QModelIndex &parent=QModelIndex()) const override |
Static Public Member Functions | |
static QModelIndex | findPath (QAbstractItemModel *model, const QString &path, Qt::MatchFlag matchFlag=Qt::MatchExactly) |
Protected Member Functions | |
void | addRootItems () |
Populates the model. More... | |
void | removeRootItems () |
Protected Attributes | |
QgsFavoritesItem * | mFavorites = nullptr |
QgsDirectoryItem * | mProjectHome = nullptr |
QVector< QgsDataItem * > | mRootItems |
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.
Definition at line 65 of file qgsbrowsermodel.h.
Enumerator | |
---|---|
PathRole | Item path used to access path in the tree, see QgsDataItem::mPath. |
CommentRole | Item comment. |
SortRole | Custom sort role, see QgsDataItem::sortKey() |
Definition at line 82 of file qgsbrowsermodel.h.
|
explicit |
Constructor for QgsBrowserModel, with the specified parent object.
Definition at line 45 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 51 of file qgsbrowsermodel.cpp.
|
slot |
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.
Definition at line 540 of file qgsbrowsermodel.cpp.
|
protected |
Populates the model.
Definition at line 83 of file qgsbrowsermodel.cpp.
|
slot |
Definition at line 385 of file qgsbrowsermodel.cpp.
|
slot |
Definition at line 400 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 501 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 288 of file qgsbrowsermodel.cpp.
|
signal |
Connections changed in the browser, forwarded to the widget and used to notify the provider dialogs of a changed connection.
void QgsBrowserModel::connectItem | ( | QgsDataItem * | item | ) |
Definition at line 432 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 204 of file qgsbrowsermodel.cpp.
QgsDataItem * QgsBrowserModel::dataItem | ( | const QModelIndex & | idx | ) | const |
Definition at line 493 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 478 of file qgsbrowsermodel.cpp.
|
slot |
Definition at line 395 of file qgsbrowsermodel.cpp.
|
slot |
Definition at line 408 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 509 of file qgsbrowsermodel.cpp.
QModelIndex QgsBrowserModel::findItem | ( | QgsDataItem * | item, |
QgsDataItem * | parent = nullptr |
||
) | const |
Definition at line 368 of file qgsbrowsermodel.cpp.
QModelIndex QgsBrowserModel::findPath | ( | const QString & | path, |
Qt::MatchFlag | matchFlag = Qt::MatchExactly |
||
) |
Returns index of item with given path.
It only searches in currently fetched items, i.e. it does not fetch children.
path | item path |
matchFlag | 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). |
Definition at line 294 of file qgsbrowsermodel.cpp.
|
static |
Definition at line 299 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 188 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 279 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 250 of file qgsbrowsermodel.cpp.
|
slot |
Hide the given path in the browser model.
Definition at line 555 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 348 of file qgsbrowsermodel.cpp.
|
slot |
Delayed initialization, needed because the provider registry must be already populated.
Definition at line 175 of file qgsbrowsermodel.cpp.
|
inline |
Returns true if the model has been initialized.
Definition at line 133 of file qgsbrowsermodel.h.
|
slot |
Definition at line 413 of file qgsbrowsermodel.cpp.
|
slot |
Definition at line 421 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 462 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 453 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 359 of file qgsbrowsermodel.cpp.
void QgsBrowserModel::refresh | ( | const QString & | path | ) |
Refresh item specified by path.
Definition at line 522 of file qgsbrowsermodel.cpp.
void QgsBrowserModel::refresh | ( | const QModelIndex & | index = QModelIndex() | ) |
Refresh item children.
Definition at line 529 of file qgsbrowsermodel.cpp.
|
slot |
Reload the whole model.
Definition at line 339 of file qgsbrowsermodel.cpp.
|
slot |
Removes a favorite directory from its corresponding model index.
Definition at line 546 of file qgsbrowsermodel.cpp.
|
protected |
Definition at line 165 of file qgsbrowsermodel.cpp.
|
override |
Definition at line 261 of file qgsbrowsermodel.cpp.
|
signal |
Emitted when item children fetch was finished.
|
slot |
Definition at line 56 of file qgsbrowsermodel.cpp.
|
protected |
Definition at line 190 of file qgsbrowsermodel.h.
|
protected |
Definition at line 191 of file qgsbrowsermodel.h.
|
protected |
Definition at line 189 of file qgsbrowsermodel.h.