qgsmimedatautils.h

Go to the documentation of this file.

/***************************************************************************
    qgsmimedatautils.h
    ---------------------
    begin                : November 2011
    copyright            : (C) 2011 by Martin Dobias
    email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSMIMEDATAUTILS_H
#define QGSMIMEDATAUTILS_H

#include <QMimeData>
#include <QStringList>

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgswkbtypes.h"

class QgsLayerItem;
class QgsLayerTreeNode;
class QgsVectorLayer;
class QgsRasterLayer;
class QgsMeshLayer;
class QgsMapLayer;

class CORE_EXPORT QgsMimeDataUtils
{
  public:

    struct CORE_EXPORT Uri
    {
      Uri() = default;
      explicit Uri( const QString &encData );

      explicit Uri( QgsMapLayer *layer );

      bool isValid() const { return !layerType.isEmpty(); }

      QString data() const;

      QgsVectorLayer *vectorLayer( bool &owner, QString &error ) const;

      QgsRasterLayer *rasterLayer( bool &owner, QString &error ) const;

      QgsMeshLayer *meshLayer( bool &owner, QString &error ) const;

      QgsMapLayer *mapLayer() const;

      QString layerType;

      QString providerKey;

      QString name;
      QString uri;
      QStringList supportedCrs;
      QStringList supportedFormats;

      QString layerId;

      QString pId;

      QgsWkbTypes::Type wkbType = QgsWkbTypes::Unknown;

#ifdef SIP_RUN
      SIP_PYOBJECT __repr__();
      % MethodCode
      QString str = QStringLiteral( "<QgsMimeDataUtils::Uri (%1): %2>" ).arg( sipCpp->providerKey, sipCpp->uri );
      sipRes = PyUnicode_FromString( str.toUtf8().constData() );
      % End
#endif
    };
    typedef QList<QgsMimeDataUtils::Uri> UriList;

    static QMimeData *encodeUriList( const UriList &layers ) SIP_FACTORY;

    static bool isUriList( const QMimeData *data );

    static UriList decodeUriList( const QMimeData *data );

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

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

  private:
    static QString encode( const QStringList &items );
    static QStringList decode( const QString &encoded );
    static QByteArray uriListToByteArray( const UriList &layers );


    friend class TestQgsMimeDataUtils;

};

Q_DECLARE_METATYPE( QgsMimeDataUtils::UriList )

#endif // QGSMIMEDATAUTILS_H