qgselevationprofilemanager.h

Go to the documentation of this file.

/***************************************************************************
    qgselevationprofilemanager.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 QGSELEVATIONPROFILEMANAGER_H
#define QGSELEVATIONPROFILEMANAGER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsprojectstoredobjectmanager.h"
 
#include <QObject>
 
class QDomElement;
class QDomDocument;
class QgsReadWriteContext;
class QgsElevationProfile;

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

    bool addProfile( QgsElevationProfile *profile SIP_TRANSFER );

    bool removeProfile( QgsElevationProfile *profile );

    void clear();

    QList< QgsElevationProfile * > profiles() const;

    QgsElevationProfile *profileByName( const QString &name ) const;

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

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

    void resolveReferences( const QgsProject *project );

    QString generateUniqueTitle() const;
 
  signals:

    void profileAboutToBeAdded( const QString &name );

    void profileAdded( const QString &name );

    void profileRemoved( const QString &name );

    void profileAboutToBeRemoved( const QString &name );

    void profileRenamed( QgsElevationProfile *profile, const QString &newName );
 
  protected:
    void setupObjectConnections( QgsElevationProfile *profile ) override;
};
 
 
#endif // QGSELEVATIONPROFILEMANAGER_H