A GUI for editing or viewing a Param object. More...
#include <OpenMS/VISUAL/ParamEditor.h>
Public Types | |
| enum | { NODE, NORMAL_ITEM, ADVANCED_ITEM } |
Role of the entry. More... | |
Public Slots | |
| void | setModified (bool is_modified) |
Signals | |
| void | modified (bool) |
| item was edited | |
Public Member Functions | |
| ParamEditor (QWidget *parent=0) | |
| constructor | |
| void | load (Param ¶m) |
| load method for Param object | |
| void | store () |
| store edited data in Param object | |
| bool | isModified () const |
| Indicates if the data changed since last save. | |
| void | clear () |
| Clears all parameters. | |
Protected Slots | |
| void | toggleAdvancedMode (bool advanced) |
| Switches between normal and advanced mode. | |
| void | showDocumentation (const QModelIndex &index) |
| Shows the documentation of an item in doc_. | |
Protected Member Functions | |
| void | storeRecursive_ (QTreeWidgetItem *child, String path, std::map< String, String > §ion_descriptions) |
| recursive helper method for method storeRecursive() | |
Protected Attributes | |
| Internal::ParamTree * | tree_ |
| Pointer to the tree widget. | |
| Param * | param_ |
| The data to edit. | |
| bool | modified_ |
| Indicates that the data was modified since last store/load operation. | |
| bool | advanced_mode_ |
| Indicates if normal mode or advanced mode is activated. | |
Detailed Description
A GUI for editing or viewing a Param object.
It supports two display modes:
- normal mode: only the main parameters are displayed, advanced parameters are hidden.
- advanced mode: all parameters are displayed.
Member Enumeration Documentation
| anonymous enum |
Constructor & Destructor Documentation
| ParamEditor | ( | QWidget * | parent = 0 |
) |
constructor
Member Function Documentation
| void clear | ( | ) |
Clears all parameters.
| bool isModified | ( | ) | const |
Indicates if the data changed since last save.
Referenced by INIFileEditorWindow::closeEvent(), INIFileEditorWindow::openFile(), INIFileEditorWindow::saveFile(), and INIFileEditorWindow::saveFileAs().
| void load | ( | Param & | param | ) |
load method for Param object
Referenced by INIFileEditorWindow::openFile().
| void modified | ( | bool | ) | [signal] |
item was edited
| void setModified | ( | bool | is_modified | ) | [slot] |
Notifies the widget that the content was changed. Emits the modified(bool) signal if the state changed.
| void showDocumentation | ( | const QModelIndex & | index | ) | [protected, slot] |
Shows the documentation of an item in doc_.
| void store | ( | ) |
store edited data in Param object
Referenced by INIFileEditorWindow::saveFile(), and INIFileEditorWindow::saveFileAs().
| void storeRecursive_ | ( | QTreeWidgetItem * | child, | |
| String | path, | |||
| std::map< String, String > & | section_descriptions | |||
| ) | [protected] |
recursive helper method for method storeRecursive()
| void toggleAdvancedMode | ( | bool | advanced | ) | [protected, slot] |
Switches between normal and advanced mode.
Member Data Documentation
bool advanced_mode_ [protected] |
Indicates if normal mode or advanced mode is activated.
bool modified_ [protected] |
Indicates that the data was modified since last store/load operation.
Internal::ParamTree* tree_ [protected] |
Pointer to the tree widget.
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:58 using doxygen 1.7.1 |