qgsprojectstoredobjectmanager.h

Go to the documentation of this file.

/***************************************************************************
    qgsprojectstoredobjectmanager.h
    ------------------
    Date                 : July 2025
    Copyright            : (C) 2025 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 QGSPROJECTSTOREDOBJECTMANAGER_H
#define QGSPROJECTSTOREDOBJECTMANAGER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
 
class QgsProject;

class CORE_EXPORT QgsProjectStoredObjectManagerBase : public QObject
{
    Q_OBJECT
 
  public:
    explicit QgsProjectStoredObjectManagerBase( QgsProject *project SIP_TRANSFERTHIS = nullptr );
 
  signals:

    void objectAboutToBeAdded( const QString &name );

    void objectAdded( const QString &name );

    void objectRemoved( const QString &name );

    void objectAboutToBeRemoved( const QString &name );
 
  protected:
    QgsProject *mProject = nullptr;

    void markProjectDirty();
};

template<class T> class CORE_EXPORT QgsAbstractProjectStoredObjectManager : public QgsProjectStoredObjectManagerBase
{
  public:
    explicit QgsAbstractProjectStoredObjectManager( QgsProject *project SIP_TRANSFERTHIS = nullptr );
 
    ~QgsAbstractProjectStoredObjectManager() override;

    QList< T * > objects() const;

    T *objectByName( const QString &name ) const;
 
  protected:
    QList< T * > mObjects;

    void clearObjects();

    bool addObject( T *object SIP_TRANSFER );

    bool removeObject( T *object );

    virtual void setupObjectConnections( T *object );
};
 
 
#endif // QGSPROJECTSTOREDOBJECTMANAGER_H