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

#include <qgslayeritem.h>

Inheritance diagram for QgsLayerItem:

[legend]

Public Member Functions
	QgsLayerItem (QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, Qgis::BrowserLayerType layerType, const QString &providerKey)
	Constructor for QgsLayerItem.

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

QgsAbstractDatabaseProviderConnection *	databaseConnection () const override
	For data items that represent a DB connection or one of its children, this method returns a connection.

virtual Q_DECL_DEPRECATED bool	deleteLayer ()
	Delete this layer item Use QgsDataItemGuiProvider::deleteLayer instead.

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

bool	hasDragEnabled () const override
	Returns `true` if the item may be dragged.

const QgsLayerMetadata &	layerMetadata () const
	Returns layer's metadata, it may be a default constructed metadata if metadata is not explicitly set.

virtual QString	layerName () const

Qgis::LayerType	mapLayerType () const
	Returns the associated map layer type.

QgsMimeDataUtils::UriList	mimeUris () const override
	Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g.

void	setLayerMetadata (const QgsLayerMetadata &metadata)
	Set layer's metadata.

QStringList	supportedCrs () const
	Returns the supported CRS.

QStringList	supportedFormats () const
	Returns the supported formats.

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

Public Member Functions inherited from QgsDataItem
	QgsDataItem (Qgis::BrowserItemType type, QgsDataItem *parent, const QString &name, const QString &path, const QString &providerKey=QString())
	Constructor for QgsDataItem, with the specified parent item.

	~QgsDataItem () override

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

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

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

virtual Qgis::BrowserItemCapabilities	capabilities2 () const
	Returns the capabilities for the data item.

QVector< QgsDataItem * >	children () const

virtual QVector< QgsDataItem * >	createChildren ()
	Create children.

virtual void	deleteChildItem (QgsDataItem *child)
	Removes and deletes a child item, emitting relevant signals to the model.

virtual bool	handleDoubleClick ()
	Called when a user double clicks on the item.

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

bool	hasChildren ()

virtual QIcon	icon ()

virtual bool	layerCollection () const
	Returns `true` if the data item is a collection of layers The default implementation returns `false`, subclasses must implement this method if their children are layers.

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

virtual Q_DECL_DEPRECATED QgsMimeDataUtils::Uri	mimeUri () const
	Returns mime URI for the data item.

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

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

virtual Q_DECL_DEPRECATED QWidget *	paramWidget ()
	Returns source widget from data item for QgsBrowserPropertiesWidget.

QgsDataItem *	parent () const
	Gets item parent.

QString	path () const

QString	providerKey () const
	Returns the provider key that created this item (e.g.

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

virtual Q_DECL_DEPRECATED bool	rename (const QString &name)
	Sets a new name for the item, and returns `true` if the item was successfully renamed.

int	rowCount ()

Q_DECL_DEPRECATED void	setCapabilities (int capabilities)

virtual void	setCapabilities (Qgis::BrowserItemCapabilities capabilities)
	Sets the capabilities for the data item.

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

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

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

void	setPath (const QString &path)

void	setProviderKey (const QString &value)
	Sets the provider key that created this item (e.g.

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

virtual void	setState (Qgis::BrowserItemState state)
	Set item state.

void	setToolTip (const QString &msg)

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

Qgis::BrowserItemState	state () const

QString	toolTip () const

Qgis::BrowserItemType	type () const

Static Public Member Functions
static QIcon	iconDefault ()

static QIcon	iconForWkbType (Qgis::WkbType type)
	Returns the icon for a vector layer whose geometry type is provided.

static QIcon	iconLine ()

static QIcon	iconMesh ()
	Returns icon for mesh layer type.

static QString	iconName (Qgis::BrowserLayerType layerType)
	Returns the icon name of the given layerType.

static QIcon	iconPoint ()

static QIcon	iconPointCloud ()
	Returns icon for point cloud layer.

static QIcon	iconPolygon ()

static QIcon	iconRaster ()

static QIcon	iconTable ()

static QIcon	iconVectorTile ()
	Returns icon for vector tile layer.

static QString	layerTypeAsString (Qgis::BrowserLayerType layerType)
	Returns the string representation of the given layerType.

static Qgis::BrowserLayerType	typeFromMapLayer (QgsMapLayer *layer)
	Returns the layer item type corresponding to a QgsMapLayer layer.

Static Public Member Functions inherited from QgsDataItem
static void	deleteLater (QVector< QgsDataItem * > &items)

template<class T >
static QList< T * >	filteredItems (const QList< QgsDataItem * > &items)
	Returns a filtered list of data items which match the template type.

static int	findItem (QVector< QgsDataItem * > items, QgsDataItem *item)

static QString	pathComponent (const QString &component)
	Create path component replacing path separators.

Protected Attributes
Qgis::BrowserLayerType	mLayerType
	The layer type.

QStringList	mSupportedCRS
	The list of supported CRS.

QStringList	mSupportFormats
	The list of supported formats.

QString	mUri
	The URI.

Protected Attributes inherited from QgsDataItem
Qgis::BrowserItemCapabilities	mCapabilities = Qgis::BrowserItemCapability::NoCapabilities

QVector< QgsDataItem * >	mChildren

QIcon	mIcon

QMap< QString, QIcon >	mIconMap

QString	mIconName

QString	mName

QgsDataItem *	mParent = nullptr

QString	mPath

QString	mProviderKey

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

Qgis::BrowserItemState	mState = Qgis::BrowserItemState::NotPopulated

QString	mToolTip

Qgis::BrowserItemType	mType

Additional Inherited Members
Public Slots inherited from QgsDataItem
virtual void	childrenCreated ()

virtual void	deleteLater ()
	Safely delete the item:

virtual void	depopulate ()
	Remove children recursively and set as not populated. This is used when refreshing collapsed items.

virtual void	populate (bool foreground=false)

virtual void	refresh ()

virtual void	refreshConnections (const QString &providerKey=QString())
	Causes a data item provider to refresh all registered connections.

Signals inherited from QgsDataItem
void	beginInsertItems (QgsDataItem *parent, int first, int last)
	Emitted before child items are added to this data item.

void	beginRemoveItems (QgsDataItem *parent, int first, int last)
	Emitted before child items are removed from this data item.

void	connectionsChanged (const QString &providerKey=QString())
	Emitted when the connections of the provider with the specified providerKey have changed.

void	dataChanged (QgsDataItem *item)
	Emitted when data changes for an item.

void	endInsertItems ()
	Emitted after child items have been added to this data item.

void	endRemoveItems ()
	Emitted after child items have been removed from this data item.

void	stateChanged (QgsDataItem *item, Qgis::BrowserItemState oldState)
	Emitted when an item's state is changed.

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

Protected Member Functions inherited from QgsDataItem
bool	deferredDelete ()
	The item is scheduled to be deleted.

virtual void	populate (const QVector< QgsDataItem * > &children)

virtual void	refresh (const QVector< QgsDataItem * > &children)
	Refresh the items from a specified list of child items.

Detailed Description

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

Definition at line 30 of file qgslayeritem.h.

Constructor & Destructor Documentation

◆ QgsLayerItem()

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

Constructor for QgsLayerItem.

Definition at line 93 of file qgslayeritem.cpp.

Member Function Documentation

◆ comments()

virtual QString QgsLayerItem::comments ( ) const

inlinevirtual

Returns comments of the layer.

Definition at line 86 of file qgslayeritem.h.

◆ databaseConnection()

QgsAbstractDatabaseProviderConnection * QgsLayerItem::databaseConnection ( ) const

overridevirtual

For data items that represent a DB connection or one of its children, this method returns a connection.

All other data items will return NULL.

Ownership of the returned objects is transferred to the caller.

Since: QGIS 3.16

Reimplemented from QgsDataItem.

Reimplemented in QgsProviderSublayerItem.

Definition at line 69 of file qgslayeritem.cpp.

◆ deleteLayer()

bool QgsLayerItem::deleteLayer ( )

virtual

Delete this layer item Use QgsDataItemGuiProvider::deleteLayer instead.

Deprecated:: QGIS 3.10

Definition at line 223 of file qgslayeritem.cpp.

◆ 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 228 of file qgslayeritem.cpp.

◆ hasDragEnabled()

bool QgsLayerItem::hasDragEnabled ( ) const

inlineoverridevirtual

Returns true if the item may be dragged.

Default implementation returns false. A draggable item has to implement mimeUris() that will be used to pass data.

See also: mimeUris()

Reimplemented from QgsDataItem.

Definition at line 53 of file qgslayeritem.h.

◆ iconDefault()

QIcon QgsLayerItem::iconDefault ( )

static

Definition at line 88 of file qgslayeritem.cpp.

◆ iconForWkbType()

QIcon QgsLayerItem::iconForWkbType ( Qgis::WkbType type )

static

Returns the icon for a vector layer whose geometry type is provided.

Since: QGIS 3.18

Definition at line 24 of file qgslayeritem.cpp.

◆ iconLine()

QIcon QgsLayerItem::iconLine ( )

static

Definition at line 34 of file qgslayeritem.cpp.

◆ iconMesh()

QIcon QgsLayerItem::iconMesh ( )

static

Returns icon for mesh layer type.

Definition at line 54 of file qgslayeritem.cpp.

◆ iconName()

QString QgsLayerItem::iconName ( Qgis::BrowserLayerType layerType )

static

Returns the icon name of the given layerType.

Since: QGIS 3

Definition at line 189 of file qgslayeritem.cpp.

◆ iconPoint()

QIcon QgsLayerItem::iconPoint ( )

static

Definition at line 29 of file qgslayeritem.cpp.

◆ iconPointCloud()

QIcon QgsLayerItem::iconPointCloud ( )

static

Returns icon for point cloud layer.

Definition at line 64 of file qgslayeritem.cpp.

◆ iconPolygon()

QIcon QgsLayerItem::iconPolygon ( )

static

Definition at line 39 of file qgslayeritem.cpp.

◆ iconRaster()

QIcon QgsLayerItem::iconRaster ( )

static

Definition at line 49 of file qgslayeritem.cpp.

◆ iconTable()

QIcon QgsLayerItem::iconTable ( )

static

Definition at line 44 of file qgslayeritem.cpp.

◆ iconVectorTile()

QIcon QgsLayerItem::iconVectorTile ( )

static

Returns icon for vector tile layer.

Definition at line 59 of file qgslayeritem.cpp.

◆ layerMetadata()

const QgsLayerMetadata & QgsLayerItem::layerMetadata ( ) const

Returns layer's metadata, it may be a default constructed metadata if metadata is not explicitly set.

Since: QGIS 3.28

Definition at line 78 of file qgslayeritem.cpp.

◆ layerName()

virtual QString QgsLayerItem::layerName ( ) const

inlinevirtual

Returns: the layer name

Reimplemented in QgsProviderSublayerItem.

Definition at line 139 of file qgslayeritem.h.

◆ layerTypeAsString()

QString QgsLayerItem::layerTypeAsString ( Qgis::BrowserLayerType layerType )

static

Returns the string representation of the given layerType.

Since: QGIS 3

Definition at line 184 of file qgslayeritem.cpp.

◆ mapLayerType()

Qgis::LayerType QgsLayerItem::mapLayerType ( ) const

Returns the associated map layer type.

Definition at line 102 of file qgslayeritem.cpp.

◆ mimeUris()

QgsMimeDataUtils::UriList QgsLayerItem::mimeUris ( ) const

overridevirtual

Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g.

GPKG, OGR) may report multiple URIs (e.g. for vector and raster layer types).

Items that return valid URI will be returned in mime data when dragging a selection from browser model.

Since: QGIS 3.18

Reimplemented from QgsDataItem.

Definition at line 243 of file qgslayeritem.cpp.

◆ setLayerMetadata()

void QgsLayerItem::setLayerMetadata ( const QgsLayerMetadata & metadata )

Set layer's metadata.

Since: QGIS 3.28

Definition at line 83 of file qgslayeritem.cpp.

◆ supportedCrs()

QStringList QgsLayerItem::supportedCrs ( ) const

inline

Returns the supported CRS.

Definition at line 76 of file qgslayeritem.h.

◆ supportedFormats()

QStringList QgsLayerItem::supportedFormats ( ) const

inline

Returns the supported formats.

Definition at line 81 of file qgslayeritem.h.

◆ typeFromMapLayer()

Qgis::BrowserLayerType QgsLayerItem::typeFromMapLayer ( QgsMapLayer * layer )

static

Returns the layer item type corresponding to a QgsMapLayer layer.

Since: QGIS 3.6

Definition at line 138 of file qgslayeritem.cpp.

◆ uri()

QString QgsLayerItem::uri ( ) const

inline

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

Definition at line 71 of file qgslayeritem.h.

Member Data Documentation

◆ mLayerType

Qgis::BrowserLayerType QgsLayerItem::mLayerType

protected

The layer type.

Definition at line 112 of file qgslayeritem.h.

◆ mSupportedCRS

QStringList QgsLayerItem::mSupportedCRS

protected

The list of supported CRS.

Definition at line 114 of file qgslayeritem.h.

◆ mSupportFormats

QStringList QgsLayerItem::mSupportFormats

protected

The list of supported formats.

Definition at line 116 of file qgslayeritem.h.

◆ mUri

QString QgsLayerItem::mUri

protected

The URI.

Definition at line 110 of file qgslayeritem.h.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/browser/qgslayeritem.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/browser/qgslayeritem.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLayerItem()

Member Function Documentation

◆ comments()

◆ databaseConnection()

◆ deleteLayer()

◆ equal()

◆ hasDragEnabled()

◆ iconDefault()

◆ iconForWkbType()

◆ iconLine()

◆ iconMesh()

◆ iconName()

◆ iconPoint()

◆ iconPointCloud()

◆ iconPolygon()

◆ iconRaster()

◆ iconTable()

◆ iconVectorTile()

◆ layerMetadata()

◆ layerName()

◆ layerTypeAsString()

◆ mapLayerType()

◆ mimeUris()

◆ setLayerMetadata()

◆ supportedCrs()

◆ supportedFormats()

◆ typeFromMapLayer()

◆ uri()

Member Data Documentation

◆ mLayerType

◆ mSupportedCRS

◆ mSupportFormats

◆ mUri