A directory item showing the a single favorite directory. More...
#include <qgsfavoritesitem.h>
Inheritance diagram for QgsFavoriteItem:
Public Member Functions | |
| QgsFavoriteItem (QgsFavoritesItem *parent, const QString &name, const QString &dirPath, const QString &path) | |
| Constructor for QgsFavoriteItem. More... | |
| bool | rename (const QString &name) override |
| Sets a new name for the favorite. More... | |
 Public Member Functions inherited from QgsDirectoryItem | |
| QgsDirectoryItem (QgsDataItem *parent, const QString &name, const QString &dirPath, const QString &path, const QString &providerKey=QString()) | |
| Constructor for QgsDirectoryItem, with the specified parent item. More... | |
| QgsDirectoryItem (QgsDataItem *parent, const QString &name, const QString &path) | |
| Constructor for QgsDirectoryItem, with the specified parent item. More... | |
| QVector< QgsDataItem * > | createChildren () override |
| Create children. More... | |
| QString | dirPath () const |
| Returns the full path to the directory the item represents. More... | |
| bool | equal (const QgsDataItem *other) override |
Returns true if this item is equal to another item (by testing item type and path). More... | |
| bool | hasDragEnabled () const override |
Returns true if the item may be dragged. More... | |
| QIcon | icon () override |
| QColor | iconColor () const |
| Returns the directory's icon color. More... | |
| bool | isMonitored () const |
Returns true if the directory is currently being monitored for changes and the item auto-refreshed when these occur. 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... | |
| Qgis::BrowserDirectoryMonitoring | monitoring () const |
| Returns the monitoring setting for this directory item. More... | |
| Q_DECL_DEPRECATED QWidget * | paramWidget () override |
| Returns source widget from data item for QgsBrowserPropertiesWidget. More... | |
| void | reevaluateMonitoring () |
| Re-evaluate whether the directory item should be monitored for changes. More... | |
| void | setIconColor (const QColor &color) |
| Sets the directory's icon color. More... | |
| void | setMonitoring (Qgis::BrowserDirectoryMonitoring monitoring) |
| Sets the monitoring setting for this directory. More... | |
| void | setState (Qgis::BrowserItemState state) override |
| Set item state. More... | |
| Public Member Functions inherited from QgsDataCollectionItem | |
| 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... | |
| 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 void | deleteChildItem (QgsDataItem *child) |
| Removes and deletes a child item, emitting relevant signals to the model. 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 | 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... | |
| 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... | |
| 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... | |
| 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 QgsDirectoryItem | |
| void | childrenCreated () override |
| void | directoryChanged () |
| 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 QgsDirectoryItem | |
| static bool | hiddenPath (const QString &path) |
| Check if the given path is hidden from the browser model. More... | |
| static Qgis::BrowserDirectoryMonitoring | monitoringForPath (const QString &path) |
| Returns the monitoring setting for a directory path. More... | |
| static bool | pathShouldByMonitoredByDefault (const QString &path) |
Returns true if a directory path should be monitored by default. More... | |
| static void | setCustomColor (const QString &directory, const QColor &color) |
| Sets a custom icon color to use for the items for the corresponding directory path. More... | |
| Static Public Member Functions inherited from QgsDataCollectionItem | |
| static QIcon | iconDataCollection () |
| Returns the standard browser data collection icon. More... | |
| static QIcon | iconDir (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor()) |
| Returns the standard browser directory icon. 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 QgsDirectoryItem | |
| void | init () |
| 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... | |
| Static Protected Member Functions inherited from QgsDataCollectionItem | |
| static QIcon | homeDirIcon (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor()) |
| Shared home directory icon. More... | |
| static QIcon | openDirIcon (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor()) |
| Shared open directory icon. More... | |
| Protected Attributes inherited from QgsDirectoryItem | |
| QString | mDirPath |
| 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
A directory item showing the a single favorite directory.
- Note
- Not available in Python bindings
- Since
- QGIS 3.0
Definition at line 92 of file qgsfavoritesitem.h.
Constructor & Destructor Documentation
◆ QgsFavoriteItem()
| QgsFavoriteItem::QgsFavoriteItem | ( | QgsFavoritesItem * | parent, |
| const QString & | name, | ||
| const QString & | dirPath, | ||
| const QString & | path | ||
| ) |
Constructor for QgsFavoriteItem.
- Parameters
-
parent parent favorites item name visible name for item dirPath corresponding directory (folder) path path unique data item path
Definition at line 190 of file qgsfavoritesitem.cpp.
Member Function Documentation
◆ rename()
|
overridevirtual |
Sets a new name for the favorite.
Reimplemented from QgsDataItem.
Definition at line 197 of file qgsfavoritesitem.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.20.0+99unstable/src/core/browser/qgsfavoritesitem.h
- /build/qgis-3.20.0+99unstable/src/core/browser/qgsfavoritesitem.cpp
