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, Favorites, Project, Custom }

Public Slots
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. This is used when refreshing collapsed items. More...

virtual void	populate (bool foreground=false)

virtual void	refresh ()

virtual void	refreshConnections ()
	Refresh connections: update GUI and emit signal. More...

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...

QList< QAction * >	actions (QWidget *parent) override
	Returns the list of actions available for this item. More...

QVector< QgsDataItem * >	createChildren () override
	Create children. More...

QString	dirPath () const

bool	equal (const QgsDataItem *other) override
	Returns true if this item is equal to another item (by testing item type and path). More...

QIcon	icon () override

QWidget *	paramWidget () override

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

	~QgsDataCollectionItem () override

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...

	~QgsDataItem () override

virtual bool	acceptDrop ()
	Returns whether the item accepts drag and dropped layers - e.g. More...

virtual void	addChildItem (QgsDataItem *child, bool refresh=false)
	Inserts a new child item. More...

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	handleDoubleClick ()
	Called when a user double clicks on the item. More...

virtual bool	handleDrop (const QMimeData *, Qt::DropAction)
	Attempts to process the mime data dropped on this item. More...

bool	hasChildren ()

virtual bool	hasDragEnabled () const
	Returns true if the item may be dragged. More...

virtual QList< QMenu * >	menus (QWidget *parent)
	Returns the list of menus available for this item. More...

virtual QgsMimeDataUtils::Uri	mimeUri () const
	Return mime URI for the data item. More...

void	moveToThread (QThread *targetThread)
	Move object and all its descendants to thread. More...

QString	name () const
	Returns the name of the item (the displayed text for the item). More...

QgsDataItem *	parent () const
	Get item parent. More...

QString	path () const

	Q_ENUM (Type)

	Q_ENUM (State)

virtual QgsDataItem *	removeChildItem (QgsDataItem *child)
	Removes a child item and returns it without deleting it. More...

int	rowCount ()

virtual void	setCapabilities (Capabilities capabilities)
	Sets the capabilities for the data item. More...

virtual bool	setCrs (const QgsCoordinateReferenceSystem &crs)
	Writes the selected crs into data source. More...

void	setIcon (const QIcon &icon)

void	setIconName (const QString &iconName)

void	setName (const QString &name)
	Sets the name of the item (the displayed text for the item). More...

void	setParent (QgsDataItem *parent)
	Set item parent and connect / disconnect parent to / from item signals. More...

void	setPath (const QString &path)

void	setSortKey (const QVariant &key)
	Sets a custom sorting key for the item. More...

void	setToolTip (const QString &msg)

virtual QVariant	sortKey () const
	Returns the sorting key for the item. More...

State	state () const

QString	toolTip () const

Type	type () const

Static Public Member Functions
static bool	hiddenPath (const QString &path)
	Check if the given path is hidden from the browser model. More...

Static Public Member Functions inherited from QgsDataCollectionItem
static QIcon	iconDataCollection ()

static 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...

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 (const QVector< QgsDataItem *> &children)
	Refresh the items from a specified list of child items. More...

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 = nullptr

QString	mPath

QVariant	mSortKey
	Custom sort key. If invalid, name() will be used for sorting instead. More...

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	connectionsChanged ()
	Emitted when the provider's connections of the child items have changed This signal is normally forwarded to the app in order to refresh the connection item in the provider dialogs and to refresh the connection items in the other open browsers. More...

void	dataChanged (QgsDataItem *item)

void	endInsertItems ()

void	endRemoveItems ()

void	stateChanged (QgsDataItem *item, QgsDataItem::State oldState)

Protected Slots inherited from QgsDataItem
void	updateIcon ()
	Will request a repaint of this icon. More...

Detailed Description

A directory: contains subdirectories and layers.

Definition at line 528 of file qgsdataitem.h.

Member Enumeration Documentation

◆ Column

enum QgsDirectoryItem::Column

Enumerator
Name
Size
Date
Permissions
Owner
Group
Type

Definition at line 532 of file qgsdataitem.h.

Constructor & Destructor Documentation

◆ QgsDirectoryItem() [1/2]

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

Definition at line 710 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. favorites:

Definition at line 719 of file qgsdataitem.cpp.

Member Function Documentation

◆ actions()

QList< QAction * > QgsDirectoryItem::actions ( QWidget * parent )

overridevirtual

Returns the list of actions available for this item.

This is usually used for the popup menu on right-clicking the item. Subclasses should override this to provide actions.

Subclasses should ensure that ownership of created actions is correctly handled by parenting them to the specified parent widget.

Reimplemented from QgsDataItem.

Definition at line 899 of file qgsdataitem.cpp.

◆ childrenCreated

void QgsDirectoryItem::childrenCreated ( )

overrideslot

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

◆ directoryChanged

void QgsDirectoryItem::directoryChanged ( )

slot

Definition at line 862 of file qgsdataitem.cpp.

◆ dirPath()

QString QgsDirectoryItem::dirPath ( ) const

inline

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

◆ hiddenPath()

bool QgsDirectoryItem::hiddenPath ( const QString & path )

static

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

Definition at line 890 of file qgsdataitem.cpp.

◆ icon()

QIcon QgsDirectoryItem::icon ( )

overridevirtual

Reimplemented from QgsDataItem.

Definition at line 733 of file qgsdataitem.cpp.

◆ init()

void QgsDirectoryItem::init ( )

protected

Definition at line 728 of file qgsdataitem.cpp.

◆ paramWidget()

QWidget * QgsDirectoryItem::paramWidget ( )

overridevirtual

Reimplemented from QgsDataItem.

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

Since: QGIS 2.8

Reimplemented from QgsDataItem.

Definition at line 838 of file qgsdataitem.cpp.

Member Data Documentation

◆ mDirPath

QString QgsDirectoryItem::mDirPath

protected

Definition at line 574 of file qgsdataitem.h.

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

/tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsdataitem.h
/tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsdataitem.cpp

Public Types

Public Slots

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Column

Constructor & Destructor Documentation

◆ QgsDirectoryItem() [1/2]

◆ QgsDirectoryItem() [2/2]

Member Function Documentation

◆ actions()

◆ childrenCreated

◆ createChildren()

◆ directoryChanged

◆ dirPath()

◆ equal()

◆ hiddenPath()

◆ icon()

◆ init()

◆ paramWidget()

◆ setState()

Member Data Documentation

◆ mDirPath