QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | 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

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  Type {
  Collection, Directory, Layer, Error,

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 ()
QString dirPath () const
virtual bool equal (const QgsDataItem *other)
virtual QIcon icon ()
virtual QWidget * paramWidget ()
- 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)
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 void depopulate ()
 Remove children recursively and set as not populated. More...
virtual bool handleDrop (const QMimeData *, Qt::DropAction)
bool hasChildren ()
bool isPopulated ()
QString name () const
QgsDataItemparent () const
QString path () const
virtual void populate ()
virtual void populate (QVector< QgsDataItem * > children)
virtual void refresh ()
virtual void refresh (QVector< QgsDataItem * > children)
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 setParent (QgsDataItem *parent)
void setPath (const QString &path)
void setPopulated ()
 Set as populated without populating. More...
void setToolTip (QString msg)
QString toolTip () const
Type type () const

Static Public Attributes

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

Protected Member Functions

void init ()

Protected Attributes

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

Additional Inherited Members

- Public Slots inherited from QgsDataItem
void emitBeginInsertItems (QgsDataItem *parent, int first, int last)
void emitBeginRemoveItems (QgsDataItem *parent, int first, int last)
void emitEndInsertItems ()
void emitEndRemoveItems ()
- Signals inherited from QgsDataItem
void beginInsertItems (QgsDataItem *parent, int first, int last)
void beginRemoveItems (QgsDataItem *parent, int first, int last)
void endInsertItems ()
void endRemoveItems ()
- Static Public Member Functions inherited from QgsDataCollectionItem
static const QIcon & iconDataCollection ()
static const QIcon & iconDir ()
- Static Public Member Functions inherited from QgsDataItem
static int findItem (QVector< QgsDataItem * > items, QgsDataItem *item)
- Static Protected Attributes inherited from QgsDataItem
static QMap< QString, QIcon > mIconMap = QMap<QString, QIcon>()

Detailed Description

A directory: contains subdirectories and layers.

Definition at line 247 of file qgsdataitem.h.

Member Enumeration Documentation


Definition at line 251 of file qgsdataitem.h.

Constructor & Destructor Documentation

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

Definition at line 476 of file qgsdataitem.cpp.

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


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 484 of file qgsdataitem.cpp.

QgsDirectoryItem::~QgsDirectoryItem ( )

Definition at line 529 of file qgsdataitem.cpp.

Member Function Documentation

QVector< QgsDataItem * > QgsDirectoryItem::createChildren ( )

Reimplemented from QgsDataItem.

Definition at line 538 of file qgsdataitem.cpp.

QString QgsDirectoryItem::dirPath ( ) const

Definition at line 274 of file qgsdataitem.h.

bool QgsDirectoryItem::equal ( const QgsDataItem other)

Reimplemented from QgsDataItem.

Definition at line 611 of file qgsdataitem.cpp.

QIcon QgsDirectoryItem::icon ( )

Reimplemented from QgsDataItem.

Definition at line 533 of file qgsdataitem.cpp.

void QgsDirectoryItem::init ( )

Definition at line 492 of file qgsdataitem.cpp.

QWidget * QgsDirectoryItem::paramWidget ( )

Reimplemented from QgsDataItem.

Definition at line 621 of file qgsdataitem.cpp.

Member Data Documentation

QString QgsDirectoryItem::mDirPath

Definition at line 285 of file qgsdataitem.h.

QVector< QLibrary * > QgsDirectoryItem::mLibraries = QVector<QLibrary*>()
not available via python bindings

Definition at line 281 of file qgsdataitem.h.

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