Changeset 8f3f40 for src/UIElements/Menu/TextMenu/TextMenu.hpp

Timestamp:

Dec 4, 2010, 11:42:38 PM (15 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:

f0f9a6

Parents:

0af7ef

git-author:

Frederik Heber <heber@…> (11/08/10 10:31:40)

git-committer:

Frederik Heber <heber@…> (12/04/10 23:42:38)

Message:

Added documentation on the new menu structure.

File:

• src/UIElements/Menu/TextMenu/TextMenu.hpp (modified) (10 diffs)

src/UIElements/Menu/TextMenu/TextMenu.hpp ¶

@@ -25 +25 @@
 
 /** TextMenu is a specialization of MenuInterface to access TxMenu-like menus.
+ *
+ * Basically, this class is to be used in the MainWindow class of the TextUI.
+ * There, we simply instantiate the class and call init() in order to add all
+ * MenuItem's from MenuDescriptions and Action's ActionRegistry.
+ *
  * \sa QtMenu.
  */
@@ -31 +36 @@
 {
 public:
+  /** Constructor for class TextMenu.
+   * Initializes outputter and token and takes note whether to delete the
+   * MenuInstance or not.
+   */
   TextMenu(std::ostream &_outputter, const std::string &_token) :
     MenuInterface(_token),
@@ -46 +55 @@
   {}
 
+  /** Destructor of MenuInstance.
+   *
+   */
   virtual ~TextMenu()
   {
@@ -52 +64 @@
   }
 
+  /** Display this MenuInstance.
+   *
+   */
   void display()
   {
@@ -57 +72 @@
   }
 
+  /** Returns a pointer to the contained/wrapped MenuInstance.
+   * \return pointer to template class pointer
+   */
   T * const getMenuInstance()
   {
@@ -62 +80 @@
   }
 
+  /** Reserves a specific trigger key such that it is not used during init().
+   * \param trigger trigger key
+   * \param &name token given for reference.
+   */
   void reserveShortcut(char trigger, const std::string &name)
   {
@@ -78 +100 @@
   MenuShortcutMap ShortcutMap;
 
+  /** Adds an ActionItem by simply creating a new one.
+   * \param &token token of Action (token in ActionRegistry)
+   * \param &description descriptive text to be shown
+   */
   virtual void addActionItem(const std::string &token, const std::string &description)
   {
@@ -83 +109 @@
   }
 
+  /** Adds a (dead) separator item.
+   *
+   */
   virtual void addSeparatorItem()
   {
@@ -88 +117 @@
   }
 
+  /** Adds a Menu to this current Menu.
+   * We also create here a leave action for this submenu to be able to return
+   * to the current one again
+   * \param &token token of the menu
+   * \param &description descriptive text
+   */
   virtual void addSubmenuItem(const std::string &token, const std::string &description)
   {
@@ -102 +137 @@
   }
 
+  /** Return the next available trigger key suitable to this name.
+   * This function is used internally to make sure that each key is unique to
+   * each Action/Menu. The chosen trigger key is also stored in an internal ShortcutMap.
+   * \param &name text shown in menu
+   * \return trigger key
+   */
   char getSuitableShortForm(const std::string &name)
   {