Data item that can be used to represent QGIS projects. More...
#include <qgsprojectitem.h>
Inheritance diagram for QgsProjectItem:
Public Member Functions | |
| QgsProjectItem (QgsDataItem *parent, const QString &name, const QString &path, const QString &providerKey=QString()) | |
| A data item holding a reference to a QGIS project file. More... | |
| bool | hasDragEnabled () const override |
Returns true if the item may be dragged. More... | |
| QgsMimeDataUtils::UriList | mimeUris () const override |
| Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g. More... | |
 Public Member Functions inherited from 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. 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 Qgis::BrowserItemCapabilities | 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 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... | |
| 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 () |
| Q_DECL_DEPRECATED void | setCapabilities (int capabilities) |
| virtual void | setCapabilities (Qgis::BrowserItemCapabilities 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 (Qgis::BrowserItemState state) |
| Set item state. More... | |
| void | setToolTip (const QString &msg) |
| virtual QVariant | sortKey () const |
| Returns the sorting key for the item. More... | |
| Qgis::BrowserItemState | state () const |
| QString | toolTip () const |
| Qgis::BrowserItemType | type () const |
Additional Inherited Members | |
| Public Slots inherited from QgsDataItem | |
| 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 inherited from QgsDataItem | |
| 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, Qgis::BrowserItemState oldState) |
| Emitted when an item's state is changed. More... | |
| Static Public Member Functions inherited from QgsDataItem | |
| 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 inherited from QgsDataItem | |
| void | updateIcon () |
| Will request a repaint of this icon. More... | |
| Protected Member Functions inherited from QgsDataItem | |
| 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 inherited from QgsDataItem | |
| 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. More... | |
| Qgis::BrowserItemState | mState = Qgis::BrowserItemState::NotPopulated |
| QString | mToolTip |
| Qgis::BrowserItemType | mType |
Detailed Description
Data item that can be used to represent QGIS projects.
Definition at line 28 of file qgsprojectitem.h.
Constructor & Destructor Documentation
◆ QgsProjectItem()
| QgsProjectItem::QgsProjectItem | ( | QgsDataItem * | parent, |
| const QString & | name, | ||
| const QString & | path, | ||
| const QString & | providerKey = QString() |
||
| ) |
A data item holding a reference to a QGIS project file.
- Parameters
-
parent The parent data item. name The name of the of the project. Displayed to the user. path The full path to the project. providerKey key of the provider that created this item
Definition at line 21 of file qgsprojectitem.cpp.
Member Function Documentation
◆ hasDragEnabled()
|
inlineoverridevirtual |
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.
- See also
- mimeUris()
- Since
- QGIS 3.0
Reimplemented from QgsDataItem.
Definition at line 50 of file qgsprojectitem.h.
◆ mimeUris()
|
overridevirtual |
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.
- Since
- QGIS 3.18
Reimplemented from QgsDataItem.
Definition at line 30 of file qgsprojectitem.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.22.4+99unstable/src/core/browser/qgsprojectitem.h
- /build/qgis-3.22.4+99unstable/src/core/browser/qgsprojectitem.cpp
