QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 ()
 
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 ()
 
virtual void refresh ()
 
void setPopulatingIcon ()
 

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 ()
 Create children. More...
 
QString dirPath () const
 
virtual bool equal (const QgsDataItem *other)
 
virtual QIcon icon ()
 
virtual QWidget * paramWidget ()
 
virtual void setState (State state)
 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 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
 

Static Public Attributes

static 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)
 
QIcon populatingIcon ()
 
virtual void refresh (QVector< QgsDataItem * > children)
 

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 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 Protected Attributes inherited from QgsDataItem
static QMap< QString, QIcon > mIconMap = QMap<QString, QIcon>()
 

Detailed Description

A directory: contains subdirectories and layers.

Definition at line 313 of file qgsdataitem.h.

Member Enumeration Documentation

Enumerator
Name 
Size 
Date 
Permissions 
Owner 
Group 
Type 

Definition at line 317 of file qgsdataitem.h.

Constructor & Destructor Documentation

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

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

QgsDirectoryItem::~QgsDirectoryItem ( )

Definition at line 743 of file qgsdataitem.cpp.

Member Function Documentation

void QgsDirectoryItem::childrenCreated ( )
virtualslot

Definition at line 876 of file qgsdataitem.cpp.

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

Create children.

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

Reimplemented from QgsDataItem.

Definition at line 754 of file qgsdataitem.cpp.

void QgsDirectoryItem::directoryChanged ( )
slot

Definition at line 862 of file qgsdataitem.cpp.

QString QgsDirectoryItem::dirPath ( ) const
inline

Definition at line 342 of file qgsdataitem.h.

bool QgsDirectoryItem::equal ( const QgsDataItem other)
virtual

Reimplemented from QgsDataItem.

Definition at line 893 of file qgsdataitem.cpp.

QIcon QgsDirectoryItem::icon ( )
virtual

Reimplemented from QgsDataItem.

Definition at line 747 of file qgsdataitem.cpp.

void QgsDirectoryItem::init ( )
protected

Definition at line 706 of file qgsdataitem.cpp.

QWidget * QgsDirectoryItem::paramWidget ( )
virtual

Reimplemented from QgsDataItem.

Definition at line 903 of file qgsdataitem.cpp.

void QgsDirectoryItem::setState ( State  state)
virtual

Set item state.

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

Parameters
state

Reimplemented from QgsDataItem.

Definition at line 838 of file qgsdataitem.cpp.

Member Data Documentation

QString QgsDirectoryItem::mDirPath
protected

Definition at line 357 of file qgsdataitem.h.

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

Definition at line 349 of file qgsdataitem.h.


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