OpenMS
ParamEditor.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: Marc Sturm, Chris Bielow $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
11 // OpenMS_GUI config
12 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
13 
14 #include <OpenMS/CONCEPT/Types.h>
15 
16 #include <QtWidgets/QLineEdit>
17 #include <QtWidgets/QItemDelegate>
18 #include <QtWidgets/QTreeWidget>
19 
20 class QModelIndex;
21 class QStyleOptionViewItem;
22 class QAbstractItemModel;
23 class QStringList;
24 class QString;
25 
26 namespace Ui
27 {
28  class ParamEditorTemplate;
29 }
30 
31 namespace OpenMS
32 {
33  class String;
34  class Param;
35  class ParamEditor;
40  namespace Internal
41  {
42 
47  class OPENMS_GUI_DLLAPI OpenMSLineEdit
48  : public QLineEdit
49  {
50  Q_OBJECT
51  public:
53  :QLineEdit(w)
54  {}
55 
56 signals:
58  void lostFocus();
59 
60 
61  protected:
62  void focusOutEvent ( QFocusEvent * e ) override;
63  void focusInEvent ( QFocusEvent * e ) override;
64  };
70  class OPENMS_GUI_DLLAPI ParamEditorDelegate :
71  public QItemDelegate
72  {
73  Q_OBJECT
74 
75 public:
79  QWidget * createEditor(QWidget * parent, const QStyleOptionViewItem & option, const QModelIndex & index) const override;
81  void setEditorData(QWidget * editor, const QModelIndex & index) const override;
83  void setModelData(QWidget * editor, QAbstractItemModel * model, const QModelIndex & index) const override;
85  void updateEditorGeometry(QWidget * editor, const QStyleOptionViewItem & option, const QModelIndex & index) const override;
86 
88  bool hasUncommittedData() const;
89 signals:
91  void modified(bool) const;
92 
93 protected:
95  bool eventFilter(QObject* editor, QEvent* event) override;
96 
98  bool exists_(const QString& name, QModelIndex index) const;
99 
100 private slots:
104  void closeEditor_();
107 
108 private:
112  mutable QString fileName_;
114  mutable bool has_uncommited_data_;
115  };
116 
118  class OPENMS_GUI_DLLAPI ParamTree :
119  public QTreeWidget
120  {
121  Q_OBJECT
122 
123 public:
125  ParamTree(QWidget * parent);
127  bool edit(const QModelIndex & index, EditTrigger trigger, QEvent * event) override;
128 
129 signals:
131  void selected(const QModelIndex & index);
132 
133 protected slots:
135  void selectionChanged(const QItemSelection & selected, const QItemSelection &) override;
136  };
137 
138  }
139 
140 
152  class OPENMS_GUI_DLLAPI ParamEditor :
153  public QWidget
154  {
155  Q_OBJECT
156 
157 public:
159  enum
160  {
163  ADVANCED_ITEM
164  };
165 
167  ParamEditor(QWidget* parent = nullptr);
169  ~ParamEditor() override;
170 
172  void load(Param& param);
174  void store();
176  bool isModified() const;
178  void clear();
179 
180 public slots:
183  void setModified(bool is_modified);
184 
185 signals:
187  void modified(bool);
188 
189 protected slots:
191  void toggleAdvancedMode(bool advanced);
193  void showDocumentation(const QModelIndex & index);
194 
195 protected:
197  void storeRecursive_(QTreeWidgetItem * child, String path, std::map<String, String> & section_descriptions);
198 
204  bool modified_;
207 
208 private:
209  Ui::ParamEditorTemplate* ui_;
210  };
211 
212 
213 } // namespace OpenMS
214 
Custom QLineEdit which emits a signal when losing focus (such that we can commit its data)
Definition: ParamEditor.h:49
void focusInEvent(QFocusEvent *e) override
void lostFocus()
emitted on focusOutEvent
void focusOutEvent(QFocusEvent *e) override
OpenMSLineEdit(QWidget *w)
Definition: ParamEditor.h:52
Internal delegate class for QTreeWidget.
Definition: ParamEditor.h:72
ParamEditorDelegate(QObject *parent)
Constructor.
void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const override
Updates the editor for the item specified by index according to the style option given.
void closeEditor_()
if cancel in any editor is clicked, the Dialog is closed and changes are rejected
void setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const override
Sets the data for the specified model and item index from that supplied by the editor....
QWidget * createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override
Returns the widget(combobox or QLineEdit) used to edit the item specified by index for editing....
bool hasUncommittedData() const
true if the underlying tree has an open QLineEdit which has uncommitted data
bool has_uncommited_data_
true if a QLineEdit is still open and has not committed its data yet (so storing the current param is...
Definition: ParamEditor.h:114
bool exists_(const QString &name, QModelIndex index) const
Checks if a name is valid for the entry corresponding to index (checks if it would be duplicate)
void commitAndCloseEditor_()
For closing any editor and updating ParamEditor.
QString fileName_
used to modify value of output and input files( not for output and input lists)
Definition: ParamEditor.h:112
void commitAndCloseLineEdit_()
... a bit special, because reset uncommited data
void modified(bool) const
signal for showing ParamEditor if the Model data changed
bool eventFilter(QObject *editor, QEvent *event) override
a shortcut to calling commit(), which calls setModelData(); useful for embedded editors,...
void setEditorData(QWidget *editor, const QModelIndex &index) const override
Sets the data to be displayed and edited by the editor for the item specified by index.
QTreeWidget that emits a signal whenever a new row is selected.
Definition: ParamEditor.h:120
void selected(const QModelIndex &index)
Signal that is emitted when a new item is selected.
ParamTree(QWidget *parent)
Constructor.
bool edit(const QModelIndex &index, EditTrigger trigger, QEvent *event) override
Overloaded edit method to activate F2 use.
void selectionChanged(const QItemSelection &selected, const QItemSelection &) override
Reimplemented virtual slot.
A GUI for editing or viewing a Param object.
Definition: ParamEditor.h:154
Internal::ParamTree * tree_
Pointer to the tree widget.
Definition: ParamEditor.h:200
bool advanced_mode_
Indicates if normal mode or advanced mode is activated.
Definition: ParamEditor.h:206
void storeRecursive_(QTreeWidgetItem *child, String path, std::map< String, String > &section_descriptions)
recursive helper method for method storeRecursive()
void showDocumentation(const QModelIndex &index)
Shows the documentation of an item in doc_.
void load(Param &param)
load method for Param object
bool isModified() const
Indicates if the data changed since last save.
bool modified_
Indicates that the data was modified since last store/load operation.
Definition: ParamEditor.h:204
Ui::ParamEditorTemplate * ui_
Definition: ParamEditor.h:209
@ NODE
Section.
Definition: ParamEditor.h:161
@ NORMAL_ITEM
Item that is always shown.
Definition: ParamEditor.h:162
void setModified(bool is_modified)
void toggleAdvancedMode(bool advanced)
Switches between normal and advanced mode.
void modified(bool)
item was edited
Param * param_
The data to edit.
Definition: ParamEditor.h:202
ParamEditor(QWidget *parent=nullptr)
constructor
void clear()
Clears all parameters.
~ParamEditor() override
destructor
void store()
store edited data in Param object
Management and storage of parameters / INI files.
Definition: Param.h:44
A more convenient string class.
Definition: String.h:34
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
Definition: FLASHDeconvWizardBase.h:37