QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
Base class for all items in the model. More...
#include <qgsdataitem.h>
Public Types | |
enum | Capability { NoCapabilities = 0 , SetCrs = 1 << 0 , Fertile = 1 << 1 , Fast = 1 << 2 , Collapse = 1 << 3 , Rename = 1 << 4 , Delete = 1 << 5 } |
enum | State { NotPopulated , Populating , Populated } |
enum | Type { Collection , Directory , Layer , Error , Favorites , Project , Custom , Fields , Field } |
Public Slots | |
virtual void | childrenCreated () |
virtual void | deleteLater () |
Safely delete the item: More... | |
virtual void | depopulate () |
Remove children recursively and set as not populated. This is used when refreshing collapsed items. More... | |
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. More... | |
Signals | |
void | beginInsertItems (QgsDataItem *parent, int first, int last) |
void | beginRemoveItems (QgsDataItem *parent, int first, int last) |
void | connectionsChanged (const QString &providerKey=QString()) |
Emitted when the connections of the provider with the specified providerKey have changed. More... | |
void | dataChanged (QgsDataItem *item) |
void | endInsertItems () |
void | endRemoveItems () |
void | stateChanged (QgsDataItem *item, QgsDataItem::State oldState) |
Public Member Functions | |
QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, const QString &name, const QString &path, const QString &providerKey=QString()) | |
Constructor for QgsDataItem, with the specified parent item. More... | |
~QgsDataItem () override | |
virtual Q_DECL_DEPRECATED bool | acceptDrop () |
Returns whether the item accepts drag and dropped layers - e.g. More... | |
virtual QList< QAction * > | actions (QWidget *parent) |
Returns the list of actions available for this item. More... | |
virtual void | addChildItem (QgsDataItem *child, bool refresh=false) |
Inserts a new child item. More... | |
virtual Capabilities | capabilities2 () const |
Returns the capabilities for the data item. More... | |
QVector< QgsDataItem * > | children () const |
virtual QVector< QgsDataItem * > | createChildren () |
Create children. More... | |
virtual QgsAbstractDatabaseProviderConnection * | databaseConnection () const |
For data items that represent a DB connection or one of its children, this method returns a connection. More... | |
virtual void | deleteChildItem (QgsDataItem *child) |
Removes and deletes a child item, emitting relevant signals to the model. More... | |
virtual bool | equal (const QgsDataItem *other) |
Returns true if this item is equal to another item (by testing item type and path). More... | |
virtual bool | handleDoubleClick () |
Called when a user double clicks on the item. More... | |
virtual Q_DECL_DEPRECATED bool | handleDrop (const QMimeData *, Qt::DropAction) |
Attempts to process the mime data dropped on this item. More... | |
bool | hasChildren () |
virtual bool | hasDragEnabled () const |
Returns true if the item may be dragged. More... | |
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. More... | |
virtual QList< QMenu * > | menus (QWidget *parent) |
Returns the list of menus available for this item. More... | |
virtual Q_DECL_DEPRECATED QgsMimeDataUtils::Uri | mimeUri () const |
Returns mime URI for the data item. More... | |
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. More... | |
void | moveToThread (QThread *targetThread) |
Move object and all its descendants to thread. More... | |
QString | name () const |
Returns the name of the item (the displayed text for the item). More... | |
virtual Q_DECL_DEPRECATED QWidget * | paramWidget () |
Returns source widget from data item for QgsBrowserPropertiesWidget. More... | |
QgsDataItem * | parent () const |
Gets item parent. More... | |
QString | path () const |
QString | providerKey () const |
Returns the provider key that created this item (e.g. More... | |
virtual QgsDataItem * | removeChildItem (QgsDataItem *child) |
Removes a child item and returns it without deleting it. More... | |
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. More... | |
int | rowCount () |
virtual void | setCapabilities (Capabilities capabilities) |
Sets the capabilities for the data item. More... | |
virtual Q_DECL_DEPRECATED bool | setCrs (const QgsCoordinateReferenceSystem &crs) |
Writes the selected crs into data source. More... | |
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). More... | |
void | setParent (QgsDataItem *parent) |
Set item parent and connect / disconnect parent to / from item signals. More... | |
void | setPath (const QString &path) |
void | setProviderKey (const QString &value) |
Sets the provider key that created this item (e.g. More... | |
void | setSortKey (const QVariant &key) |
Sets a custom sorting key for the item. More... | |
virtual void | setState (State state) |
Set item state. More... | |
void | setToolTip (const QString &msg) |
virtual QVariant | sortKey () const |
Returns the sorting key for the item. More... | |
State | state () const |
QString | toolTip () const |
Type | type () const |
Static Public Member Functions | |
static void | deleteLater (QVector< QgsDataItem * > &items) |
static int | findItem (QVector< QgsDataItem * > items, QgsDataItem *item) |
static QString | pathComponent (const QString &component) |
Create path component replacing path separators. More... | |
Protected Slots | |
void | updateIcon () |
Will request a repaint of this icon. More... | |
Protected Member Functions | |
bool | deferredDelete () |
The item is scheduled to be deleted. More... | |
virtual void | populate (const QVector< QgsDataItem * > &children) |
virtual void | refresh (const QVector< QgsDataItem * > &children) |
Refresh the items from a specified list of child items. More... | |
Protected Attributes | |
Capabilities | mCapabilities |
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. More... | |
State | mState |
QString | mToolTip |
Type | mType |
Base class for all items in the model.
Parent/children hierarchy is not based on QObject.
Definition at line 51 of file qgsdataitem.h.
Enumerator | |
---|---|
NoCapabilities | |
SetCrs | Can set CRS on layer or group of layers.
|
Fertile | Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors. |
Fast | CreateChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QgsSettings. |
Collapse | The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.) |
Rename | Item can be renamed. |
Delete | Item can be deleted. |
Definition at line 278 of file qgsdataitem.h.
enum QgsDataItem::State |
Enumerator | |
---|---|
NotPopulated | Children not yet created. |
Populating | Creating children in separate thread (populating or refreshing) |
Populated | Children created. |
Definition at line 149 of file qgsdataitem.h.
enum QgsDataItem::Type |
Enumerator | |
---|---|
Collection | |
Directory | |
Layer | |
Error | |
Favorites | Represents a favorite item. |
Project | Represents a QGIS project. |
Custom | Custom item type. |
Fields | Collection of fields. |
Field | Vector layer field. |
Definition at line 78 of file qgsdataitem.h.
QgsDataItem::QgsDataItem | ( | QgsDataItem::Type | 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 363 of file qgsdataitem.cpp.
|
override |
Definition at line 377 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 230 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 811 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 729 of file qgsdataitem.cpp.
|
signal |
|
signal |
|
inlinevirtual |
Returns the capabilities for the data item.
Definition at line 323 of file qgsdataitem.h.
|
inline |
Definition at line 352 of file qgsdataitem.h.
|
virtualslot |
Definition at line 545 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 QgsFieldsItem, QgsZipItem, QgsFavoritesItem, and QgsDirectoryItem.
Definition at line 493 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, and QgsDataCollectionItem.
Definition at line 466 of file qgsdataitem.cpp.
|
signal |
|
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 457 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 765 of file qgsdataitem.cpp.
|
virtualslot |
Safely delete the item:
Definition at line 415 of file qgsdataitem.cpp.
|
static |
Definition at line 439 of file qgsdataitem.cpp.
|
virtualslot |
Remove children recursively and set as not populated. This is used when refreshing collapsed items.
Definition at line 588 of file qgsdataitem.cpp.
|
signal |
|
signal |
|
virtual |
Returns true
if this item is equal to another item (by testing item type and path).
Reimplemented in QgsDirectoryItem, and QgsLayerItem.
Definition at line 805 of file qgsdataitem.cpp.
|
static |
Definition at line 793 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 817 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 240 of file qgsdataitem.h.
bool QgsDataItem::hasChildren | ( | ) |
Definition at line 701 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 QgsProjectItem, QgsDirectoryItem, and QgsLayerItem.
Definition at line 257 of file qgsdataitem.h.
|
virtual |
Reimplemented in QgsFieldItem, QgsFieldsItem, and QgsDirectoryItem.
Definition at line 471 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 706 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 868 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 822 of file qgsdataitem.cpp.
|
inlinevirtual |
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 QgsProjectItem, QgsDirectoryItem, and QgsLayerItem.
Definition at line 276 of file qgsdataitem.h.
void QgsDataItem::moveToThread | ( | QThread * | targetThread | ) |
Move object and all its descendants to thread.
Definition at line 451 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 201 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 400 of file qgsdataitem.cpp.
|
virtualslot |
Definition at line 498 of file qgsdataitem.cpp.
|
protectedvirtual |
Definition at line 573 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 687 of file qgsdataitem.cpp.
|
virtualslot |
Definition at line 602 of file qgsdataitem.cpp.
|
protectedvirtual |
Refresh the items from a specified list of child items.
Definition at line 640 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 625 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 776 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.
Definition at line 827 of file qgsdataitem.cpp.
int QgsDataItem::rowCount | ( | ) |
Definition at line 697 of file qgsdataitem.cpp.
|
inlinevirtual |
Sets the capabilities for the data item.
Definition at line 330 of file qgsdataitem.h.
|
inlinevirtual |
Writes the selected crs into data source.
The original data source will be modified when calling this method.
Definition at line 296 of file qgsdataitem.h.
|
inline |
Definition at line 418 of file qgsdataitem.h.
|
inline |
Definition at line 419 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 487 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 711 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 692 of file qgsdataitem.cpp.
void QgsDataItem::setSortKey | ( | const QVariant & | key | ) |
Sets a custom sorting key for the item.
Definition at line 410 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 837 of file qgsdataitem.cpp.
|
inline |
Definition at line 421 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 QgsFavoritesItem.
Definition at line 405 of file qgsdataitem.cpp.
QgsDataItem::State QgsDataItem::state | ( | ) | const |
Definition at line 832 of file qgsdataitem.cpp.
|
signal |
|
inline |
Definition at line 422 of file qgsdataitem.h.
|
inline |
Definition at line 339 of file qgsdataitem.h.
|
protectedslot |
|
protected |
Definition at line 460 of file qgsdataitem.h.
|
protected |
Definition at line 462 of file qgsdataitem.h.
|
protected |
Definition at line 473 of file qgsdataitem.h.
|
protected |
Definition at line 474 of file qgsdataitem.h.
|
protected |
Definition at line 472 of file qgsdataitem.h.
|
protected |
Definition at line 464 of file qgsdataitem.h.
|
protected |
Definition at line 461 of file qgsdataitem.h.
|
protected |
Definition at line 470 of file qgsdataitem.h.
|
protected |
Definition at line 465 of file qgsdataitem.h.
|
protected |
Custom sort key. If invalid, name() will be used for sorting instead.
Definition at line 477 of file qgsdataitem.h.
|
protected |
Definition at line 463 of file qgsdataitem.h.
|
protected |
Definition at line 471 of file qgsdataitem.h.
|
protected |
Definition at line 459 of file qgsdataitem.h.