Changes in src/UIElements/Dialog.hpp [6f5dfe:4cf323d]

File:

• src/UIElements/Dialog.hpp (modified) (2 diffs)

src/UIElements/Dialog.hpp

@@ -26 +26 @@
 /** Dialog is one of the two main classes of the UIFactory base class.
  *
- * The Dialog is meant for asking the user for information needed to perform actions he
- * desires, such as asking for a position in space or a length.
+ * The Dialog is meant for asking the user for information needed to perform
+ * actions he desires, such as asking for a position in space or a length.
  *
- * For this purpose there is the base class Query and numerous specializations for each
- * of the types to be asked. There are primitives integer, doubles and string, but also
- * advanced types such as element, molecule or Vector. There is also an empty query for
- * displaying text.
+ * For this purpose there is the base class Query and numerous specializations
+ * for each of the types to be asked. There are primitives integer, doubles and
+ * string, but also advanced types such as element, molecule or Vector. There
+ * is also an empty query for displaying text.
  */
 class Dialog
@@ -79 +79 @@
   //due to lack of common code for query types as well as GUI-Types (all subtypes differ a lot)
 
-  //base class for all queries
+  /** Base class for all queries.
+   *
+   *
+   * <h1>How to add another query?</h1>
+   *
+   * Let's say  we want to query for a type called \a Value.
+   *
+   * Then, we do the following:
+   *  -# Add a class ValueQuery inside class Dialog, the class contains
+   *    -# constructor/destructor (latter virtual! because of derived class)
+   *    -# virtual bool handle() and virtual void setResult()
+   *    -# a protected member tmp of type Value (NOTE: herein the result is stored)
+   *    -# if temporaries for conversion are needed put them in here
+   *  -# add a function queryValue
+   *  -# now, for each of the GUIs we basically have to repeat the above, i.e.
+   *     add the class and the function that implement the virtual ones above.
+   *    -# QT: an extra class called ValueQtQueryPipe that actually handles
+   *       showing dialogs to obtain the value and placing it into the \a tmp
+   *       variable (via a given pointer to it as reference). handle() will
+   *       simply return true. This is needed because of a restriction of Qt4:
+   *       its meta-object-compiler does not like nested classes.
+   *    -# CommandLine: nothing special, handle() imports value from \a
+   *       CommandLineParser and sets the tmp variable.
+   *    -# Text: nothing special, handle() queries the user and sets the tmp
+   *       variable
+   */
   class Query {
     friend class Dialog;