ParamEditor.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm, Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
// OpenMS_GUI config
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
 
#include <OpenMS/CONCEPT/Types.h>
 
#include <QtWidgets/QLineEdit>
#include <QtWidgets/QItemDelegate>
#include <QtWidgets/QTreeWidget>
 
class QModelIndex;
class QStyleOptionViewItem;
class QAbstractItemModel;
class QStringList;
class QString;
 
namespace Ui
{
  class ParamEditorTemplate;
}
 
namespace OpenMS
{
  class String;
  class Param;
  class ParamEditor;
  namespace Internal
  {
 
    class OPENMS_GUI_DLLAPI OpenMSLineEdit
      : public QLineEdit
    {
      Q_OBJECT
  public:
      OpenMSLineEdit(QWidget * w)
        :QLineEdit(w)
      {}
 
signals:
      void lostFocus();
 
 
    protected:
        void   focusOutEvent ( QFocusEvent * e ) override;
        void   focusInEvent ( QFocusEvent * e ) override;
    };
    class OPENMS_GUI_DLLAPI ParamEditorDelegate :
      public QItemDelegate
    {
      Q_OBJECT
 
public:
      ParamEditorDelegate(QObject * parent);
      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;
      void updateEditorGeometry(QWidget * editor, const QStyleOptionViewItem & option, const QModelIndex & index) const override;
 
      bool hasUncommittedData() const;
signals:
      void modified(bool) const;
 
protected:
      bool eventFilter(QObject* editor, QEvent* event) override;
  
      bool exists_(const QString& name, QModelIndex index) const;
 
private slots:
      void commitAndCloseEditor_();
      void closeEditor_();
      void commitAndCloseLineEdit_();
 
private:
      ParamEditorDelegate();
      mutable QString fileName_;
      mutable bool has_uncommited_data_;
    };
 
    class OPENMS_GUI_DLLAPI ParamTree :
      public QTreeWidget
    {
      Q_OBJECT
 
public:
      ParamTree(QWidget * parent);
      bool edit(const QModelIndex & index, EditTrigger trigger, QEvent * event) override;
 
signals:
      void selected(const QModelIndex & index);
 
protected slots:
      void selectionChanged(const QItemSelection & selected, const QItemSelection &) override;
    };
 
  }
 
  
  class OPENMS_GUI_DLLAPI ParamEditor :
    public QWidget
  {
    Q_OBJECT
 
public:
    enum
    {
      NODE,                     
      NORMAL_ITEM,              
      ADVANCED_ITEM             
    };
 
    ParamEditor(QWidget* parent = nullptr);
    ~ParamEditor() override;
    
    void load(Param& param);
    void store();
    bool isModified() const;
    void clear();
 
public slots:
    void setModified(bool is_modified);
 
signals:
    void modified(bool);
 
protected slots:
    void toggleAdvancedMode(bool advanced);
    void showDocumentation(const QModelIndex & index);
 
protected:
    void storeRecursive_(QTreeWidgetItem * child, String path, std::map<String, String> & section_descriptions);
 
    Internal::ParamTree* tree_;
    Param* param_;
    bool modified_;
    bool advanced_mode_;
 
private:
    Ui::ParamEditorTemplate* ui_;
  };
 
 
} // namespace OpenMS