Class: QgsMimeDataUtils

class qgis.core.QgsMimeDataUtils

Bases: sip.wrapper

QgsMimeDataUtils(QgsMimeDataUtils)

Methods

decodeUriList

param data

encodeUriList

Encodes a URI list to a new QMimeData object.

hasOriginatedFromCurrentAppInstance

Returns True if uri originated from the current QGIS application instance.

isUriList

param data

layerTreeNodesToUriList

Returns encoded URI list from a list of layer tree nodes.

class Uri

Bases: sip.wrapper

Constructs invalid URI

QgsMimeDataUtils.Uri(encData: str) Constructs URI from encoded data

QgsMimeDataUtils.Uri(layer: QgsMapLayer) Constructs a URI corresponding to the specified layer.

New in version 3.8.

QgsMimeDataUtils.Uri(QgsMimeDataUtils.Uri)

data(self) → str

Returns encoded representation of the object

Return type

str

isValid(self) → bool

Returns whether the object contains valid data

New in version 3.0.

Return type

bool

layerId
layerType
mapLayer(self) → QgsMapLayer

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

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

New in version 3.8.

Return type

QgsMapLayer

meshLayer(self, error: str) → Tuple[QgsMeshLayer, bool]

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

Parameters
  • owner – set to True if caller becomes owner

  • error (str) – set to error message if cannot get raster

Return type

Tuple[QgsMeshLayer, bool]

name
pId
providerKey
rasterLayer(self, error: str) → Tuple[QgsRasterLayer, bool]

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

Parameters
  • owner – set to True if caller becomes owner

  • error (str) – set to error message if cannot get raster

Return type

Tuple[QgsRasterLayer, bool]

supportedCrs
supportedFormats
uri
vectorLayer(self, error: str) → Tuple[QgsVectorLayer, bool]

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

Parameters
  • owner – set to True if caller becomes owner

  • error (str) – set to error message if cannot get vector

Return type

Tuple[QgsVectorLayer, bool]

wkbType
decodeUriList(data: QMimeData) → List[QgsMimeDataUtils.Uri]
Parameters

data (QMimeData) –

Return type

List[QgsMimeDataUtils.Uri]

encodeUriList(layers: Iterable[QgsMimeDataUtils.Uri]) → QMimeData

Encodes a URI list to a new QMimeData object.

Parameters

layers (Iterable[QgsMimeDataUtils.Uri]) –

Return type

QMimeData

hasOriginatedFromCurrentAppInstance(uri: QgsMimeDataUtils.Uri) → bool

Returns True if uri originated from the current QGIS application instance.

New in version 3.8.

Parameters

uri (QgsMimeDataUtils.Uri) –

Return type

bool

isUriList(data: QMimeData) → bool
Parameters

data (QMimeData) –

Return type

bool

layerTreeNodesToUriList(nodes: Iterable[QgsLayerTreeNode]) → QByteArray

Returns encoded URI list from a list of layer tree nodes.

New in version 3.0.

Parameters

nodes (Iterable[QgsLayerTreeNode]) –

Return type

QByteArray