QGIS API Documentation 3.29.0-Master (006c3c0232)
qgslayeritem.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslayeritem.h.cpp
3 -------------------
4 begin : 2011-04-01
5 copyright : (C) 2011 Radim Blazek
6 email : radim dot blazek at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#include "qgslayeritem.h"
19#include "qgsapplication.h"
20#include "qgsmaplayer.h"
21#include "qgsvectorlayer.h"
22#include "qgsiconutils.h"
23
25{
27}
28
30{
32}
33
35{
37}
38
40{
42}
43
45{
47}
48
50{
52}
53
55{
57}
58
60{
62}
63
65{
67}
68
70{
71 if ( parent() )
72 {
73 return parent()->databaseConnection();
74 }
75 return nullptr;
76}
77
79{
80 return mLayerMetadata;
81}
82
84{
85 mLayerMetadata = metadata;
86}
87
89{
91}
92
93QgsLayerItem::QgsLayerItem( QgsDataItem *parent, const QString &name, const QString &path,
94 const QString &uri, Qgis::BrowserLayerType layerType, const QString &providerKey )
95 : QgsDataItem( Qgis::BrowserItemType::Layer, parent, name, path, providerKey )
96 , mUri( uri )
97 , mLayerType( layerType )
98{
99 mIconName = iconName( layerType );
100}
101
103{
104 switch ( mLayerType )
105 {
108
111
114
117
120
130 }
131
132 return QgsMapLayerType::VectorLayer; // no warnings
133}
134
136{
137 switch ( layer->type() )
138 {
140 {
141 switch ( qobject_cast< QgsVectorLayer * >( layer )->geometryType() )
142 {
145
148
151
154
157 }
158
159 return Qgis::BrowserLayerType::Vector; // no warnings
160 }
161
174 return Qgis::BrowserLayerType::Vector; // will never happen!
175 }
176 return Qgis::BrowserLayerType::Vector; // no warnings
177}
178
180{
181 return qgsEnumValueToKey( layerType );
182}
183
185{
186 switch ( layerType )
187 {
189 return QStringLiteral( "/mIconPointLayer.svg" );
191 return QStringLiteral( "/mIconLineLayer.svg" );
193 return QStringLiteral( "/mIconPolygonLayer.svg" );
195 return QStringLiteral( "/mIconGeometryCollectionLayer.svg" );
198 return QStringLiteral( "/mIconTableLayer.svg" );
200 return QStringLiteral( "/mIconRaster.svg" );
202 return QStringLiteral( "/mIconMeshLayer.svg" );
204 return QStringLiteral( "/mIconPointCloudLayer.svg" );
205 default:
206 return QStringLiteral( "/mIconLayer.png" );
207 }
208}
209
211{
212 return false;
213}
214
216{
217 //QgsDebugMsg ( mPath + " x " + other->mPath );
218 if ( type() != other->type() )
219 {
220 return false;
221 }
222 //const QgsLayerItem *o = qobject_cast<const QgsLayerItem *> ( other );
223 const QgsLayerItem *o = qobject_cast<const QgsLayerItem *>( other );
224 if ( !o )
225 return false;
226
227 return ( mPath == o->mPath && mName == o->mName && mUri == o->mUri && mProviderKey == o->mProviderKey );
228}
229
231{
233
234 switch ( mapLayerType() )
235 {
237 u.layerType = QStringLiteral( "vector" );
238 switch ( mLayerType )
239 {
242 break;
245 break;
248 break;
251 break;
252
262 break;
263 }
264 break;
266 u.layerType = QStringLiteral( "raster" );
267 break;
269 u.layerType = QStringLiteral( "mesh" );
270 break;
272 u.layerType = QStringLiteral( "vector-tile" );
273 break;
275 u.layerType = QStringLiteral( "pointcloud" );
276 break;
278 u.layerType = QStringLiteral( "plugin" );
279 break;
281 u.layerType = QStringLiteral( "group" );
282 break;
284 u.layerType = QStringLiteral( "annotation" );
285 break;
286 }
287
289 u.name = layerName();
290 u.uri = uri();
293
295 {
296 u.filePath = path();
297 }
298
299 return { u };
300}
The Qgis class provides global constants for use throughout the application.
Definition: qgis.h:72
@ ItemRepresentsFile
Item's path() directly represents a file on disk (since QGIS 3.22)
BrowserLayerType
Browser item layer types.
Definition: qgis.h:403
@ Point
Vector point layer.
@ Plugin
Plugin based layer.
@ Line
Vector line layer.
@ Polygon
Vector polygon layer.
@ Table
Database table.
@ Vector
Generic vector layer.
@ VectorTile
Vector tile layer.
@ Raster
Raster layer.
@ TableLayer
Vector non-spatial layer.
@ Database
Database layer.
@ PointCloud
Point cloud layer.
The QgsAbstractDatabaseProviderConnection class provides common functionality for DB based connection...
Base class for all items in the model.
Definition: qgsdataitem.h:46
QString mName
Definition: qgsdataitem.h:449
QString mPath
Definition: qgsdataitem.h:455
virtual QgsAbstractDatabaseProviderConnection * databaseConnection() const
For data items that represent a DB connection or one of its children, this method returns a connectio...
Qgis::BrowserItemType type() const
Definition: qgsdataitem.h:324
QString mIconName
Definition: qgsdataitem.h:457
QString path() const
Definition: qgsdataitem.h:354
QgsDataItem * parent() const
Gets item parent.
Definition: qgsdataitem.h:330
virtual Qgis::BrowserItemCapabilities capabilities2() const
Returns the capabilities for the data item.
Definition: qgsdataitem.h:303
QString mProviderKey
Definition: qgsdataitem.h:450
static QIcon iconForWkbType(QgsWkbTypes::Type type)
Returns the icon for a vector layer whose geometry type is provided.
static QIcon iconLine()
Returns an icon representing line geometries.
static QIcon iconPolygon()
Returns an icon representing polygon geometries.
static QIcon iconDefaultLayer()
Returns a default icon for layers, which aren't the standard raster/vector/... types.
static QIcon iconPointCloud()
Returns an icon representing point cloud layers.
static QIcon iconPoint()
Returns an icon representing point geometries.
static QIcon iconTable()
Returns an icon representing non-spatial layers (tables).
static QIcon iconRaster()
Returns an icon representing raster layers.
static QIcon iconMesh()
Returns an icon representing mesh layers.
static QIcon iconVectorTile()
Returns an icon representing vector tile layers.
Item that represents a layer that can be opened with one of the providers.
Definition: qgslayeritem.h:31
QStringList supportedFormats() const
Returns the supported formats.
Definition: qgslayeritem.h:84
static QIcon iconPoint()
QString uri() const
Returns layer uri or empty string if layer cannot be created.
Definition: qgslayeritem.h:69
static Qgis::BrowserLayerType typeFromMapLayer(QgsMapLayer *layer)
Returns the layer item type corresponding to a QgsMapLayer layer.
virtual Q_DECL_DEPRECATED bool deleteLayer()
Delete this layer item Use QgsDataItemGuiProvider::deleteLayer instead.
static QIcon iconLine()
QString mUri
The URI.
Definition: qgslayeritem.h:114
QStringList supportedCrs() const
Returns the supported CRS.
Definition: qgslayeritem.h:78
static QIcon iconTable()
static QString layerTypeAsString(Qgis::BrowserLayerType layerType)
Returns the string representation of the given layerType.
static QIcon iconDefault()
QgsAbstractDatabaseProviderConnection * databaseConnection() const override
For data items that represent a DB connection or one of its children, this method returns a connectio...
QgsMapLayerType mapLayerType() const
Returns QgsMapLayerType.
QString providerKey() const
Returns provider key.
Definition: qgslayeritem.h:72
static QIcon iconRaster()
static QIcon iconMesh()
Returns icon for mesh layer type.
QgsLayerItem(QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, Qgis::BrowserLayerType layerType, const QString &providerKey)
Constructor for QgsLayerItem.
Qgis::BrowserLayerType mLayerType
The layer type.
Definition: qgslayeritem.h:116
static QIcon iconForWkbType(QgsWkbTypes::Type type)
Returns the icon for a vector layer whose geometry type is provided.
static QIcon iconPolygon()
QgsMimeDataUtils::UriList mimeUris() const override
Returns mime URIs for the data item, most data providers will only return a single URI but some data ...
void setLayerMetadata(const QgsLayerMetadata &metadata)
Set layer's metadata.
static QIcon iconPointCloud()
Returns icon for point cloud layer.
static QIcon iconVectorTile()
Returns icon for vector tile layer.
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
Definition: qgslayeritem.h:143
bool equal(const QgsDataItem *other) override
Returns true if this item is equal to another item (by testing item type and path).
static QString iconName(Qgis::BrowserLayerType layerType)
Returns the icon name of the given layerType.
A structured metadata store for a map layer.
Base class for all map layer types.
Definition: qgsmaplayer.h:73
QgsMapLayerType type
Definition: qgsmaplayer.h:80
QList< QgsMimeDataUtils::Uri > UriList
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:70
QgsMapLayerType
Types of layers that can be added to a map.
Definition: qgis.h:47
@ PointCloudLayer
Point cloud layer. Added in QGIS 3.18.
@ MeshLayer
Mesh layer. Added in QGIS 3.2.
@ VectorLayer
Vector layer.
@ RasterLayer
Raster layer.
@ GroupLayer
Composite group layer. Added in QGIS 3.24.
@ VectorTileLayer
Vector tile layer. Added in QGIS 3.14.
@ AnnotationLayer
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ PluginLayer
Plugin based layer.
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition: qgis.h:3119
QString filePath
Path to file, if uri is associated with a file.
QString uri
Identifier of the data source recognized by its providerKey.
QString name
Human readable name to be used e.g. in layer tree.
QString providerKey
For "vector" / "raster" type: provider id.
QgsWkbTypes::Type wkbType
WKB type, if associated with a vector layer, or QgsWkbTypes::Unknown if not yet known.
QString layerType
Type of URI.