QgsDirectoryItem Class Reference

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

#include <qgsdataitem.h>

Inheritance diagram for QgsDirectoryItem:

Public Types
enum	Column {   Name, Size, Date, Permissions,   Owner, Group, Type }

Public Slots
virtual void	childrenCreated () override
void	directoryChanged ()

Public Member Functions
	QgsDirectoryItem (QgsDataItem *parent, QString name, QString path)
	QgsDirectoryItem (QgsDataItem *parent, QString name, QString dirPath, QString path)
	Constructor.
	~QgsDirectoryItem ()
QVector< QgsDataItem * >	createChildren () override
	Create children.
QString	dirPath () const
virtual bool	equal (const QgsDataItem *other) override
virtual QIcon	icon () override
virtual QWidget *	paramWidget () override
virtual void	setState (State state) override
	Set item state.
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)
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.
QString	name () const
QgsDataItem *	parent () const
	Get item parent.
QString	path () const
virtual QgsDataItem *	removeChildItem (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)
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 Attributes
QString	mDirPath

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

Detailed Description

A directory: contains subdirectories and layers.

Definition at line 329 of file qgsdataitem.h.

Member Enumeration Documentation

enum QgsDirectoryItem::Column

Enumerator:

Name
Size
Date
Permissions
Owner
Group
Type

Definition at line 333 of file qgsdataitem.h.

Constructor & Destructor Documentation

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

Definition at line 696 of file qgsdataitem.cpp.

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

Constructor.

Parameters

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

Definition at line 706 of file qgsdataitem.cpp.

QgsDirectoryItem::~QgsDirectoryItem

(

)

Definition at line 753 of file qgsdataitem.cpp.

Member Function Documentation

void QgsDirectoryItem::childrenCreated ( )

overridevirtualslot

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

void QgsDirectoryItem::directoryChanged ( )

slot

Definition at line 872 of file qgsdataitem.cpp.

QString QgsDirectoryItem::dirPath ( ) const

inline

Definition at line 358 of file qgsdataitem.h.

bool QgsDirectoryItem::equal ( const QgsDataItem *  other )

overridevirtual

Reimplemented from QgsDataItem.

Definition at line 903 of file qgsdataitem.cpp.

QIcon QgsDirectoryItem::icon ( )

overridevirtual

Reimplemented from QgsDataItem.

Definition at line 757 of file qgsdataitem.cpp.

void QgsDirectoryItem::init ( )

protected

Definition at line 716 of file qgsdataitem.cpp.

QWidget * QgsDirectoryItem::paramWidget ( )

overridevirtual

Reimplemented from QgsDataItem.

Definition at line 913 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

Reimplemented from QgsDataItem.

Definition at line 848 of file qgsdataitem.cpp.

Member Data Documentation

QString QgsDirectoryItem::mDirPath

protected

Definition at line 373 of file qgsdataitem.h.

QVector< QLibrary * > QgsDirectoryItem::mLibraries = QVector<QLibrary*>()

static

Note

not available via python bindings

Definition at line 365 of file qgsdataitem.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsdataitem.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsdataitem.cpp