qgsbookmarkmodel.h

Go to the documentation of this file.

/***************************************************************************
    qgsbookmarkmodel.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 QGSBOOKMARKMODEL_H
#define QGSBOOKMARKMODEL_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include <QAbstractTableModel>
#include <QSortFilterProxyModel>

class QgsBookmarkManager;
class QgsBookmark;

class CORE_EXPORT QgsBookmarkManagerModel: public QAbstractTableModel
{
    Q_OBJECT

  public:

    enum CustomRoles
    {
      RoleExtent = Qt::UserRole, 
      RoleName, 
      RoleId, 
      RoleGroup, 
    };

    enum Columns
    {
      ColumnName, 
      ColumnGroup, 
      ColumnXMin, 
      ColumnYMin, 
      ColumnXMax, 
      ColumnYMax, 
      ColumnCrs, 
      ColumnStore, 
    };

    QgsBookmarkManagerModel( QgsBookmarkManager *manager, QgsBookmarkManager *projectManager = nullptr, QObject *parent SIP_TRANSFERTHIS = nullptr );

    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
    bool insertRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
    bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;

  private slots:
    void bookmarkAboutToBeAdded( const QString &id );
    void bookmarkAdded( const QString &id );
    void bookmarkAboutToBeRemoved( const QString &id );
    void bookmarkRemoved( const QString &id );
    void bookmarkChanged( const QString &id );

  private:
    bool mBlocked = false;
    QgsBookmarkManager *mManager = nullptr;
    QgsBookmarkManager *mProjectManager = nullptr;
    QgsBookmark bookmarkForIndex( const QModelIndex &index ) const;

};

class CORE_EXPORT QgsBookmarkManagerProxyModel : public QSortFilterProxyModel
{
  public:

    QgsBookmarkManagerProxyModel( QgsBookmarkManager *manager, QgsBookmarkManager *projectManager = nullptr, QObject *parent SIP_TRANSFERTHIS = nullptr );

  private:

    QgsBookmarkManagerModel *mModel = nullptr;
};

#endif // QGSBOOKMARKMODEL_H