qgsvariableeditorwidget.h

Go to the documentation of this file.

/***************************************************************************
     qgsvariableeditorwidget.h
     -------------------------
    Date                 : April 2015
    Copyright            : (C) 2015 by 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 QGSVARIABLEEDITORWIDGET_H
#define QGSVARIABLEEDITORWIDGET_H
 
#include "qgis_sip.h"
#include <QWidget>
#include <QTreeWidget>
#include <QItemDelegate>
#include "qgis_gui.h"
#include <memory>
 
class QTableWidget;
class QgsExpressionContextScope;
class QPushButton;
class QgsExpressionContext;
class QgsVariableEditorTree;
class VariableEditorDelegate;
 
class GUI_EXPORT QgsVariableEditorWidget : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY( QString settingGroup READ settingGroup WRITE setSettingGroup )
 
  public:
    QgsVariableEditorWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsVariableEditorWidget() override;
 
    void setContext( QgsExpressionContext *context );
 
    QgsExpressionContext *context() const { return mContext.get(); }
 
    void setEditableScopeIndex( int scopeIndex );
 
    QgsExpressionContextScope *editableScope() const;
 
    void setSettingGroup( const QString &group ) { mSettingGroup = group; }
 
    QString settingGroup() const { return mSettingGroup; }
 
    QVariantMap variablesInActiveScope() const;
 
  public slots:
 
    void reloadContext();
 
  signals:
 
    void scopeChanged();
 
  protected:
    void showEvent( QShowEvent *event ) override;
 
  private:
    std::unique_ptr<QgsExpressionContext> mContext;
    int mEditableScopeIndex = -1;
    QgsVariableEditorTree *mTreeWidget = nullptr;
    QPushButton *mAddButton = nullptr;
    QPushButton *mRemoveButton = nullptr;
    QString mSettingGroup;
    bool mShown = false;
 
    QString saveKey() const;
 
  private slots:
 
    void mAddButton_clicked();
    void mRemoveButton_clicked();
    void selectionChanged();
};
 
 
#ifndef SIP_RUN
 
 
/* QgsVariableEditorTree is NOT part of the public QGIS api. It's only
 * public here as Qt meta objects can't be nested classes
 */
 
class QgsVariableEditorTree : public QTreeWidget
{
    Q_OBJECT
 
  public:
    enum VariableRoles
    {
      ContextIndex = Qt::UserRole,
      RowBaseColor
    };
 
    explicit QgsVariableEditorTree( QWidget *parent = nullptr );
 
    QTreeWidgetItem *indexToItem( const QModelIndex &index ) const { return itemFromIndex( index ); }
    QModelIndex itemToIndex( QTreeWidgetItem *item ) const { return indexFromItem( item ); }
    QString variableNameFromItem( QTreeWidgetItem *item ) const { return item ? item->text( 0 ) : QString(); }
    QString variableNameFromIndex( const QModelIndex &index ) const { return variableNameFromItem( itemFromIndex( index ) ); }
    QgsExpressionContextScope *scopeFromItem( QTreeWidgetItem *item ) const;
    QTreeWidgetItem *itemFromVariable( QgsExpressionContextScope *scope, const QString &name ) const;
    void setEditableScopeIndex( int scopeIndex ) { mEditableScopeIndex = scopeIndex; }
    QgsExpressionContextScope *editableScope();
    void setContext( QgsExpressionContext *context ) { mContext = context; }
    void refreshTree();
    void removeItem( QTreeWidgetItem *item );
    void renameItem( QTreeWidgetItem *item, const QString &name );
    void resetTree();
    void emitChanged();
 
  signals:
 
    void scopeChanged();
 
  protected:
    void keyPressEvent( QKeyEvent *event ) override;
    void mousePressEvent( QMouseEvent *event ) override;
    void drawRow( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    QColor rowColor( int index ) const;
    void toggleContextExpanded( QTreeWidgetItem *item );
    void editNext( const QModelIndex &index );
 
    QModelIndex moveCursor( CursorAction cursorAction, Qt::KeyboardModifiers modifiers ) override;
 
    QIcon mExpandIcon;
 
  private:
    VariableEditorDelegate *mEditorDelegate = nullptr;
    int mEditableScopeIndex = -1;
    QgsExpressionContext *mContext = nullptr;
    QMap<QPair<int, QString>, QTreeWidgetItem *> mVariableToItem;
    QMap<int, QTreeWidgetItem *> mScopeToItem;
 
    void refreshScopeItems( QgsExpressionContextScope *scope, int scopeIndex );
    void refreshScopeVariables( QgsExpressionContextScope *scope, int scopeIndex );
};
 
 
class VariableEditorDelegate : public QItemDelegate
{
    Q_OBJECT
 
  public:
    VariableEditorDelegate( QObject *parent = nullptr, QgsVariableEditorTree *tree = nullptr )
      : QItemDelegate( parent )
      , mParentTree( tree )
    {}
 
    QWidget *createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    void updateEditorGeometry( QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    QSize sizeHint( const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    void setModelData( QWidget *widget, QAbstractItemModel *model, const QModelIndex &index ) const override;
    void setEditorData( QWidget *, const QModelIndex & ) const override {}
 
  private:
    QgsVariableEditorTree *mParentTree = nullptr;
};
 
 
#endif
 
#endif //QGSVARIABLEEDITORWIDGET_H