qgsbookmarkmanager.h

Go to the documentation of this file.

/***************************************************************************
    qgsbookmarkmanager.h
    ------------------
    Date                 : Septemeber 2019
    Copyright            : (C) 2019 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 QGSBOOKMARKMANAGER_H
#define QGSBOOKMARKMANAGER_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsreferencedgeometry.h"
#include <QObject>

class QgsProject;

class CORE_EXPORT QgsBookmark
{

  public:

    QgsBookmark() = default;

    QString id() const;

    void setId( const QString &id );

    QString name() const;

    void setName( const QString &name );

    QString group() const;

    void setGroup( const QString &group );

    QgsReferencedRectangle extent() const;

    void setExtent( const QgsReferencedRectangle &extent );

    static QgsBookmark fromXml( const QDomElement &element, const QDomDocument &doc );

    QDomElement writeXml( QDomDocument &doc ) const;

#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = QStringLiteral( "<QgsBookmark: '%1' (%2 - %3)>" ).arg( sipCpp->name(), sipCpp->extent().asWktCoordinates(), sipCpp->extent().crs().authid() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif

    bool operator==( const QgsBookmark &other );
    bool operator!=( const QgsBookmark &other );

  private:

    QString mId;
    QString mName;
    QString mGroup;
    QgsReferencedRectangle mExtent;

};

class CORE_EXPORT QgsBookmarkManager : public QObject
{
    Q_OBJECT

  public:

    static QgsBookmarkManager *createProjectBasedManager( QgsProject *project );

    explicit QgsBookmarkManager( QObject *parent SIP_TRANSFERTHIS = nullptr );

    ~QgsBookmarkManager() override;

    void initialize( const QString &filePath );

    QString addBookmark( const QgsBookmark &bookmark, bool *ok SIP_OUT = nullptr );

    bool removeBookmark( const QString &id );

    bool updateBookmark( const QgsBookmark &bookmark );

    void clear();

    QStringList groups() const;

    void renameGroup( const QString &oldName, const QString &newName );

    QList< QgsBookmark > bookmarks() const;

    QgsBookmark bookmarkById( const QString &id ) const;

    QList< QgsBookmark > bookmarksByGroup( const QString &group );

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

    QDomElement writeXml( QDomDocument &doc ) const;

    bool moveBookmark( const QString &id, QgsBookmarkManager *destination );

    static bool exportToFile( const QString &path, const QList<const QgsBookmarkManager *> &managers, const QString &group = QString() );


    bool importFromFile( const QString &path );

  signals:

    void bookmarkAboutToBeAdded( const QString &id );

    void bookmarkAdded( const QString &id );

    void bookmarkRemoved( const QString &id );

    void bookmarkAboutToBeRemoved( const QString &id );

    void bookmarkChanged( const QString &id );

  private:

    QgsProject *mProject = nullptr;
    QString mFilePath;
    QList< QgsBookmark > mBookmarks;
    QStringList mGroups;

    void store();
    bool mInitialized = false;

};

#endif // QGSBOOKMARKMANAGER_H