QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
Contains various Favorites directories. More...
#include <qgsdataitem.h>
Public Member Functions | |
QgsFavoritesItem (QgsDataItem *parent, const QString &name, const QString &path=QString()) | |
Constructor for QgsFavoritesItem. More... | |
void | addDirectory (const QString &directory, const QString &name=QString()) |
Adds a new directory to the favorites group. More... | |
QVector< QgsDataItem * > | createChildren () override |
Create children. More... | |
void | removeDirectory (QgsDirectoryItem *item) |
Removes an existing directory from the favorites group. More... | |
void | renameFavorite (const QString &path, const QString &name) |
Renames the stored favorite with corresponding path a new name. More... | |
QVariant | sortKey () const override |
Returns the sorting key for the item. More... | |
![]() | |
QgsDataCollectionItem (QgsDataItem *parent, const QString &name, const QString &path=QString(), const QString &providerKey=QString()) | |
Constructor for QgsDataCollectionItem, with the specified parent item. More... | |
~QgsDataCollectionItem () override | |
void | addChild (QgsDataItem *item) |
QgsAbstractDatabaseProviderConnection * | databaseConnection () const override |
For data items that represent a DB connection or one of its children, this method returns a connection. More... | |
![]() | |
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 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) |
State | state () const |
QString | toolTip () const |
Type | type () const |
Static Public Member Functions | |
static QIcon | iconFavorites () |
Icon for favorites group. More... | |
![]() | |
static QIcon | iconDataCollection () |
Returns the standard browser data collection icon. More... | |
static QIcon | iconDir () |
Returns the standard browser directory icon. More... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
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 } |
![]() | |
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... | |
![]() | |
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) |
![]() | |
void | updateIcon () |
Will request a repaint of this icon. More... | |
![]() | |
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... | |
![]() | |
static QIcon | homeDirIcon () |
Shared home directory icon. More... | |
static QIcon | openDirIcon () |
Shared open directory icon. More... | |
![]() | |
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 |
QgsFavoritesItem::QgsFavoritesItem | ( | QgsDataItem * | parent, |
const QString & | name, | ||
const QString & | path = QString() |
||
) |
Constructor for QgsFavoritesItem.
Accepts a path argument specifying the file path associated with the item.
Definition at line 1532 of file qgsdataitem.cpp.
void QgsFavoritesItem::addDirectory | ( | const QString & | directory, |
const QString & | name = QString() |
||
) |
Adds a new 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 1567 of file qgsdataitem.cpp.
|
overridevirtual |
Create children.
Children are not expected to have parent set.
Reimplemented from QgsDataItem.
Definition at line 1542 of file qgsdataitem.cpp.
|
static |
Icon for favorites group.
Definition at line 346 of file qgsdataitem.cpp.
void QgsFavoritesItem::removeDirectory | ( | QgsDirectoryItem * | item | ) |
Removes an existing directory from the favorites group.
Definition at line 1587 of file qgsdataitem.cpp.
void QgsFavoritesItem::renameFavorite | ( | const QString & | path, |
const QString & | name | ||
) |
Renames the stored favorite with corresponding path a new name.
Definition at line 1617 of file qgsdataitem.cpp.
|
overridevirtual |
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 from QgsDataItem.
Definition at line 351 of file qgsdataitem.cpp.