QGIS API Documentation 3.41.0-Master (3440c17df1d)
|
Base class for all items in the model. More...
#include <qgsdataitem.h>
Public Slots | |
virtual void | childrenCreated () |
virtual void | deleteLater () |
Safely delete the item: | |
virtual void | depopulate () |
Remove children recursively and set as not populated. This is used when refreshing collapsed items. | |
virtual void | populate (bool foreground=false) |
virtual void | refresh () |
virtual void | refreshConnections (const QString &providerKey=QString()) |
Causes a data item provider to refresh all registered connections. | |
Signals | |
void | beginInsertItems (QgsDataItem *parent, int first, int last) |
Emitted before child items are added to this data item. | |
void | beginRemoveItems (QgsDataItem *parent, int first, int last) |
Emitted before child items are removed from this data item. | |
void | connectionsChanged (const QString &providerKey=QString()) |
Emitted when the connections of the provider with the specified providerKey have changed. | |
void | dataChanged (QgsDataItem *item) |
Emitted when data changes for an item. | |
void | endInsertItems () |
Emitted after child items have been added to this data item. | |
void | endRemoveItems () |
Emitted after child items have been removed from this data item. | |
void | stateChanged (QgsDataItem *item, Qgis::BrowserItemState oldState) |
Emitted when an item's state is changed. | |
Public Member Functions | |
QgsDataItem (Qgis::BrowserItemType type, QgsDataItem *parent, const QString &name, const QString &path, const QString &providerKey=QString()) | |
Constructor for QgsDataItem, with the specified parent item. | |
~QgsDataItem () override | |
virtual Q_DECL_DEPRECATED bool | acceptDrop () |
Returns whether the item accepts drag and dropped layers - e.g. | |
virtual QList< QAction * > | actions (QWidget *parent) |
Returns the list of actions available for this item. | |
virtual void | addChildItem (QgsDataItem *child, bool refresh=false) |
Inserts a new child item. | |
virtual Qgis::BrowserItemCapabilities | capabilities2 () const |
Returns the capabilities for the data item. | |
QVector< QgsDataItem * > | children () const |
virtual QVector< QgsDataItem * > | createChildren () |
Create children. | |
virtual QgsAbstractDatabaseProviderConnection * | databaseConnection () const |
For data items that represent a DB connection or one of its children, this method returns a connection. | |
virtual void | deleteChildItem (QgsDataItem *child) |
Removes and deletes a child item, emitting relevant signals to the model. | |
virtual bool | equal (const QgsDataItem *other) |
Returns true if this item is equal to another item (by testing item type and path). | |
virtual bool | handleDoubleClick () |
Called when a user double clicks on the item. | |
virtual Q_DECL_DEPRECATED bool | handleDrop (const QMimeData *, Qt::DropAction) |
Attempts to process the mime data dropped on this item. | |
bool | hasChildren () |
virtual bool | hasDragEnabled () const |
Returns true if the item may be dragged. | |
virtual QIcon | icon () |
virtual bool | layerCollection () const |
Returns true if the data item is a collection of layers The default implementation returns false , subclasses must implement this method if their children are layers. | |
virtual QList< QMenu * > | menus (QWidget *parent) |
Returns the list of menus available for this item. | |
virtual Q_DECL_DEPRECATED QgsMimeDataUtils::Uri | mimeUri () const |
Returns mime URI for the data item. | |
virtual QgsMimeDataUtils::UriList | mimeUris () const |
Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g. | |
void | moveToThread (QThread *targetThread) |
Move object and all its descendants to thread. | |
QString | name () const |
Returns the name of the item (the displayed text for the item). | |
virtual Q_DECL_DEPRECATED QWidget * | paramWidget () |
Returns source widget from data item for QgsBrowserPropertiesWidget. | |
QgsDataItem * | parent () const |
Gets item parent. | |
QString | path () const |
QString | providerKey () const |
Returns the provider key that created this item (e.g. | |
virtual QgsDataItem * | removeChildItem (QgsDataItem *child) |
Removes a child item and returns it without deleting it. | |
virtual Q_DECL_DEPRECATED bool | rename (const QString &name) |
Sets a new name for the item, and returns true if the item was successfully renamed. | |
int | rowCount () |
Q_DECL_DEPRECATED void | setCapabilities (int capabilities) |
virtual void | setCapabilities (Qgis::BrowserItemCapabilities capabilities) |
Sets the capabilities for the data item. | |
virtual Q_DECL_DEPRECATED bool | setCrs (const QgsCoordinateReferenceSystem &crs) |
Writes the selected crs into data source. | |
void | setIcon (const QIcon &icon) |
void | setIconName (const QString &iconName) |
void | setName (const QString &name) |
Sets the name of the item (the displayed text for the item). | |
void | setParent (QgsDataItem *parent) |
Set item parent and connect / disconnect parent to / from item signals. | |
void | setPath (const QString &path) |
void | setProviderKey (const QString &value) |
Sets the provider key that created this item (e.g. | |
void | setSortKey (const QVariant &key) |
Sets a custom sorting key for the item. | |
virtual void | setState (Qgis::BrowserItemState state) |
Set item state. | |
void | setToolTip (const QString &msg) |
virtual QVariant | sortKey () const |
Returns the sorting key for the item. | |
Qgis::BrowserItemState | state () const |
QString | toolTip () const |
Qgis::BrowserItemType | type () const |
Static Public Member Functions | |
static void | deleteLater (QVector< QgsDataItem * > &items) |
template<class T > | |
static QList< T * > | filteredItems (const QList< QgsDataItem * > &items) |
Returns a filtered list of data items which match the template type. | |
static int | findItem (QVector< QgsDataItem * > items, QgsDataItem *item) |
static QString | pathComponent (const QString &component) |
Create path component replacing path separators. | |
Protected Slots | |
void | updateIcon () |
Will request a repaint of this icon. | |
Protected Member Functions | |
bool | deferredDelete () |
The item is scheduled to be deleted. | |
virtual void | populate (const QVector< QgsDataItem * > &children) |
virtual void | refresh (const QVector< QgsDataItem * > &children) |
Refresh the items from a specified list of child items. | |
Protected Attributes | |
Qgis::BrowserItemCapabilities | mCapabilities = Qgis::BrowserItemCapability::NoCapabilities |
QVector< QgsDataItem * > | mChildren |
QIcon | mIcon |
QMap< QString, QIcon > | mIconMap |
QString | mIconName |
QString | mName |
QgsDataItem * | mParent = nullptr |
QString | mPath |
QString | mProviderKey |
QVariant | mSortKey |
Custom sort key. If invalid, name() will be used for sorting instead. | |
Qgis::BrowserItemState | mState = Qgis::BrowserItemState::NotPopulated |
QString | mToolTip |
Qgis::BrowserItemType | mType |
Base class for all items in the model.
Parent/children hierarchy is not based on QObject.
Definition at line 45 of file qgsdataitem.h.
QgsDataItem::QgsDataItem | ( | Qgis::BrowserItemType | type, |
QgsDataItem * | parent, | ||
const QString & | name, | ||
const QString & | path, | ||
const QString & | providerKey = QString() |
||
) |
Constructor for QgsDataItem, with the specified parent item.
The name argument specifies the text to show in the model for the item. A translated string should be used wherever appropriate.
The path argument gives the item path in the browser tree. The path string can take any form, but QgsDataItem items pointing to different logical locations should always use a different item path.
The optional providerKey string (added in QGIS 3.12) can be used to specify the key for the QgsDataItemProvider that created this item.
Definition at line 58 of file qgsdataitem.cpp.
|
override |
Definition at line 68 of file qgsdataitem.cpp.
|
inlinevirtual |
Returns whether the item accepts drag and dropped layers - e.g.
for importing a dataset to a provider. Subclasses should override this and handleDrop() to accept dropped layers.
Definition at line 215 of file qgsdataitem.h.
|
virtual |
Returns the list of actions available for this item.
This is usually used for the popup menu on right-clicking the item. Subclasses should override this to provide actions.
Subclasses should ensure that ownership of created actions is correctly handled by parenting them to the specified parent widget.
Definition at line 505 of file qgsdataitem.cpp.
|
virtual |
Inserts a new child item.
The child will be inserted at a position using an alphabetical order based on mName.
child | child item to insert. Ownership is transferred, and item parent will be set and relevant connections made. |
refresh | set to true to refresh populated item, emitting relevant signals to the model |
Definition at line 423 of file qgsdataitem.cpp.
|
signal |
Emitted before child items are added to this data item.
This signal must be followed by endInsertItems().
parent | the parent item having children added, will always be this object |
first | index of first child item to be added |
last | index last child item, after the addition has occurred |
|
signal |
Emitted before child items are removed from this data item.
This signal must be followed by endRemoveItems().
parent | the parent item having children removed, will always be this object |
first | index of first child item to be removed |
last | index of the last child item to be removed |
|
inlinevirtual |
Returns the capabilities for the data item.
Definition at line 297 of file qgsdataitem.h.
|
inline |
Definition at line 352 of file qgsdataitem.h.
|
virtualslot |
Definition at line 236 of file qgsdataitem.cpp.
|
signal |
Emitted when the connections of the provider with the specified providerKey have changed.
This signal is normally forwarded to the app in order to refresh the connection item in the provider dialogs and to refresh the connection items in the other open browsers.
|
virtual |
Create children.
Children are not expected to have parent set.
Reimplemented in QgsDirectoryItem, QgsFavoritesItem, QgsFieldDomainsItem, QgsFieldsItem, QgsProviderSublayerItem, QgsFileDataCollectionItem, QgsRelationshipsItem, and QgsZipItem.
Definition at line 185 of file qgsdataitem.cpp.
|
virtual |
For data items that represent a DB connection or one of its children, this method returns a connection.
All other data items will return NULL.
Ownership of the returned objects is transferred to the caller.
Reimplemented in QgsDatabaseSchemaItem, QgsDataCollectionItem, QgsProviderSublayerItem, QgsFileDataCollectionItem, and QgsLayerItem.
Definition at line 158 of file qgsdataitem.cpp.
|
signal |
Emitted when data changes for an item.
|
inlineprotected |
The item is scheduled to be deleted.
E.g. if deleteLater() is called when item is in Populating state (createChildren() running in another thread), the deferredDelete() returns true
and item will be deleted once Populating finished. Items with slow reateChildren() (for example network or database based) may check during createChildren() if deferredDelete() returns true
and return from createChildren() immediately because result will be useless.
Definition at line 455 of file qgsdataitem.h.
|
virtual |
Removes and deletes a child item, emitting relevant signals to the model.
child | child to remove. Item must exist as a current child. |
Definition at line 459 of file qgsdataitem.cpp.
|
virtualslot |
Safely delete the item:
Definition at line 107 of file qgsdataitem.cpp.
|
static |
Definition at line 131 of file qgsdataitem.cpp.
|
virtualslot |
Remove children recursively and set as not populated. This is used when refreshing collapsed items.
Definition at line 278 of file qgsdataitem.cpp.
|
signal |
Emitted after child items have been added to this data item.
This signal will always be preceded by beginInsertItems().
|
signal |
Emitted after child items have been removed from this data item.
This signal will always be preceded by beginRemoveItems().
|
virtual |
Returns true
if this item is equal to another item (by testing item type and path).
Reimplemented in QgsDirectoryItem, QgsFieldItem, and QgsLayerItem.
Definition at line 499 of file qgsdataitem.cpp.
|
inlinestatic |
Returns a filtered list of data items which match the template type.
Definition at line 324 of file qgsdataitem.h.
|
static |
Definition at line 487 of file qgsdataitem.cpp.
|
virtual |
Called when a user double clicks on the item.
Subclasses should return true
if they have implemented a double-click handler and do not want the default double-click behavior for items.
Definition at line 511 of file qgsdataitem.cpp.
|
inlinevirtual |
Attempts to process the mime data dropped on this item.
Subclasses must override this and acceptDrop() if they accept dropped layers.
Definition at line 230 of file qgsdataitem.h.
bool QgsDataItem::hasChildren | ( | ) |
Definition at line 395 of file qgsdataitem.cpp.
|
inlinevirtual |
Returns true
if the item may be dragged.
Default implementation returns false
. A draggable item has to implement mimeUris() that will be used to pass data.
Reimplemented in QgsDirectoryItem, QgsFileDataCollectionGroupItem, QgsFileDataCollectionItem, QgsLayerItem, QgsProjectItem, and QgsZipItem.
Definition at line 248 of file qgsdataitem.h.
|
virtual |
Reimplemented in QgsDirectoryItem, QgsProjectHomeItem, QgsFieldDomainsItem, QgsFieldDomainItem, QgsFieldsItem, QgsFieldItem, QgsRelationshipsItem, and QgsRelationshipItem.
Definition at line 163 of file qgsdataitem.cpp.
|
virtual |
Returns true
if the data item is a collection of layers The default implementation returns false
, subclasses must implement this method if their children are layers.
Definition at line 400 of file qgsdataitem.cpp.
|
virtual |
Returns the list of menus available for this item.
This is usually used for the popup menu on right-clicking the item. Subclasses should override this to provide actions. Subclasses should ensure that ownership of created menus is correctly handled by parenting them to the specified parent widget.
parent | a parent widget of the menu |
Definition at line 586 of file qgsdataitem.cpp.
|
virtual |
Returns mime URI for the data item.
Items that return valid URI will be returned in mime data when dragging a selection from browser model.
Definition at line 516 of file qgsdataitem.cpp.
|
virtual |
Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g.
GPKG, OGR) may report multiple URIs (e.g. for vector and raster layer types).
Items that return valid URI will be returned in mime data when dragging a selection from browser model.
Reimplemented in QgsDirectoryItem, QgsFileDataCollectionGroupItem, QgsFileDataCollectionItem, QgsLayerItem, QgsProjectItem, and QgsZipItem.
Definition at line 521 of file qgsdataitem.cpp.
void QgsDataItem::moveToThread | ( | QThread * | targetThread | ) |
Move object and all its descendants to thread.
Definition at line 143 of file qgsdataitem.cpp.
|
inline |
Returns the name of the item (the displayed text for the item).
Definition at line 360 of file qgsdataitem.h.
|
inlinevirtual |
Returns source widget from data item for QgsBrowserPropertiesWidget.
Use QgsDataItemGuiProvider::createParamWidget() instead
Reimplemented in QgsDirectoryItem.
Definition at line 187 of file qgsdataitem.h.
|
inline |
Gets item parent.
QgsDataItem maintains its own items hierarchy, it does not use QObject hierarchy.
Definition at line 345 of file qgsdataitem.h.
|
inline |
Definition at line 369 of file qgsdataitem.h.
|
static |
Create path component replacing path separators.
Definition at line 91 of file qgsdataitem.cpp.
|
virtualslot |
Definition at line 190 of file qgsdataitem.cpp.
|
protectedvirtual |
Definition at line 264 of file qgsdataitem.cpp.
QString QgsDataItem::providerKey | ( | ) | const |
Returns the provider key that created this item (e.g.
"PostGIS")
If key has a prefix "special:", it marks that the item was not created with a provider, but manually. For example "special:Favorites", "special:Home"
Definition at line 381 of file qgsdataitem.cpp.
|
virtualslot |
Definition at line 292 of file qgsdataitem.cpp.
|
protectedvirtual |
Refresh the items from a specified list of child items.
Definition at line 330 of file qgsdataitem.cpp.
|
virtualslot |
Causes a data item provider to refresh all registered connections.
If providerKey is specified then only the matching provider will be refreshed. Otherwise, all providers will be refreshed (which is potentially very expensive!).
Definition at line 315 of file qgsdataitem.cpp.
|
virtual |
Removes a child item and returns it without deleting it.
Emits relevant signals to model as required.
child | child to remove |
nullptr
if no such item was found Definition at line 470 of file qgsdataitem.cpp.
|
virtual |
Sets a new name for the item, and returns true
if the item was successfully renamed.
Items which implement this method should return the QgsDataItem::Rename capability.
The default implementation does nothing.
Reimplemented in QgsFavoriteItem.
Definition at line 540 of file qgsdataitem.cpp.
int QgsDataItem::rowCount | ( | ) |
Definition at line 391 of file qgsdataitem.cpp.
void QgsDataItem::setCapabilities | ( | int | capabilities | ) |
Definition at line 545 of file qgsdataitem.cpp.
|
inlinevirtual |
Sets the capabilities for the data item.
Definition at line 304 of file qgsdataitem.h.
|
virtual |
Writes the selected crs into data source.
The original data source will be modified when calling this method.
Definition at line 534 of file qgsdataitem.cpp.
|
inline |
Definition at line 416 of file qgsdataitem.h.
|
inline |
Definition at line 417 of file qgsdataitem.h.
void QgsDataItem::setName | ( | const QString & | name | ) |
Sets the name of the item (the displayed text for the item).
Definition at line 179 of file qgsdataitem.cpp.
void QgsDataItem::setParent | ( | QgsDataItem * | parent | ) |
Set item parent and connect / disconnect parent to / from item signals.
It does not add itself to parents children (mChildren)
Definition at line 405 of file qgsdataitem.cpp.
|
inline |
Definition at line 370 of file qgsdataitem.h.
void QgsDataItem::setProviderKey | ( | const QString & | value | ) |
Sets the provider key that created this item (e.g.
"PostGIS")
If key has a prefix "special:", it marks that the item was not created with a provider, but manually. For example "special:Favorites"
Definition at line 386 of file qgsdataitem.cpp.
void QgsDataItem::setSortKey | ( | const QVariant & | key | ) |
Sets a custom sorting key for the item.
Definition at line 102 of file qgsdataitem.cpp.
|
virtual |
Set item state.
It also take care about starting/stopping loading icon animation.
state |
Reimplemented in QgsDirectoryItem.
Definition at line 555 of file qgsdataitem.cpp.
|
inline |
Definition at line 419 of file qgsdataitem.h.
|
virtual |
Returns the sorting key for the item.
By default name() is returned, but setSortKey() can be used to set a custom sort key for the item.
Alternatively subclasses can override this method to return a custom sort key.
Reimplemented in QgsProjectHomeItem, and QgsFavoritesItem.
Definition at line 97 of file qgsdataitem.cpp.
Qgis::BrowserItemState QgsDataItem::state | ( | ) | const |
Definition at line 550 of file qgsdataitem.cpp.
|
signal |
Emitted when an item's state is changed.
|
inline |
Definition at line 420 of file qgsdataitem.h.
|
inline |
Definition at line 339 of file qgsdataitem.h.
|
protectedslot |
Will request a repaint of this icon.
Definition at line 259 of file qgsdataitem.cpp.
|
protected |
Definition at line 458 of file qgsdataitem.h.
|
protected |
Definition at line 460 of file qgsdataitem.h.
|
protected |
Definition at line 471 of file qgsdataitem.h.
|
protected |
Definition at line 472 of file qgsdataitem.h.
|
protected |
Definition at line 470 of file qgsdataitem.h.
|
protected |
Definition at line 462 of file qgsdataitem.h.
|
protected |
Definition at line 459 of file qgsdataitem.h.
|
protected |
Definition at line 468 of file qgsdataitem.h.
|
protected |
Definition at line 463 of file qgsdataitem.h.
|
protected |
Custom sort key. If invalid, name() will be used for sorting instead.
Definition at line 475 of file qgsdataitem.h.
|
protected |
Definition at line 461 of file qgsdataitem.h.
|
protected |
Definition at line 469 of file qgsdataitem.h.
|
protected |
Definition at line 457 of file qgsdataitem.h.