Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

ParamEditor Class Reference
[Visual]

#include <OpenMS/VISUAL/ParamEditor.h>

Inheritance diagram for ParamEditor:

QWidget Ui::ParamEditorTemplate

List of all members.


Detailed Description

A GUI for editing or viewing a Param object.

It supports two display modes:

ParamEditor.png

Public Types

enum  { NODE, NORMAL_ITEM, ADVANCED_ITEM }
 Role of the entry. More...

Signals

void modified (bool)
 item was edited

Public Member Functions

 ParamEditor (QWidget *parent=0)
 constructor
void load (Param &param)
 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 setModified (bool is_modified)
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 > &section_descriptions)
 recursive helper method for method storeRecursive()

Protected Attributes

Internal::ParamTreetree_
 Pointer to the tree widget.
Paramparam_
 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.

Member Enumeration Documentation

anonymous enum

Role of the entry.

Enumerator:
NODE  Section.
NORMAL_ITEM  Item that is always shown.
ADVANCED_ITEM  Item that is shown only in advanced mode.


Constructor & Destructor Documentation

ParamEditor ( QWidget parent = 0  ) 

constructor


Member Function Documentation

void load ( Param param  ) 

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.

void modified ( bool   )  [signal]

item was edited

void setModified ( bool  is_modified  )  [protected, slot]

Notifies the widget that the content was changed. Emits the modified(bool) signal if the state changed.

void toggleAdvancedMode ( bool  advanced  )  [protected, slot]

Switches between normal and advanced mode.

void showDocumentation ( const QModelIndex &  index  )  [protected, slot]

Shows the documentation of an item in doc_.

void storeRecursive_ ( QTreeWidgetItem *  child,
String  path,
std::map< String, String > &  section_descriptions 
) [protected]

recursive helper method for method storeRecursive()


Member Data Documentation

Internal::ParamTree* tree_ [protected]

Pointer to the tree widget.

Param* param_ [protected]

The data to edit.

bool modified_ [protected]

Indicates that the data was modified since last store/load operation.

bool advanced_mode_ [protected]

Indicates if normal mode or advanced mode is activated.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:48 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1