qgsselectivemaskingsourceset.h

Go to the documentation of this file.

/***************************************************************************
    qgsselectivemaskingsourceset.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 QGSSELECTIVEMASKINGSOURCESET_H
#define QGSSELECTIVEMASKINGSOURCESET_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsselectivemaskingsource.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QDomElement;
class QDomDocument;
class QgsReadWriteContext;

class CORE_EXPORT QgsSelectiveMaskingSourceSet
{
  public:

    QgsSelectiveMaskingSourceSet();

    bool isValid() const { return mIsValid; }

    void setId( const QString &id ) { mId = id; }

    QString id() const { return mId; }

    QString name() const { return mName; }

    void setName( const QString &name ) { mName = name; mIsValid = true; }

    QVector< QgsSelectiveMaskSource > sources() const;

    void setSources( const QVector< QgsSelectiveMaskSource > &sources );

    void append( const QgsSelectiveMaskSource &source );

    QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const;

    bool readXml( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );

    QgsSelectiveMaskSource &operator[]( int index ) SIP_FACTORY;
#ifdef SIP_RUN
    % MethodCode
    SIP_SSIZE_T idx = sipConvertFromSequenceIndex( a0, sipCpp->size() );
    if ( idx < 0 )
      sipIsErr = 1;
    else
      sipRes = new QgsSelectiveMaskSource( sipCpp->operator[]( idx ) );
    % End
#endif

    int size() const;

    bool isEmpty() const;
 
#ifdef SIP_RUN
    int __len__() const;
    % MethodCode
    sipRes = sipCpp->size();
    % End
#endif
 
#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    if ( !sipCpp->isValid() )
    {
      sipRes = PyUnicode_FromString( "<QgsSelectiveMaskingSourceSet: invalid>" );
    }
    else if ( !sipCpp->name().isEmpty() )
    {
      const QString str = u"<QgsSelectiveMaskingSourceSet: %1 (%2)>"_s.arg(
                            sipCpp->id(),
                            sipCpp->name() );
      sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    }
    else
    {
      const QString str = u"<QgsSelectiveMaskingSourceSet: %1>"_s.arg(
                            sipCpp->id() );
      sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    }
    % End
#endif
 
  private:
    bool mIsValid = false;
    QString mId;
    QString mName;
    QVector< QgsSelectiveMaskSource > mSources;
};
 
Q_DECLARE_METATYPE( QgsSelectiveMaskingSourceSet )
 
#endif //QGSSELECTIVEMASKINGSOURCESET_H