Item that represents a layer that can be opened with one of the providers. More...

#include <qgsdataitem.h>

Inheritance diagram for QgsLayerItem:

Public Types
enum	LayerType { NoType, Vector, Raster, Point, Line, Polygon, TableLayer, Database, Table, Plugin }

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 Member Functions
	QgsLayerItem (QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, LayerType layerType, const QString &providerKey)

virtual QString	comments () const
	Returns comments of the layer. More...

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 QString	layerName () const

QgsMapLayer::LayerType	mapLayerType ()
	Returns QgsMapLayer::LayerType. More...

QString	providerKey ()
	Returns provider key. More...

QStringList	supportedCRS ()
	Returns the supported CRS. More...

QStringList	supportedFormats ()
	Returns the supported formats. More...

QString	uri ()
	Returns layer uri or empty string if layer cannot be created. More...

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 QVector< QgsDataItem * >	createChildren ()
	Create children. More...

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

virtual QIcon	icon ()

Q_DECL_DEPRECATED bool	isPopulated ()

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

QString	name () const

virtual QWidget *	paramWidget ()

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)

virtual void	setState (State state)
	Set item state. More...

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 const QIcon &	iconDefault ()

static const QIcon &	iconLine ()

static const QIcon &	iconPoint ()

static const QIcon &	iconPolygon ()

static const QIcon &	iconRaster ()

static const QIcon &	iconTable ()

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)

Protected Attributes
LayerType	mLayerType
	The layer type. More...

QString	mProviderKey
	The provider key. More...

QStringList	mSupportedCRS
	The list of supported CRS. More...

QStringList	mSupportFormats
	The list of supported formats. More...

QString	mUri
	The URI. More...

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

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)

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)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

Item that represents a layer that can be opened with one of the providers.

Definition at line 308 of file qgsdataitem.h.

Member Enumeration Documentation

◆ LayerType

enum QgsLayerItem::LayerType

Enumerator
NoType
Vector
Raster
Point
Line
Polygon
TableLayer
Database
Table
Plugin	added in 2.10

Definition at line 312 of file qgsdataitem.h.

Constructor & Destructor Documentation

◆ QgsLayerItem()

QgsLayerItem::QgsLayerItem	(	QgsDataItem *	parent,
		const QString &	name,
		const QString &	path,
		const QString &	uri,
		LayerType	layerType,
		const QString &	providerKey
	)

Definition at line 678 of file qgsdataitem.cpp.

Member Function Documentation

◆ comments()

virtual QString QgsLayerItem::comments ( ) const

inlinevirtual

Returns comments of the layer.

Note: added in 2.12

Definition at line 356 of file qgsdataitem.h.

◆ equal()

bool QgsLayerItem::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 720 of file qgsdataitem.cpp.

◆ iconDefault()

const QIcon & QgsLayerItem::iconDefault ( )

static

Definition at line 149 of file qgsdataitem.cpp.

◆ iconLine()

const QIcon & QgsLayerItem::iconLine ( )

static

Definition at line 109 of file qgsdataitem.cpp.

◆ iconPoint()

const QIcon & QgsLayerItem::iconPoint ( )

static

Definition at line 99 of file qgsdataitem.cpp.

◆ iconPolygon()

const QIcon & QgsLayerItem::iconPolygon ( )

static

Definition at line 119 of file qgsdataitem.cpp.

◆ iconRaster()

const QIcon & QgsLayerItem::iconRaster ( )

static

Definition at line 139 of file qgsdataitem.cpp.

◆ iconTable()

const QIcon & QgsLayerItem::iconTable ( )

static

Definition at line 129 of file qgsdataitem.cpp.

◆ layerName()

virtual QString QgsLayerItem::layerName ( ) const

inlinevirtual

Returns: the layer name

Definition at line 380 of file qgsdataitem.h.

◆ mapLayerType()

QgsMapLayer::LayerType QgsLayerItem::mapLayerType ( )

Returns QgsMapLayer::LayerType.

Definition at line 711 of file qgsdataitem.cpp.

◆ providerKey()

QString QgsLayerItem::providerKey ( )

inline

Returns provider key.

Definition at line 341 of file qgsdataitem.h.

◆ supportedCRS()

QStringList QgsLayerItem::supportedCRS ( )

inline

Returns the supported CRS.

Note: Added in 2.8

Definition at line 346 of file qgsdataitem.h.

◆ supportedFormats()

QStringList QgsLayerItem::supportedFormats ( )

inline

Returns the supported formats.

Note: Added in 2.8

Definition at line 351 of file qgsdataitem.h.

◆ uri()

QString QgsLayerItem::uri ( )

inline

Returns layer uri or empty string if layer cannot be created.

Definition at line 338 of file qgsdataitem.h.

Member Data Documentation

◆ mLayerType

LayerType QgsLayerItem::mLayerType

protected

The layer type.

Definition at line 365 of file qgsdataitem.h.

◆ mProviderKey

QString QgsLayerItem::mProviderKey

protected

The provider key.

Definition at line 361 of file qgsdataitem.h.

◆ mSupportedCRS

QStringList QgsLayerItem::mSupportedCRS

protected

The list of supported CRS.

Definition at line 367 of file qgsdataitem.h.

◆ mSupportFormats

QStringList QgsLayerItem::mSupportFormats

protected

The list of supported formats.

Definition at line 369 of file qgsdataitem.h.

◆ mUri

QString QgsLayerItem::mUri

protected

The URI.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LayerType

Constructor & Destructor Documentation

◆ QgsLayerItem()

Member Function Documentation

◆ comments()

◆ equal()

◆ iconDefault()

◆ iconLine()

◆ iconPoint()

◆ iconPolygon()

◆ iconRaster()

◆ iconTable()

◆ layerName()

◆ mapLayerType()

◆ providerKey()

◆ supportedCRS()

◆ supportedFormats()

◆ uri()

Member Data Documentation

◆ mLayerType

◆ mProviderKey

◆ mSupportedCRS

◆ mSupportFormats

◆ mUri