QGIS/python/core/auto_generated/qgsmimedatautils.sip.in
Nyall Dawson c864d22d1f Add "get ..." to doxygen compliance blacklist
Should be "gets ..." for consistent tense, or better yet
"returns ..." for consistency.
2018-05-27 14:05:06 +10:00

101 lines
2.8 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmimedatautils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsMimeDataUtils
{
%TypeHeaderCode
#include "qgsmimedatautils.h"
%End
public:
struct Uri
{
Uri();
%Docstring
Constructs invalid URI
%End
explicit Uri( QString &encData );
%Docstring
Constructs URI from encoded data
%End
bool isValid() const;
%Docstring
Returns whether the object contains valid data
.. versionadded:: 3.0
%End
QString data() const;
%Docstring
Returns encoded representation of the object
%End
QgsVectorLayer *vectorLayer( bool &owner, QString &error ) const;
%Docstring
Gets vector layer from uri if possible, otherwise returns 0 and error is set
:param owner: set to true if caller becomes owner
:param error: set to error message if cannot get vector
%End
QgsRasterLayer *rasterLayer( bool &owner, QString &error ) const;
%Docstring
Gets raster layer from uri if possible, otherwise returns 0 and error is set
:param owner: set to true if caller becomes owner
:param error: set to error message if cannot get raster
%End
QgsMeshLayer *meshLayer( bool &owner, QString &error ) const;
%Docstring
Gets mesh layer from uri if possible, otherwise returns 0 and error is set
:param owner: set to true if caller becomes owner
:param error: set to error message if cannot get raster
%End
QString layerType;
QString providerKey;
QString name;
QString uri;
QStringList supportedCrs;
QStringList supportedFormats;
};
typedef QList<QgsMimeDataUtils::Uri> UriList;
static QMimeData *encodeUriList( const UriList &layers );
static bool isUriList( const QMimeData *data );
static UriList decodeUriList( const QMimeData *data );
static QByteArray layerTreeNodesToUriList( const QList<QgsLayerTreeNode *> &nodes );
%Docstring
Returns encoded URI list from a list of layer tree nodes.
.. versionadded:: 3.0
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmimedatautils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/