Changeset db7cb0

Timestamp:

Oct 23, 2010, 2:32:46 PM (14 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

f001ca

Parents:

6f5dfe

Message:

DOCU: Added howto to add queries.

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;