qgssymbollayerreference.h

Go to the documentation of this file.

/***************************************************************************
 qgssymbollayerreference.h
 ---------------------
 begin                : June 2019
 copyright            : (C) 2019 by Hugo Mercier / Oslandia
 email                : infos at oslandia 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 QGSSYMBOLLAYERREFERENCE_H
#define QGSSYMBOLLAYERREFERENCE_H

#include "qgis_sip.h"
#include "qgis_core.h"
#include <QList>
#include <QVariant>
#include <QVector>

class QgsVectorLayer;

class CORE_EXPORT QgsSymbolLayerId
{
  public:
    QgsSymbolLayerId() {}

    QgsSymbolLayerId( QString key, int index )
      : mSymbolKey( key ), mIndexPath( { index } )
    {}

    QgsSymbolLayerId( QString key, const QVector<int> &indexPath )
      : mSymbolKey( key ), mIndexPath( { indexPath } )
    {}

    QgsSymbolLayerId( const QgsSymbolLayerId &other ) = default;

    QgsSymbolLayerId &operator=( const QgsSymbolLayerId &other ) = default;

    QString symbolKey() const { return mSymbolKey; }

    QVector<int> symbolLayerIndexPath() const { return mIndexPath; }

    bool operator==( const QgsSymbolLayerId &other ) const
    {
      return ( mSymbolKey == other.mSymbolKey && mIndexPath == other.mIndexPath );
    }

    bool operator<( const QgsSymbolLayerId &other ) const
    {
      return ( mSymbolKey == other.mSymbolKey ) ?
             mIndexPath < other.mIndexPath
             : mSymbolKey < other.mSymbolKey;
    }

  private:
    QString mSymbolKey;

    QVector<int> mIndexPath;
};

class CORE_EXPORT QgsSymbolLayerReference
{
  public:
    QgsSymbolLayerReference() = default;

    QgsSymbolLayerReference( const QString &layerId, const QgsSymbolLayerId &symbolLayer )
      : mLayerId( layerId ), mSymbolLayerId( symbolLayer )
    {}

    QString layerId() const { return mLayerId; }

    QgsSymbolLayerId symbolLayerId() const { return mSymbolLayerId; }

    bool operator==( const QgsSymbolLayerReference &other ) const
    {
      return mLayerId == other.mLayerId &&
             mSymbolLayerId == other.mSymbolLayerId;
    }

  private:
    QString mLayerId;
    QgsSymbolLayerId mSymbolLayerId;
};

inline uint qHash( const QgsSymbolLayerId &id )
{
  return qHash( id.symbolKey() ) ^ qHash( id.symbolLayerIndexPath() );
}

inline uint qHash( const QgsSymbolLayerReference &r )
{
  return qHash( r.layerId() ) ^ qHash( r.symbolLayerId() );
}

typedef QList<QgsSymbolLayerReference> QgsSymbolLayerReferenceList;

CORE_EXPORT QString symbolLayerReferenceListToString( const QgsSymbolLayerReferenceList & );

CORE_EXPORT QgsSymbolLayerReferenceList stringToSymbolLayerReferenceList( const QString & );

#endif