qgsselectivemaskingsourcesetmanager.h

Go to the documentation of this file.

/***************************************************************************
    qgsselectivemaskingsourcesetmanager.h
    ------------------
    Date                 : January 2026
    Copyright            : (C) 2026 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 QGSSELECTIVEMASKINGSOURCESETMANAGER_H
#define QGSSELECTIVEMASKINGSOURCESETMANAGER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsprojectstoredobjectmanager.h"
#include "qgsselectivemaskingsourceset.h"
 
#include <QObject>
 
class QDomElement;
class QDomDocument;
class QgsReadWriteContext;

#ifdef SIP_RUN
class CORE_EXPORT QgsSelectiveMaskingSourceSetManager : public QgsProjectStoredObjectManagerBase // for sip we skip to the base class and avoid the template difficulty
{
#else
class CORE_EXPORT QgsSelectiveMaskingSourceSetManager : public QgsAbstractProjectStoredObjectManager< QgsSelectiveMaskingSourceSet >
{
#endif
    Q_OBJECT
 
  public:
    explicit QgsSelectiveMaskingSourceSetManager( QgsProject *project SIP_TRANSFERTHIS = nullptr );
 
    ~QgsSelectiveMaskingSourceSetManager() override;

    bool addSet( const QgsSelectiveMaskingSourceSet &set );

    bool updateSet( const QgsSelectiveMaskingSourceSet &set );

    bool removeSet( const QString &name );

    void clear();

    bool renameSet( const QString &oldName, const QString &newName );

    QVector< QgsSelectiveMaskingSourceSet > sets() const;

    QgsSelectiveMaskingSourceSet setById( const QString &id ) const;

    QgsSelectiveMaskingSourceSet setByName( const QString &name ) const;

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

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

    QString generateUniqueTitle() const;
 
  signals:

    void changed();

    void setAboutToBeAdded( const QString &name );

    void setAdded( const QString &name );

    void setRemoved( const QString &name );

    void setAboutToBeRemoved( const QString &name );

    void setRenamed( const QString &oldName, const QString &newName );
};
 
 
#endif // QGSSELECTIVEMASKINGSOURCESETMANAGER_H