QGIS API Documentation  2.11.0-Master
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, 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 ()
virtual QList< QAction * > actions ()
virtual void addChildItem (QgsDataItem *child, bool refresh=false)
virtual Q_DECL_DEPRECATED Capability 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. More...
QString name () const
virtual QWidgetparamWidget ()
QgsDataItemparent () const
 Get item parent. More...
QString path () const
virtual QgsDataItemremoveChildItem (QgsDataItem *child)
int rowCount ()
virtual void setCapabilities (const Capabilities &capabilities)
virtual bool setCrs (QgsCoordinateReferenceSystem crs)
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
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 QObject (QObject *parent, const char *name)
virtual  ~QObject ()
bool blockSignals (bool block)
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList & children () const
const char * className () const
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const QObject *receiver, const char *method)
bool disconnect (const char *signal, const QObject *receiver, const char *method)
void dumpObjectInfo ()
void dumpObjectTree ()
QList< QByteArraydynamicPropertyNames () const
virtual bool event (QEvent *e)
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name) const
QList< T > findChildren (const QRegExp &regExp) const
QList< T > findChildren (const QString &name) const
bool inherits (const char *className) const
void insertChild (QObject *object)
void installEventFilter (QObject *filterObj)
bool isA (const char *className) const
bool isWidgetType () const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const
void moveToThread (QThread *targetThread)
const char * name () const
const char * name (const char *defaultName) const
QString objectName () const
QObjectparent () const
QVariant property (const char *name) const
void removeChild (QObject *object)
void removeEventFilter (QObject *obj)
void setName (const char *name)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const
int startTimer (int interval)
QThreadthread () const

Static Public Member Functions

static const QIconiconFavourites ()
- Static Public Member Functions inherited from QgsDataCollectionItem
static const QIconiconDataCollection ()
static const QIconiconDir ()
- 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...
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)

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: More...
virtual void depopulate ()
 Remove children recursively and set as not populated. More...
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 (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 (QVector< QgsDataItem * > children)
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const char *signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const char *signal)
int receivers (const char *signal) const
QObjectsender () const
int senderSignalIndex () const
virtual void timerEvent (QTimerEvent *event)
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
- 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, QIconmIconMap = QMap<QString, QIcon>()
- Properties inherited from QObject

Detailed Description

Contains various Favourites directories.

Definition at line 456 of file qgsdataitem.h.

Constructor & Destructor Documentation

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

Definition at line 1067 of file qgsdataitem.cpp.

QgsFavouritesItem::~QgsFavouritesItem ( )

Definition at line 1077 of file qgsdataitem.cpp.

Member Function Documentation

void QgsFavouritesItem::addDirectory ( const QString favIcon)

Definition at line 1101 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 1081 of file qgsdataitem.cpp.

const QIcon & QgsFavouritesItem::iconFavourites ( )

Definition at line 184 of file qgsdataitem.cpp.

void QgsFavouritesItem::removeDirectory ( QgsDirectoryItem item)

Definition at line 1115 of file qgsdataitem.cpp.

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