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 Types inherited from QgsDataItem
enum	Capability {   NoCapabilities = 0, SetCrs = 1 << 0, Fertile = 1 << 1, Fast = 1 << 2,   Collapse = 1 << 3 }
enum	State { NotPopulated, Populating, Populated }
enum	Type {   Collection, Directory, Layer, Error,   Favourites, Project }

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, const QString &name, const QString &path)
	QgsDirectoryItem (QgsDataItem *parent, const QString &name, const QString &dirPath, const QString &path)
	Constructor. More...
	~QgsDirectoryItem ()
QVector< QgsDataItem * >	createChildren () override
	Create children. More...
QString	dirPath () const
virtual bool	equal (const QgsDataItem *other) override
	Returns true if this item is equal to another item (by testing item type and path). More...
virtual QIcon	icon () override
virtual QWidget *	paramWidget () override
virtual void	setState (State state) override
	Set item state. More...
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 ()
	Returns whether the item accepts drag and dropped layers - e.g. More...
virtual QList< QAction * >	actions ()
	Returns the list of actions available for this item. More...
virtual void	addChildItem (QgsDataItem *child, bool refresh=false)
	Inserts a new child item. More...
virtual Q_DECL_DEPRECATED Capability	capabilities ()
virtual Capabilities	capabilities2 () const
QVector< QgsDataItem * >	children () const
virtual void	deleteChildItem (QgsDataItem *child)
	Removes and deletes a child item, emitting relevant signals to the model. More...
virtual bool	handleDrop (const QMimeData *, Qt::DropAction)
	Attempts to process the mime data dropped on this item. More...
bool	hasChildren ()
Q_DECL_DEPRECATED bool	isPopulated ()
void	moveToThread (QThread *targetThread)
	Move object and all its descendants to thread. More...
QString	name () const
QgsDataItem *	parent () const
	Get item parent. More...
QString	path () const
virtual QgsDataItem *	removeChildItem (QgsDataItem *child)
	Removes a child item and returns it without deleting it. More...
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)
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)
QObject *	child (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< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	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 QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () 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)
QThread *	thread () const

Static Public Member Functions
static bool	hiddenPath (QString path)
	Check if the given path is hidden from the browser model. More...
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 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 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 (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
QObject *	sender () 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
QMap< QString, QIcon >	mIconMap
QString	mIconName
QString	mName
QgsDataItem *	mParent
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 Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

A directory: contains subdirectories and layers.

Definition at line 403 of file qgsdataitem.h.

Member Enumeration Documentation

Column

enum QgsDirectoryItem::Column

Enumerator
Name
Size
Date
Permissions
Owner
Group
Type

Definition at line 407 of file qgsdataitem.h.

Constructor & Destructor Documentation

QgsDirectoryItem() [1/2]

Q_NOWARN_DEPRECATED_POP QgsDirectoryItem::QgsDirectoryItem	(	QgsDataItem *	parent,
		const QString &	name,
		const QString &	path
	)

Definition at line 763 of file qgsdataitem.cpp.

QgsDirectoryItem() [2/2]

QgsDirectoryItem::QgsDirectoryItem	(	QgsDataItem *	parent,
		const QString &	name,
		const QString &	dirPath,
		const 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 773 of file qgsdataitem.cpp.

~QgsDirectoryItem()

QgsDirectoryItem::~QgsDirectoryItem

(

)

Definition at line 787 of file qgsdataitem.cpp.

Member Function Documentation

childrenCreated

void QgsDirectoryItem::childrenCreated ( )

overridevirtualslot

Definition at line 923 of file qgsdataitem.cpp.

createChildren()

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

directoryChanged

void QgsDirectoryItem::directoryChanged ( )

slot

Definition at line 901 of file qgsdataitem.cpp.

dirPath()

QString QgsDirectoryItem::dirPath ( ) const

inline

Definition at line 432 of file qgsdataitem.h.

equal()

bool QgsDirectoryItem::equal ( const QgsDataItem *  other )

overridevirtual

Returns true if this item is equal to another item (by testing item type and path).

Reimplemented from QgsDataItem.

Definition at line 940 of file qgsdataitem.cpp.

hiddenPath()

bool QgsDirectoryItem::hiddenPath ( QString  path )

static

Check if the given path is hidden from the browser model.

Definition at line 914 of file qgsdataitem.cpp.

icon()

QIcon QgsDirectoryItem::icon ( )

overridevirtual

Reimplemented from QgsDataItem.

Definition at line 791 of file qgsdataitem.cpp.

init()

void QgsDirectoryItem::init ( )

protected

Definition at line 783 of file qgsdataitem.cpp.

paramWidget()

QWidget * QgsDirectoryItem::paramWidget ( )

overridevirtual

Reimplemented from QgsDataItem.

Definition at line 950 of file qgsdataitem.cpp.

setState()

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

Member Data Documentation

mDirPath

QString QgsDirectoryItem::mDirPath

protected

Definition at line 451 of file qgsdataitem.h.

mLibraries

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

static

Note

not available via python bindings

deprecated since 2.10 - use QgsDataItemProviderRegistry

Definition at line 440 of file qgsdataitem.h.

---

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

• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsdataitem.h
• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsdataitem.cpp