QgsMimeDataUtils::Uri Struct Reference

#include <qgsmimedatautils.h>

Public Member Functions
	Uri ()=default
	Constructs invalid URI.
	Uri (const QString &encData)
	Constructs URI from encoded data.
	Uri (QgsMapLayer *layer)
	Constructs a URI corresponding to the specified layer.
QString	data () const
	Returns encoded representation of the object.
bool	isValid () const
	Returns whether the object contains valid data.
QgsMapLayer *	mapLayer () const
	Returns the layer from the active project corresponding to this uri (if possible), otherwise returns nullptr.
QgsMeshLayer *	meshLayer (bool &owner, QString &error) const
	Gets mesh layer from uri if possible, otherwise returns nullptr and error is set.
QgsRasterLayer *	rasterLayer (bool &owner, QString &error) const
	Gets raster layer from uri if possible, otherwise returns nullptr and error is set.
QgsVectorLayer *	vectorLayer (bool &owner, QString &error) const
	Gets vector layer from uri if possible, otherwise returns nullptr and error is set.

Public Attributes
QString	filePath
	Path to file, if uri is associated with a file.
QString	layerId
	Layer ID, if uri is associated with a layer from a QgsProject.
QString	layerType
	Type of URI.
QString	name
	Human readable name to be used e.g. in layer tree.
QString	pId
	Unique ID associated with application instance.
QString	providerKey
	For "vector" / "raster" type: provider id.
QStringList	supportedCrs
QStringList	supportedFormats
QString	uri
	Identifier of the data source recognized by its providerKey.
Qgis::WkbType	wkbType = Qgis::WkbType::Unknown
	WKB type, if associated with a vector layer, or QgsWkbTypes::Unknown if not yet known.

Detailed Description

Definition at line 41 of file qgsmimedatautils.h.

Constructor & Destructor Documentation

Uri() [1/3]

QgsMimeDataUtils::Uri::Uri ( )

default

Constructs invalid URI.

Uri() [2/3]

QgsMimeDataUtils::Uri::Uri ( const QString &  encData )

explicit

Constructs URI from encoded data.

Definition at line 29 of file qgsmimedatautils.cpp.

Uri() [3/3]

QgsMimeDataUtils::Uri::Uri ( QgsMapLayer *  layer )

explicit

Constructs a URI corresponding to the specified layer.

Since

QGIS 3.8

Definition at line 67 of file qgsmimedatautils.cpp.

Member Function Documentation

data()

QString QgsMimeDataUtils::Uri::data

(

)

const

Returns encoded representation of the object.

Definition at line 119 of file qgsmimedatautils.cpp.

isValid()

bool QgsMimeDataUtils::Uri::isValid ( ) const

inline

Returns whether the object contains valid data.

Definition at line 58 of file qgsmimedatautils.h.

mapLayer()

QgsMapLayer * QgsMimeDataUtils::Uri::mapLayer

(

)

const

Returns the layer from the active project corresponding to this uri (if possible), otherwise returns nullptr.

Unlike vectorLayer(), rasterLayer(), or meshLayer(), this method will not attempt to create a new layer corresponding to the URI.

Since

QGIS 3.8

Definition at line 206 of file qgsmimedatautils.cpp.

meshLayer()

QgsMeshLayer * QgsMimeDataUtils::Uri::meshLayer	(	bool &	owner,
		QString &	error
	)		const

Gets mesh layer from uri if possible, otherwise returns nullptr and error is set.

Parameters

owner	set to true if caller becomes owner
error	set to error message if cannot get raster

Definition at line 184 of file qgsmimedatautils.cpp.

rasterLayer()

QgsRasterLayer * QgsMimeDataUtils::Uri::rasterLayer	(	bool &	owner,
		QString &	error
	)		const

Gets raster layer from uri if possible, otherwise returns nullptr and error is set.

Parameters

owner	set to true if caller becomes owner
error	set to error message if cannot get raster

Definition at line 162 of file qgsmimedatautils.cpp.

vectorLayer()

QgsVectorLayer * QgsMimeDataUtils::Uri::vectorLayer	(	bool &	owner,
		QString &	error
	)		const

Gets vector layer from uri if possible, otherwise returns nullptr and error is set.

Parameters

owner	set to true if caller becomes owner
error	set to error message if cannot get vector

Definition at line 134 of file qgsmimedatautils.cpp.

Member Data Documentation

filePath

QString QgsMimeDataUtils::Uri::filePath

Path to file, if uri is associated with a file.

Since

QGIS 3.22

Definition at line 155 of file qgsmimedatautils.h.

layerId

QString QgsMimeDataUtils::Uri::layerId

Layer ID, if uri is associated with a layer from a QgsProject.

Since

QGIS 3.8

Definition at line 134 of file qgsmimedatautils.h.

layerType

QString QgsMimeDataUtils::Uri::layerType

Type of URI.

Recognized types include

• "vector": vector layers
• "raster": raster layers
• "mesh": mesh layers
• "pointcloud": point cloud layers
• "vector-tile": vector tile layers
• "tiled-scene": tiled scene layers
• "plugin": plugin layers
• "custom": custom types
• "project": QGS/QGZ project file
• "directory": directory path

Mime data from plugins may use additional custom layer types.

Definition at line 113 of file qgsmimedatautils.h.

name

QString QgsMimeDataUtils::Uri::name

Human readable name to be used e.g. in layer tree.

Definition at line 124 of file qgsmimedatautils.h.

pId

QString QgsMimeDataUtils::Uri::pId

Unique ID associated with application instance.

Can be used to identify if mime data was created inside the current application instance or not.

Since

QGIS 3.8

Definition at line 141 of file qgsmimedatautils.h.

providerKey

QString QgsMimeDataUtils::Uri::providerKey

For "vector" / "raster" type: provider id.

For "plugin" type: plugin layer type name. For "custom" type: key of its QgsCustomDropHandler For "project" and "directory" types: unused

Definition at line 121 of file qgsmimedatautils.h.

supportedCrs

QStringList QgsMimeDataUtils::Uri::supportedCrs

Definition at line 127 of file qgsmimedatautils.h.

supportedFormats

QStringList QgsMimeDataUtils::Uri::supportedFormats

Definition at line 128 of file qgsmimedatautils.h.

uri

QString QgsMimeDataUtils::Uri::uri

Identifier of the data source recognized by its providerKey.

Definition at line 126 of file qgsmimedatautils.h.

wkbType

Qgis::WkbType QgsMimeDataUtils::Uri::wkbType = Qgis::WkbType::Unknown

WKB type, if associated with a vector layer, or QgsWkbTypes::Unknown if not yet known.

Since

QGIS 3.8

Definition at line 149 of file qgsmimedatautils.h.

---

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

• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/qgsmimedatautils.h
• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/qgsmimedatautils.cpp