QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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

Public Member Functions

 QgsFavouritesItem (QgsDataItem *parent, QString name, QString path=QString())
 ~QgsFavouritesItem ()
void addDirectory (QString favIcon)
QVector< QgsDataItem * > createChildren () override
 Create children.
void removeDirectory (QgsDirectoryItem *item)
- Public Member Functions inherited from QgsDataCollectionItem
 QgsDataCollectionItem (QgsDataItem *parent, QString name, QString path=QString::null)
 ~QgsDataCollectionItem ()
void addChild (QgsDataItem *item)
- Public Member Functions inherited from QgsDataItem
 QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, QString name, QString path)
 Create new data item.
virtual ~QgsDataItem ()
virtual bool acceptDrop ()
virtual QList< QAction * > actions ()
virtual void addChildItem (QgsDataItem *child, bool refresh=false)
capabilities ()
virtual Capabilities capabilities2 () const
QVector< QgsDataItem * > children () const
virtual void deleteChildItem (QgsDataItem *child)
virtual bool equal (const QgsDataItem *other)
virtual bool handleDrop (const QMimeData *, Qt::DropAction)
bool hasChildren ()
virtual QIcon icon ()
bool isPopulated ()
void moveToThread (QThread *targetThread)
 Move object and all its descendants to thread.
QString name () const
virtual QWidget * paramWidget ()
QgsDataItemparent () const
 Get item parent.
QString path () const
virtual QgsDataItemremoveChildItem (QgsDataItem *child)
int rowCount ()
virtual void setCapabilities (Capabilities capabilities)
virtual bool setCrs (QgsCoordinateReferenceSystem crs)
void setIcon (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.
void setPath (const QString &path)
virtual void setState (State state)
 Set item state.
void setToolTip (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.

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,
- 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.
void emitBeginInsertItems (QgsDataItem *parent, int first, int last)
void emitBeginRemoveItems (QgsDataItem *parent, int first, int last)
void emitDataChanged (QgsDataItem *item)
void emitDataChanged ()
void emitEndInsertItems ()
void emitEndRemoveItems ()
void emitStateChanged (QgsDataItem *item, QgsDataItem::State oldState)
virtual void populate ()
virtual void refresh ()
void setPopulatingIcon ()
- 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.
virtual void populate (QVector< QgsDataItem * > children)
QIcon populatingIcon ()
virtual void refresh (QVector< QgsDataItem * > children)
- Protected Attributes inherited from QgsDataItem
Capabilities mCapabilities
QVector< QgsDataItem * > mChildren
QIcon mIcon
QString mIconName
QString mName
QString mPath
bool mPopulated
State mState
QString mToolTip
Type mType
- Static Protected Attributes inherited from QgsDataItem
static QMap< QString, QIcon > mIconMap = QMap<QString, QIcon>()

Detailed Description

Contains various Favourites directories.

Definition at line 411 of file qgsdataitem.h.

Constructor & Destructor Documentation

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

Definition at line 1064 of file qgsdataitem.cpp.

QgsFavouritesItem::~QgsFavouritesItem ( )

Definition at line 1074 of file qgsdataitem.cpp.

Member Function Documentation

void QgsFavouritesItem::addDirectory ( QString  favIcon)

Definition at line 1098 of file qgsdataitem.cpp.

QVector< QgsDataItem * > QgsFavouritesItem::createChildren ( )

Create children.

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

Reimplemented from QgsDataItem.

Definition at line 1078 of file qgsdataitem.cpp.

const QIcon & QgsFavouritesItem::iconFavourites ( )

Definition at line 131 of file qgsdataitem.cpp.

void QgsFavouritesItem::removeDirectory ( QgsDirectoryItem item)

Definition at line 1112 of file qgsdataitem.cpp.

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