QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
A directory item showing the a single favorite directory. More...
#include <qgsfavoritesitem.h>
Public Member Functions | |
QgsFavoriteItem (QgsFavoritesItem *parent, const QString &name, const QString &dirPath, const QString &path) | |
Constructor for QgsFavoriteItem. | |
bool | rename (const QString &name) override |
Sets a new name for the favorite. | |
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. | |
QgsDirectoryItem (QgsDataItem *parent, const QString &name, const QString &path) | |
Constructor for QgsDirectoryItem, with the specified parent item. | |
QVector< QgsDataItem * > | createChildren () override |
Create children. | |
QString | dirPath () const |
Returns the full path to the directory the item represents. | |
bool | equal (const QgsDataItem *other) override |
Returns true if this item is equal to another item (by testing item type and path). | |
bool | hasDragEnabled () const override |
Returns true if the item may be dragged. | |
QIcon | icon () override |
QColor | iconColor () const |
Returns the directory's icon color. | |
bool | isMonitored () const |
Returns true if the directory is currently being monitored for changes and the item auto-refreshed when these occur. | |
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. | |
Qgis::BrowserDirectoryMonitoring | monitoring () const |
Returns the monitoring setting for this directory item. | |
Q_DECL_DEPRECATED QWidget * | paramWidget () override |
Returns source widget from data item for QgsBrowserPropertiesWidget. | |
void | reevaluateMonitoring () |
Re-evaluate whether the directory item should be monitored for changes. | |
void | setIconColor (const QColor &color) |
Sets the directory's icon color. | |
void | setMonitoring (Qgis::BrowserDirectoryMonitoring monitoring) |
Sets the monitoring setting for this directory. | |
void | setState (Qgis::BrowserItemState state) override |
Set item state. | |
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. | |
~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. | |
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. | |
~QgsDataItem () override | |
virtual Q_DECL_DEPRECATED bool | acceptDrop () |
Returns whether the item accepts drag and dropped layers - e.g. | |
virtual QList< QAction * > | actions (QWidget *parent) |
Returns the list of actions available for this item. | |
virtual void | addChildItem (QgsDataItem *child, bool refresh=false) |
Inserts a new child item. | |
virtual Qgis::BrowserItemCapabilities | capabilities2 () const |
Returns the capabilities for the data item. | |
QVector< QgsDataItem * > | children () const |
virtual void | deleteChildItem (QgsDataItem *child) |
Removes and deletes a child item, emitting relevant signals to the model. | |
virtual bool | handleDoubleClick () |
Called when a user double clicks on the item. | |
virtual Q_DECL_DEPRECATED bool | handleDrop (const QMimeData *, Qt::DropAction) |
Attempts to process the mime data dropped on this item. | |
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. | |
virtual QList< QMenu * > | menus (QWidget *parent) |
Returns the list of menus available for this item. | |
virtual Q_DECL_DEPRECATED QgsMimeDataUtils::Uri | mimeUri () const |
Returns mime URI for the data item. | |
void | moveToThread (QThread *targetThread) |
Move object and all its descendants to thread. | |
QString | name () const |
Returns the name of the item (the displayed text for the item). | |
QgsDataItem * | parent () const |
Gets item parent. | |
QString | path () const |
QString | providerKey () const |
Returns the provider key that created this item (e.g. | |
virtual QgsDataItem * | removeChildItem (QgsDataItem *child) |
Removes a child item and returns it without deleting it. | |
int | rowCount () |
Q_DECL_DEPRECATED void | setCapabilities (int capabilities) |
virtual void | setCapabilities (Qgis::BrowserItemCapabilities capabilities) |
Sets the capabilities for the data item. | |
virtual Q_DECL_DEPRECATED bool | setCrs (const QgsCoordinateReferenceSystem &crs) |
Writes the selected crs into data source. | |
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). | |
void | setParent (QgsDataItem *parent) |
Set item parent and connect / disconnect parent to / from item signals. | |
void | setPath (const QString &path) |
void | setProviderKey (const QString &value) |
Sets the provider key that created this item (e.g. | |
void | setSortKey (const QVariant &key) |
Sets a custom sorting key for the item. | |
void | setToolTip (const QString &msg) |
virtual QVariant | sortKey () const |
Returns the sorting key for the item. | |
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: | |
virtual void | depopulate () |
Remove children recursively and set as not populated. This is used when refreshing collapsed items. | |
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. | |
Signals inherited from QgsDataItem | |
void | beginInsertItems (QgsDataItem *parent, int first, int last) |
Emitted before child items are added to this data item. | |
void | beginRemoveItems (QgsDataItem *parent, int first, int last) |
Emitted before child items are removed from this data item. | |
void | connectionsChanged (const QString &providerKey=QString()) |
Emitted when the connections of the provider with the specified providerKey have changed. | |
void | dataChanged (QgsDataItem *item) |
Emitted when data changes for an item. | |
void | endInsertItems () |
Emitted after child items have been added to this data item. | |
void | endRemoveItems () |
Emitted after child items have been removed from this data item. | |
void | stateChanged (QgsDataItem *item, Qgis::BrowserItemState oldState) |
Emitted when an item's state is changed. | |
Static Public Member Functions inherited from QgsDirectoryItem | |
static bool | hiddenPath (const QString &path) |
Check if the given path is hidden from the browser model. | |
static Qgis::BrowserDirectoryMonitoring | monitoringForPath (const QString &path) |
Returns the monitoring setting for a directory path. | |
static bool | pathShouldByMonitoredByDefault (const QString &path) |
Returns true if a directory path should be monitored by default. | |
static void | setCustomColor (const QString &directory, const QColor &color) |
Sets a custom icon color to use for the items for the corresponding directory path. | |
Static Public Member Functions inherited from QgsDataCollectionItem | |
static QIcon | iconDataCollection () |
Returns the standard browser data collection icon. | |
static QIcon | iconDir (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor()) |
Returns the standard browser directory icon. | |
Static Public Member Functions inherited from QgsDataItem | |
static void | deleteLater (QVector< QgsDataItem * > &items) |
template<class T > | |
static QList< T * > | filteredItems (const QList< QgsDataItem * > &items) |
Returns a filtered list of data items which match the template type. | |
static int | findItem (QVector< QgsDataItem * > items, QgsDataItem *item) |
static QString | pathComponent (const QString &component) |
Create path component replacing path separators. | |
Protected Slots inherited from QgsDataItem | |
void | updateIcon () |
Will request a repaint of this icon. | |
Protected Member Functions inherited from QgsDataItem | |
bool | deferredDelete () |
The item is scheduled to be deleted. | |
virtual void | populate (const QVector< QgsDataItem * > &children) |
virtual void | refresh (const QVector< QgsDataItem * > &children) |
Refresh the items from a specified list of child items. | |
Static Protected Member Functions inherited from QgsDataCollectionItem | |
static QIcon | homeDirIcon (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor()) |
Shared home directory icon. | |
static QIcon | openDirIcon (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor()) |
Shared open directory icon. | |
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. | |
Qgis::BrowserItemState | mState = Qgis::BrowserItemState::NotPopulated |
QString | mToolTip |
Qgis::BrowserItemType | mType |
A directory item showing the a single favorite directory.
Definition at line 90 of file qgsfavoritesitem.h.
QgsFavoriteItem::QgsFavoriteItem | ( | QgsFavoritesItem * | parent, |
const QString & | name, | ||
const QString & | dirPath, | ||
const QString & | path | ||
) |
Constructor for QgsFavoriteItem.
parent | parent favorites item |
name | visible name for item |
dirPath | corresponding directory (folder) path |
path | unique data item path |
Definition at line 189 of file qgsfavoritesitem.cpp.
|
overridevirtual |
Sets a new name for the favorite.
Reimplemented from QgsDataItem.
Definition at line 196 of file qgsfavoritesitem.cpp.