qgsprojectstoredobjectmanagermodel.h

Go to the documentation of this file.

/***************************************************************************
    qgsprojectstoredobjectmanagermodel.h
    ------------------
    Date                 : January 2017
    Copyright            : (C) 2017 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 QGSPROJECTSTOREDOBJECTMANAGERMODEL_H
#define QGSPROJECTSTOREDOBJECTMANAGERMODEL_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsprojectstoredobjectmanager.h"
 
#include <QAbstractListModel>
#include <QObject>
#include <QSortFilterProxyModel>

class CORE_EXPORT QgsProjectStoredObjectManagerModelBase : public QAbstractListModel
{
    Q_OBJECT
 
  public:
    // *INDENT-OFF*

    enum class CustomRole : int
    {
      Object = Qt::UserRole + 1, 
      IsEmptyObject,             
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    QgsProjectStoredObjectManagerModelBase( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    int rowCount( const QModelIndex &parent ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
 
  protected slots:

#ifndef SIP_RUN
    void objectAboutToBeAdded( const QString &name );
    void objectAboutToBeRemoved( const QString &name );
    void objectAdded( const QString &name );
    void objectRemoved( const QString &name );
#endif
 
  protected:
#ifndef SIP_RUN
    virtual void objectAboutToBeAddedInternal( const QString & ) {}
    virtual void objectAboutToBeRemovedInternal( const QString & ) {}
    virtual void objectAddedInternal( const QString & ) {}
    virtual void objectRemovedInternal( const QString & ) {}
 
    virtual int rowCountInternal( const QModelIndex & ) const { return 0; }
    virtual QVariant dataInternal( const QModelIndex &, int ) const { return QVariant(); }
    virtual bool setDataInternal( const QModelIndex &, const QVariant &, int = Qt::EditRole ) { return false; }
    virtual Qt::ItemFlags flagsInternal( const QModelIndex & ) const { return Qt::ItemFlags(); }
#endif
};

template<class T> class CORE_EXPORT QgsProjectStoredObjectManagerModel : public QgsProjectStoredObjectManagerModelBase
{
  public:
    explicit QgsProjectStoredObjectManagerModel( QgsAbstractProjectStoredObjectManager<T> *manager, QObject *parent SIP_TRANSFERTHIS = nullptr );

    T *objectFromIndex( const QModelIndex &index ) const;

    QModelIndex indexFromObject( T *object ) const;

    void setAllowEmptyObject( bool allowEmpty );

    bool allowEmptyObject() const { return mAllowEmpty; }
 
  protected:
    int rowCountInternal( const QModelIndex &parent ) const override;
    QVariant dataInternal( const QModelIndex &index, int role ) const override;
    bool setDataInternal( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
    Qt::ItemFlags flagsInternal( const QModelIndex &index ) const override;
 
    void objectAboutToBeAddedInternal( const QString &name ) override;
    void objectAboutToBeRemovedInternal( const QString &name ) override;
    void objectAddedInternal( const QString &name ) override;
    void objectRemovedInternal( const QString &name ) override;
    void objectRenamedInternal( T *object, const QString &newName );
    QVariant objectToVariant( T *object ) const;

    QgsAbstractProjectStoredObjectManager<T> *mObjectManager = nullptr;
 
  private:
    bool mAllowEmpty = false;
};
 

class CORE_EXPORT QgsProjectStoredObjectManagerProxyModelBase : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    explicit QgsProjectStoredObjectManagerProxyModelBase( QObject *parent SIP_TRANSFERTHIS = nullptr );
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;

    QString filterString() const { return mFilterString; }
 
  public slots:

    void setFilterString( const QString &filter );
 
  protected:
    virtual bool filterAcceptsRowInternal( int sourceRow, const QModelIndex &sourceParent ) const;

    QString mFilterString;
};
 

template<class T> class CORE_EXPORT QgsProjectStoredObjectManagerProxyModel : public QgsProjectStoredObjectManagerProxyModelBase
{
  public:
    explicit QgsProjectStoredObjectManagerProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
  protected:
    bool filterAcceptsRowInternal( int sourceRow, const QModelIndex &sourceParent ) const override;
};
 
 
#endif // QGSPROJECTSTOREDOBJECTMANAGERMODEL_H