qgssettingstreemodel.h

Go to the documentation of this file.

/***************************************************************************
  qgssettingstreemodel.h
  --------------------------------------
  Date                 : January 2023
  Copyright            : (C) 2023 by Denis Rouzaud
  Email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSSETTINGSTREEMODEL_H
#define QGSSETTINGSTREEMODEL_H
 
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QAbstractItemModel>
#include <QItemDelegate>
#include <QSortFilterProxyModel>
 
class QgsSettingsEntryBase;
class QgsSettingsTreeNode;
class QgsSettingsTreeModel;
class QgsSettingsTreeNamedListNode;
 
#ifndef SIP_RUN


class GUI_EXPORT QgsSettingsTreeModelNodeData : public QObject
{
    Q_OBJECT
  public:
    enum class Type
    {
      RootNode,
      TreeNode,
      NamedListTreeNode,
      NamedListItem,
      Setting
    };

    static QgsSettingsTreeModelNodeData *createRootNodeData( const QgsSettingsTreeNode *rootNode, QObject *parent );

    void applyChanges();

    bool isRoot() const { return !mParent; }

    QStringList namedParentNodes() const { return mNamedParentNodes; }

    QList<QgsSettingsTreeModelNodeData *> children() const { return mChildren; }

    QgsSettingsTreeModelNodeData *parent() const { return mParent; }

    Type type() const { return mType; }

    QString name() const { return mName; }

    QVariant value() const { return mValue; }

    QVariant originalValue() const { return mOriginalValue; }

    bool setValue( const QVariant &value );

    bool exists() const { return mExists; }

    bool isEdited() const { return mIsEdited; }

    const QgsSettingsEntryBase *setting() const { return mSetting; }
 
  private:
    QgsSettingsTreeModelNodeData( QObject *parent )
      : QObject( parent )
    {}
    void addChildForTreeNode( const QgsSettingsTreeNode *node );
    void addChildForNamedListItemNode( const QString &item, const QgsSettingsTreeNamedListNode *namedListNode );
    void addChildForSetting( const QgsSettingsEntryBase *setting );
    void fillChildren();
 
    Type mType = Type::TreeNode;
    QString mName;
    QVariant mValue;
    QVariant mOriginalValue;
    QStringList mNamedParentNodes;
    bool mExists = false;
    bool mIsEdited = false;
 
    QList<QgsSettingsTreeModelNodeData *> mChildren;
    QgsSettingsTreeModelNodeData *mParent = nullptr;
 
    const QgsSettingsTreeNode *mTreeNode = nullptr;
    const QgsSettingsEntryBase *mSetting = nullptr;
};
 

class GUI_EXPORT QgsSettingsTreeItemDelegate : public QItemDelegate
{
    Q_OBJECT
 
  public:
    explicit QgsSettingsTreeItemDelegate( QgsSettingsTreeModel *model, QObject *parent = nullptr );
 
    QWidget *createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    void setEditorData( QWidget *editor, const QModelIndex &index ) const override;
    void setModelData( QWidget *editor, QAbstractItemModel *model, const QModelIndex &index ) const override;
 
  private:
    QgsSettingsTreeModel *mModel = nullptr;
};

 
#endif
 

class GUI_EXPORT QgsSettingsTreeModel : public QAbstractItemModel
{
    Q_OBJECT
  public:
    enum class Column
    {
      Name,        
      Value,       
      Description, 
    };

    QgsSettingsTreeModel( QgsSettingsTreeNode *rootNode = nullptr, QObject *parent = nullptr );
 
    ~QgsSettingsTreeModel() override;

    void applyChanges();

    QgsSettingsTreeModelNodeData *index2node( const QModelIndex &index ) const SIP_SKIP;

    QModelIndex node2index( QgsSettingsTreeModelNodeData *node ) const SIP_SKIP;
 
 
    QModelIndex index( int row, int column, const QModelIndex &parent ) const override;
    QModelIndex parent( const QModelIndex &child ) const override;
    int rowCount( const QModelIndex &parent ) const override;
    int columnCount( const QModelIndex &parent ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    QVariant headerData( int section, Qt::Orientation orientation, int role ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
 
  private:
    QModelIndex indexOfParentSettingsTreeNode( QgsSettingsTreeModelNodeData *parentNode ) const;
 
    QgsSettingsTreeModelNodeData *mRootNode = nullptr;
 
    QColor mEditedColorBack;
    QColor mEditedColorFore;
    QColor mNotSetColor;
};

class GUI_EXPORT QgsSettingsTreeProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
  public:
    QgsSettingsTreeProxyModel( QgsSettingsTreeNode *rootNode = nullptr, QObject *parent = nullptr );

    void applyChanges() { mSourceModel->applyChanges(); }
 
  public slots:
    void setFilterText( const QString &filterText = QString() );
 
 
  protected:
    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;
 
  private:
    QgsSettingsTreeModel *mSourceModel = nullptr;
 
    bool nodeShown( QgsSettingsTreeModelNodeData *node ) const;
    QString mFilterText;
};
 
#endif // QGSSETTINGSTREEMODEL_H