QGIS API Documentation 3.39.0-Master (f549811d78c)
Loading...
Searching...
No Matches
Classes | Public Types | Static Public Member Functions | Friends | List of all members
QgsMimeDataUtils Class Reference

Contains utility functions for working with MIME data. More...

#include <qgsmimedatautils.h>

Classes

struct  Uri
 

Public Types

typedef QList< QgsMimeDataUtils::UriUriList
 

Static Public Member Functions

static UriList decodeUriList (const QMimeData *data)
 
static QMimeData * encodeUriList (const UriList &layers)
 Encodes a URI list to a new QMimeData object.
 
static bool hasOriginatedFromCurrentAppInstance (const QgsMimeDataUtils::Uri &uri)
 Returns true if uri originated from the current QGIS application instance.
 
static bool isUriList (const QMimeData *data)
 
static QByteArray layerTreeNodesToUriList (const QList< QgsLayerTreeNode * > &nodes)
 Returns encoded URI list from a list of layer tree nodes.
 

Friends

class TestQgsMimeDataUtils
 

Detailed Description

Contains utility functions for working with MIME data.

Definition at line 37 of file qgsmimedatautils.h.

Member Typedef Documentation

◆ UriList

Definition at line 165 of file qgsmimedatautils.h.

Member Function Documentation

◆ decodeUriList()

QgsMimeDataUtils::UriList QgsMimeDataUtils::decodeUriList ( const QMimeData *  data)
static

Definition at line 231 of file qgsmimedatautils.cpp.

◆ encodeUriList()

QMimeData * QgsMimeDataUtils::encodeUriList ( const UriList layers)
static

Encodes a URI list to a new QMimeData object.

Definition at line 222 of file qgsmimedatautils.cpp.

◆ hasOriginatedFromCurrentAppInstance()

bool QgsMimeDataUtils::hasOriginatedFromCurrentAppInstance ( const QgsMimeDataUtils::Uri uri)
static

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

Since
QGIS 3.8

Definition at line 278 of file qgsmimedatautils.cpp.

◆ isUriList()

bool QgsMimeDataUtils::isUriList ( const QMimeData *  data)
static

Definition at line 217 of file qgsmimedatautils.cpp.

◆ layerTreeNodesToUriList()

QByteArray QgsMimeDataUtils::layerTreeNodesToUriList ( const QList< QgsLayerTreeNode * > &  nodes)
static

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

Definition at line 269 of file qgsmimedatautils.cpp.

Friends And Related Symbol Documentation

◆ TestQgsMimeDataUtils

friend class TestQgsMimeDataUtils
friend

Definition at line 195 of file qgsmimedatautils.h.


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