qgsselectivemaskingsource.h

Go to the documentation of this file.

/***************************************************************************
    qgsselectivemaskingsource.h
    ---------------------------
    begin                : January 2026
    copyright            : (C) 2026 by Nyall Dawson
    email                : nyall dot dawson 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 QGSSELECTIVEMASKINGSOURCE_H
#define QGSSELECTIVEMASKINGSOURCE_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsSelectiveMaskSource
{
  public:

    QgsSelectiveMaskSource() = default;

    QgsSelectiveMaskSource( const QString &layerId, Qgis::SelectiveMaskSourceType sourceType, const QString &sourceId = QString() );

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

    QString layerId() const { return mLayerId; }

    void setLayerId( const QString &id ) { mLayerId = id; }

    Qgis::SelectiveMaskSourceType sourceType() const { return mSourceType; }

    void setSourceType( Qgis::SelectiveMaskSourceType type ) { mSourceType = type; }

    QString sourceId() const { return mSourceId; }

    void setSourceId( const QString &id ) { mSourceId = id; }
 
#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    if ( !sipCpp->isValid() )
    {
      sipRes = PyUnicode_FromString( "<QgsSelectiveMaskSource: invalid>" );
    }
    else if ( sipCpp->sourceId().isEmpty() )
    {
      const QString str = u"<QgsSelectiveMaskSource: %1 (%2)>"_s.arg(
                            sipCpp->layerId(),
                            qgsEnumValueToKey( sipCpp->sourceType() ) );
      sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    }
    else
    {
      const QString str = u"<QgsSelectiveMaskSource: %1 - %2 (%3)>"_s.arg(
                            sipCpp->layerId(),
                            sipCpp->sourceId(),
                            qgsEnumValueToKey( sipCpp->sourceType() ) );
      sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    }
    % End
#endif
 
    bool operator==( const QgsSelectiveMaskSource &other ) const = default;
    bool operator!=( const QgsSelectiveMaskSource &other ) const = default;
 
  private:
    QString mLayerId;
    Qgis::SelectiveMaskSourceType mSourceType = Qgis::SelectiveMaskSourceType::SymbolLayer;
    QString mSourceId;
};
 
#endif //QGSSELECTIVEMASKINGSOURCE_H