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.

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(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

layerType¶

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¶

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]

decodeUriList(data: QMimeData) → object¶

Parameters: data (QMimeData) –
Return type: object

encodeUriList(layers: object) → QMimeData¶

Encodes a URI list to a new QMimeData object.

Parameters: layers (object) –
Return type: QMimeData

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