|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
Data item that can be used to represent QGIS projects. More...
#include <qgsdataitem.h>
Public Member Functions | |
| QgsProjectItem (QgsDataItem *parent, const QString &name, const QString &path) | |
| 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::Uri | mimeUri () const override |
| Returns mime URI for the data item. More... | |
 Public Member Functions inherited from QgsDataItem | |
| QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, const QString &name, const QString &path) | |
| Create new data item. More... | |
| ~QgsDataItem () override | |
| virtual 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 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 bool | handleDrop (const QMimeData *, Qt::DropAction) |
| Attempts to process the mime data dropped on this item. More... | |
| bool | hasChildren () |
| virtual QIcon | icon () |
| virtual QList< QMenu * > | menus (QWidget *parent) |
| Returns the list of menus available for this 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 QWidget * | paramWidget () |
| QgsDataItem * | parent () const |
| Gets item parent. More... | |
| QString | path () const |
| virtual QgsDataItem * | removeChildItem (QgsDataItem *child) |
| Removes a child item and returns it without deleting it. More... | |
| virtual 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 | 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 |
Additional Inherited Members | |
| Public Types inherited from QgsDataItem | |
| enum | Capability { NoCapabilities = 0, SetCrs = 1 << 0, Fertile = 1 << 1, Fast = 1 << 2, Collapse = 1 << 3, Rename = 1 << 4 } |
| enum | State { NotPopulated, Populating, Populated } |
| enum | Type { Collection, Directory, Layer, Error, Favorites, Project, Custom } |
| 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 () |
| Refresh connections: update GUI and emit signal. More... | |
| Signals inherited from QgsDataItem | |
| void | beginInsertItems (QgsDataItem *parent, int first, int last) |
| void | beginRemoveItems (QgsDataItem *parent, int first, int last) |
| void | connectionsChanged () |
| Emitted when the provider's connections of the child items 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. More... | |
| void | dataChanged (QgsDataItem *item) |
| void | endInsertItems () |
| void | endRemoveItems () |
| void | stateChanged (QgsDataItem *item, QgsDataItem::State oldState) |
| 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 | |
| Capabilities | mCapabilities |
| QVector< QgsDataItem * > | mChildren |
| QIcon | mIcon |
| QMap< QString, QIcon > | mIconMap |
| QString | mIconName |
| QString | mName |
| QgsDataItem * | mParent = nullptr |
| QString | mPath |
| QVariant | mSortKey |
| Custom sort key. If invalid, name() will be used for sorting instead. More... | |
| State | mState |
| QString | mToolTip |
| Type | mType |
Data item that can be used to represent QGIS projects.
Definition at line 629 of file qgsdataitem.h.
| QgsProjectItem::QgsProjectItem | ( | QgsDataItem * | parent, |
| const QString & | name, | ||
| const QString & | path | ||
| ) |
A data item holding a reference to a QGIS project file.
| parent | The parent data item. |
| name | The name of the of the project. Displayed to the user. |
| path | The full path to the project. |
Definition at line 1163 of file qgsdataitem.cpp.
|
inlineoverridevirtual |
Returns true if the item may be dragged.
Default implementation returns false. A draggable item has to implement mimeUri() that will be used to pass data.
Reimplemented from QgsDataItem.
Definition at line 642 of file qgsdataitem.h.
|
overridevirtual |
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.
Reimplemented from QgsDataItem.
Definition at line 1171 of file qgsdataitem.cpp.
1.8.11
