QGIS API Documentation 3.27.0-Master (f261cc1f8b)
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{
81}
82
83QgsLayerItem::QgsLayerItem( QgsDataItem *parent, const QString &name, const QString &path,
84 const QString &uri, Qgis::BrowserLayerType layerType, const QString &providerKey )
85 : QgsDataItem( Qgis::BrowserItemType::Layer, parent, name, path, providerKey )
86 , mUri( uri )
87 , mLayerType( layerType )
88{
89 mIconName = iconName( layerType );
90}
91
93{
94 switch ( mLayerType )
95 {
98
101
104
107
110
120 }
121
122 return QgsMapLayerType::VectorLayer; // no warnings
123}
124
126{
127 switch ( layer->type() )
128 {
130 {
131 switch ( qobject_cast< QgsVectorLayer * >( layer )->geometryType() )
132 {
135
138
141
144
147 }
148
149 return Qgis::BrowserLayerType::Vector; // no warnings
150 }
151
164 return Qgis::BrowserLayerType::Vector; // will never happen!
165 }
166 return Qgis::BrowserLayerType::Vector; // no warnings
167}
168
170{
171 return qgsEnumValueToKey( layerType );
172}
173
175{
176 switch ( layerType )
177 {
179 return QStringLiteral( "/mIconPointLayer.svg" );
181 return QStringLiteral( "/mIconLineLayer.svg" );
183 return QStringLiteral( "/mIconPolygonLayer.svg" );
185 return QStringLiteral( "/mIconGeometryCollectionLayer.svg" );
188 return QStringLiteral( "/mIconTableLayer.svg" );
190 return QStringLiteral( "/mIconRaster.svg" );
192 return QStringLiteral( "/mIconMeshLayer.svg" );
194 return QStringLiteral( "/mIconPointCloudLayer.svg" );
195 default:
196 return QStringLiteral( "/mIconLayer.png" );
197 }
198}
199
201{
202 return false;
203}
204
206{
207 //QgsDebugMsg ( mPath + " x " + other->mPath );
208 if ( type() != other->type() )
209 {
210 return false;
211 }
212 //const QgsLayerItem *o = qobject_cast<const QgsLayerItem *> ( other );
213 const QgsLayerItem *o = qobject_cast<const QgsLayerItem *>( other );
214 if ( !o )
215 return false;
216
217 return ( mPath == o->mPath && mName == o->mName && mUri == o->mUri && mProviderKey == o->mProviderKey );
218}
219
221{
223
224 switch ( mapLayerType() )
225 {
227 u.layerType = QStringLiteral( "vector" );
228 switch ( mLayerType )
229 {
232 break;
235 break;
238 break;
241 break;
242
252 break;
253 }
254 break;
256 u.layerType = QStringLiteral( "raster" );
257 break;
259 u.layerType = QStringLiteral( "mesh" );
260 break;
262 u.layerType = QStringLiteral( "vector-tile" );
263 break;
265 u.layerType = QStringLiteral( "pointcloud" );
266 break;
268 u.layerType = QStringLiteral( "plugin" );
269 break;
271 u.layerType = QStringLiteral( "group" );
272 break;
274 u.layerType = QStringLiteral( "annotation" );
275 break;
276 }
277
279 u.name = layerName();
280 u.uri = uri();
283
285 {
286 u.filePath = path();
287 }
288
289 return { u };
290}
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:30
QStringList supportedFormats() const
Returns the supported formats.
Definition: qgslayeritem.h:83
static QIcon iconPoint()
QString uri() const
Returns layer uri or empty string if layer cannot be created.
Definition: qgslayeritem.h:68
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:113
QStringList supportedCrs() const
Returns the supported CRS.
Definition: qgslayeritem.h:77
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:71
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:115
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 ...
static QIcon iconPointCloud()
Returns icon for point cloud layer.
static QIcon iconVectorTile()
Returns icon for vector tile layer.
virtual QString layerName() const
Definition: qgslayeritem.h:142
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.
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:2571
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.