QGIS API Documentation  2.11.0-Master
Public Types | Public Slots | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
QgsDirectoryItem Class Reference

A directory: contains subdirectories and layers. More...

#include <qgsdataitem.h>

Inheritance diagram for QgsDirectoryItem:
Inheritance graph
[legend]

Public Types

enum  Column {
  Name, Size, Date, Permissions,
  Owner, Group, Type
}
 
- 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
}
 

Public Slots

virtual 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. 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 ()
 

Public Member Functions

 QgsDirectoryItem (QgsDataItem *parent, QString name, QString path)
 
 QgsDirectoryItem (QgsDataItem *parent, QString name, QString dirPath, QString path)
 Constructor. More...
 
 ~QgsDirectoryItem ()
 
QVector< QgsDataItem * > createChildren () override
 Create children. More...
 
QString dirPath () const
 
virtual bool equal (const QgsDataItem *other) override
 
virtual QIcon icon () override
 
virtual QWidgetparamWidget () override
 
virtual void setState (State state) override
 Set item state. More...
 
- 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. 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 handleDrop (const QMimeData *, Qt::DropAction)
 
bool hasChildren ()
 
bool isPopulated ()
 
void moveToThread (QThread *targetThread)
 Move object and all its descendants to thread. More...
 
QString name () const
 
QgsDataItemparent () const
 Get item parent. More...
 
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. More...
 
void setPath (const QString &path)
 
void setToolTip (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 Attributes

static Q_DECL_DEPRECATED QVector< QLibrary * > mLibraries = QVector<QLibrary*>()
 

Protected Member Functions

void init ()
 
- Protected Member Functions inherited from QgsDataItem
bool deferredDelete ()
 The item is scheduled to be deleted. More...
 
virtual void populate (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)
 

Protected Attributes

QString mDirPath
 
- Protected Attributes inherited from QgsDataItem
Capabilities mCapabilities
 
QVector< QgsDataItem * > mChildren
 
QIcon mIcon
 
QString mIconName
 
QString mName
 
QgsDataItemmParent
 
QString mPath
 
bool mPopulated
 
State mState
 
QString mToolTip
 
Type mType
 

Additional Inherited Members

- 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)
 
- 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)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Static Protected Attributes inherited from QgsDataItem
static QMap< QString, QIconmIconMap = QMap<QString, QIcon>()
 
- Properties inherited from QObject
 objectName
 

Detailed Description

A directory: contains subdirectories and layers.

Definition at line 362 of file qgsdataitem.h.

Member Enumeration Documentation

Enumerator
Name 
Size 
Date 
Permissions 
Owner 
Group 
Type 

Definition at line 366 of file qgsdataitem.h.

Constructor & Destructor Documentation

QgsDirectoryItem::QgsDirectoryItem ( QgsDataItem parent,
QString  name,
QString  path 
)

Definition at line 736 of file qgsdataitem.cpp.

QgsDirectoryItem::QgsDirectoryItem ( QgsDataItem parent,
QString  name,
QString  dirPath,
QString  path 
)

Constructor.

Parameters
parent
namedirectory name
dirPathpath to directory in file system
pathitem path in the tree, it may be dirPath or dirPath with some prefix, e.g. favourites:

Definition at line 746 of file qgsdataitem.cpp.

QgsDirectoryItem::~QgsDirectoryItem ( )

Definition at line 760 of file qgsdataitem.cpp.

Member Function Documentation

void QgsDirectoryItem::childrenCreated ( )
overridevirtualslot

Definition at line 879 of file qgsdataitem.cpp.

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

Create children.

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

Reimplemented from QgsDataItem.

Definition at line 772 of file qgsdataitem.cpp.

void QgsDirectoryItem::directoryChanged ( )
slot

Definition at line 865 of file qgsdataitem.cpp.

QString QgsDirectoryItem::dirPath ( ) const
inline

Definition at line 391 of file qgsdataitem.h.

bool QgsDirectoryItem::equal ( const QgsDataItem other)
overridevirtual

Reimplemented from QgsDataItem.

Definition at line 896 of file qgsdataitem.cpp.

QIcon QgsDirectoryItem::icon ( )
overridevirtual

Reimplemented from QgsDataItem.

Definition at line 764 of file qgsdataitem.cpp.

void QgsDirectoryItem::init ( )
protected

Definition at line 756 of file qgsdataitem.cpp.

QWidget * QgsDirectoryItem::paramWidget ( )
overridevirtual

Reimplemented from QgsDataItem.

Definition at line 906 of file qgsdataitem.cpp.

void QgsDirectoryItem::setState ( State  state)
overridevirtual

Set item state.

It also take care about starting/stopping loading icon animation.

Parameters
state
Note
added in 2.8

Reimplemented from QgsDataItem.

Definition at line 841 of file qgsdataitem.cpp.

Member Data Documentation

QString QgsDirectoryItem::mDirPath
protected

Definition at line 407 of file qgsdataitem.h.

QVector< QLibrary * > QgsDirectoryItem::mLibraries = QVector<QLibrary*>()
static
Note
not available via python bindings
deprecated since 2.10 - use QgsDataItemProviderRegistry

Definition at line 399 of file qgsdataitem.h.


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