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.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QList>
#include <QString>
#include <QVariant>
#include <QVector>
 
using namespace Qt::StringLiterals;
 
class QgsVectorLayer;
 
// TODO QGIS 5 : Remove class QgsSymbolLayerId

class CORE_EXPORT QgsSymbolLayerId
{
  public:
    QgsSymbolLayerId() {}

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

    QgsSymbolLayerId( const 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; }
 
    // TODO c++20 - replace with = default
 
    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; }
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
 
    QStringList pathString;
    for ( int path : sipCpp->symbolLayerIndexPath() )
    {
      pathString.append( QString::number( path ) );
    }
    QString str = u"<QgsSymbolLayerId: %1 (%2)>"_s.arg( sipCpp->symbolKey(), pathString.join( ',' ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    QString mSymbolKey;

    QVector<int> mIndexPath;
};

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

    Q_DECL_DEPRECATED QgsSymbolLayerReference( const QString &layerId, const QgsSymbolLayerId &symbolLayer ) SIP_DEPRECATED : mLayerId( layerId ), mDeprecatedSymbolLayerId( symbolLayer ) {}

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

    QString layerId() const { return mLayerId; }

    Q_DECL_DEPRECATED QgsSymbolLayerId symbolLayerId() const SIP_DEPRECATED { return mDeprecatedSymbolLayerId; }

    QString symbolLayerIdV2() const { return mSymbolLayerId; }
 
    bool operator==( const QgsSymbolLayerReference &other ) const
    {
      return mLayerId == other.mLayerId && mSymbolLayerId == other.mSymbolLayerId && mDeprecatedSymbolLayerId == other.mDeprecatedSymbolLayerId;
    }
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
 
    QStringList pathString;
    for ( int path : sipCpp->symbolLayerId().symbolLayerIndexPath() )
    {
      pathString.append( QString::number( path ) );
    }
    QString str = u"<QgsSymbolLayerReference: %1 - %2>"_s.arg( sipCpp->layerId(), sipCpp->symbolLayerIdV2() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    QString mLayerId;
 
    // TODO QGIS 5 : remove mDeprecatedSymbolLayerId
    QgsSymbolLayerId mDeprecatedSymbolLayerId;
 
    QString 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.symbolLayerIdV2() );
}
 
typedef QList<QgsSymbolLayerReference> QgsSymbolLayerReferenceList;

CORE_EXPORT QString symbolLayerReferenceListToString( const QgsSymbolLayerReferenceList & );

CORE_EXPORT QgsSymbolLayerReferenceList stringToSymbolLayerReferenceList( const QString & );
 
#endif