QGIS API Documentation 3.41.0-Master (fda2aa46e9a)
Loading...
Searching...
No Matches
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 "moc_qgslayeritem.cpp"
20#include "qgsmaplayer.h"
21#include "qgsvectorlayer.h"
22#include "qgsiconutils.h"
23
28
33
38
43
48
53
58
63
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
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
137
139{
140 switch ( layer->type() )
141 {
143 {
144 switch ( qobject_cast< QgsVectorLayer * >( layer )->geometryType() )
145 {
148
151
154
157
160 }
161
162 return Qgis::BrowserLayerType::Vector; // no warnings
163 }
164
179 return Qgis::BrowserLayerType::Vector; // will never happen!
180 }
181 return Qgis::BrowserLayerType::Vector; // no warnings
182}
183
185{
186 return qgsEnumValueToKey( layerType );
187}
188
190{
191 switch ( layerType )
192 {
194 return QStringLiteral( "/mIconPointLayer.svg" );
196 return QStringLiteral( "/mIconLineLayer.svg" );
198 return QStringLiteral( "/mIconPolygonLayer.svg" );
200 return QStringLiteral( "/mIconGeometryCollectionLayer.svg" );
203 return QStringLiteral( "/mIconTableLayer.svg" );
205 return QStringLiteral( "/mIconRaster.svg" );
207 return QStringLiteral( "/mIconMeshLayer.svg" );
209 return QStringLiteral( "/mIconPointCloudLayer.svg" );
211 return QStringLiteral( "/mIconVectorTileLayer.svg" );
213 return QStringLiteral( "/mIconTiledSceneLayer.svg" );
214
218 return QStringLiteral( "/mIconLayer.png" );
219 }
221}
222
224{
225 return false;
226}
227
229{
230 //QgsDebugMsg ( mPath + " x " + other->mPath );
231 if ( type() != other->type() )
232 {
233 return false;
234 }
235 //const QgsLayerItem *o = qobject_cast<const QgsLayerItem *> ( other );
236 const QgsLayerItem *o = qobject_cast<const QgsLayerItem *>( other );
237 if ( !o )
238 return false;
239
240 return ( mPath == o->mPath && mName == o->mName && mUri == o->mUri && mProviderKey == o->mProviderKey );
241}
242
244{
246
247 switch ( mapLayerType() )
248 {
250 u.layerType = QStringLiteral( "vector" );
251 switch ( mLayerType )
252 {
255 break;
258 break;
261 break;
264 break;
265
276 break;
277 }
278 break;
280 u.layerType = QStringLiteral( "raster" );
281 break;
283 u.layerType = QStringLiteral( "mesh" );
284 break;
286 u.layerType = QStringLiteral( "vector-tile" );
287 break;
289 u.layerType = QStringLiteral( "pointcloud" );
290 break;
292 u.layerType = QStringLiteral( "tiled-scene" );
293 break;
295 u.layerType = QStringLiteral( "plugin" );
296 break;
298 u.layerType = QStringLiteral( "group" );
299 break;
301 u.layerType = QStringLiteral( "annotation" );
302 break;
303 }
304
306 u.name = layerName();
307 u.uri = uri();
310
312 {
313 u.filePath = path();
314 }
315
316 return { u };
317}
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
@ ItemRepresentsFile
Item's path() directly represents a file on disk.
@ Polygon
Polygons.
@ Unknown
Unknown types.
@ Null
No geometry.
BrowserLayerType
Browser item layer types.
Definition qgis.h:935
@ Point
Vector point layer.
@ Plugin
Plugin based layer.
@ Line
Vector line layer.
@ TiledScene
Tiled scene 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.
LayerType
Types of layers that can be added to a map.
Definition qgis.h:169
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ Vector
Vector layer.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ Raster
Raster layer.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:256
@ LineString
LineString.
@ Polygon
Polygon.
@ NoGeometry
No geometry.
The QgsAbstractDatabaseProviderConnection class provides common functionality for DB based connection...
Base class for all items in the model.
Definition qgsdataitem.h:46
QString mName
QString mPath
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
QString mIconName
QString path() const
QgsDataItem * parent() const
Gets item parent.
QString providerKey() const
Returns the provider key that created this item (e.g.
virtual Qgis::BrowserItemCapabilities capabilities2() const
Returns the capabilities for the data item.
QString mProviderKey
static QIcon iconLine()
Returns an icon representing line geometries.
static QIcon iconPolygon()
Returns an icon representing polygon geometries.
static QIcon iconForWkbType(Qgis::WkbType type)
Returns the icon for a vector layer whose geometry type is provided.
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.
QStringList supportedFormats() const
Returns the supported formats.
static QIcon iconPoint()
QString uri() const
Returns layer uri or empty string if layer cannot be created.
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.
QStringList supportedCrs() const
Returns the supported CRS.
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...
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.
static QIcon iconForWkbType(Qgis::WkbType type)
Returns the icon for a vector layer whose geometry type is provided.
Qgis::LayerType mapLayerType() const
Returns the associated map layer type.
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
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:76
Qgis::LayerType type
Definition qgsmaplayer.h:86
QList< QgsMimeDataUtils::Uri > UriList
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:6108
#define BUILTIN_UNREACHABLE
Definition qgis.h:6571
Qgis::WkbType wkbType
WKB type, if associated with a vector layer, or QgsWkbTypes::Unknown if not yet known.
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.
QString layerType
Type of URI.