QGIS API Documentation  2.99.0-Master (c494c47)
Public Member Functions | Static Public Member Functions | List of all members
QgsFavouritesItem Class Reference

Contains various Favourites directories. More...

#include <qgsdataitem.h>

Inheritance diagram for QgsFavouritesItem:
Inheritance graph
[legend]

Public Member Functions

 QgsFavouritesItem (QgsDataItem *parent, const QString &name, const QString &path=QString())
 
 ~QgsFavouritesItem ()
 
void addDirectory (const QString &favIcon)
 
QVector< QgsDataItem * > createChildren () override
 Create children. More...
 
void removeDirectory (QgsDirectoryItem *item)
 
- Public Member Functions inherited from QgsDataCollectionItem
 QgsDataCollectionItem (QgsDataItem *parent, const QString &name, const QString &path=QString::null)
 
 ~QgsDataCollectionItem ()
 
void addChild (QgsDataItem *item)
 
- Public Member Functions inherited from QgsDataItem
 QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, const QString &name, const QString &path)
 Create new data item. More...
 
virtual ~QgsDataItem ()
 
virtual bool acceptDrop ()
 Returns whether the item accepts drag and dropped layers - e.g. More...
 
virtual QList< QAction * > actions ()
 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
 
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 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 QgsMimeDataUtils::Uri mimeUri () const
 Return mime URI for the data item. More...
 
void moveToThread (QThread *targetThread)
 Move object and all its descendants to thread. More...
 
QString name () const
 
virtual QWidget * paramWidget ()
 
QgsDataItemparent () const
 Get item parent. More...
 
QString path () const
 
virtual QgsDataItemremoveChildItem (QgsDataItem *child)
 Removes a child item and returns it without deleting it. More...
 
int rowCount ()
 
virtual void setCapabilities (Capabilities capabilities)
 Sets the capabilities for the data item. More...
 
virtual 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)
 
void setParent (QgsDataItem *parent)
 Set item parent and connect / disconnect parent to / from item signals. More...
 
void setPath (const QString &path)
 
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 const QIcon & iconFavourites ()
 
- Static Public Member Functions inherited from QgsDataCollectionItem
static const QIcon & iconDataCollection ()
 
static const QIcon & iconDir ()
 
- 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...
 

Additional Inherited Members

- Public Types inherited from QgsDataItem
enum  Capability { NoCapabilities = 0, SetCrs = 1 << 0, Fertile = 1 << 1, Fast = 1 << 2 }
 
enum  State { NotPopulated, Populating, Populated }
 
enum  Type {
  Collection, Directory, Layer, Error,
  Favourites, Project
}
 
- 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...
 
void emitDataChanged ()
 
virtual void populate (bool foreground=false)
 
virtual void refresh ()
 
- Signals inherited from QgsDataItem
void beginInsertItems (QgsDataItem *parent, int first, int last)
 
void beginRemoveItems (QgsDataItem *parent, int first, int last)
 
void dataChanged (QgsDataItem *item)
 
void endInsertItems ()
 
void endRemoveItems ()
 
void stateChanged (QgsDataItem *item, QgsDataItem::State oldState)
 
- 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
 
QgsDataItemmParent
 
QString mPath
 
State mState
 
QString mToolTip
 
Type mType
 

Detailed Description

Contains various Favourites directories.

Definition at line 524 of file qgsdataitem.h.

Constructor & Destructor Documentation

§ QgsFavouritesItem()

QgsFavouritesItem::QgsFavouritesItem ( QgsDataItem parent,
const QString &  name,
const QString &  path = QString() 
)

Definition at line 1103 of file qgsdataitem.cpp.

§ ~QgsFavouritesItem()

QgsFavouritesItem::~QgsFavouritesItem ( )

Definition at line 1113 of file qgsdataitem.cpp.

Member Function Documentation

§ addDirectory()

void QgsFavouritesItem::addDirectory ( const QString &  favIcon)

Definition at line 1132 of file qgsdataitem.cpp.

§ createChildren()

QVector< QgsDataItem * > QgsFavouritesItem::createChildren ( )
overridevirtual

Create children.

Children are not expected to have parent set. This method MUST BE THREAD SAFE.

Reimplemented from QgsDataItem.

Definition at line 1117 of file qgsdataitem.cpp.

§ iconFavourites()

const QIcon & QgsFavouritesItem::iconFavourites ( )
static

Definition at line 185 of file qgsdataitem.cpp.

§ removeDirectory()

void QgsFavouritesItem::removeDirectory ( QgsDirectoryItem item)

Definition at line 1149 of file qgsdataitem.cpp.


The documentation for this class was generated from the following files: