Changeset 163110 for src/UIElements/Menu/Menu.hpp

Timestamp:

Sep 9, 2014, 10:27:26 PM (10 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:

86c013

Parents:

152e5c

git-author:

Frederik Heber <heber@…> (09/08/14 21:15:11)

git-committer:

Frederik Heber <heber@…> (09/09/14 22:27:26)

Message:

In QTUI Dialog window now has a meaningful title.

• Dialog cstor now requires a title.
• UIFactory::makeDialog() needs to be provided with this title.
• Menu::populateActions() uses addAction with twice just the token.
• Action::createDialog() provides title from its Traits.

File:

• src/UIElements/Menu/Menu.hpp (modified) (1 diff)

src/UIElements/Menu/Menu.hpp

@@ -61 +61 @@
 
 protected:
-  // Unique name of the menu for identification.
+  //!> Unique name of the menu for identification.
   const std::string name;
 
-  // populater function that adds all menu items
+  /** populater function that adds all menu items.
+   *
+   */
   void populate();
+
+  /** Populater function for all Actions in this menu.
+   *
+   */
   void populateActions();
 
 private:
-  void addAction(const std::string &ActionName);
+  /** Adds an action to this menu.
+   *
+   * @param ActionName name of action
+   * @param ActionDescription of the action (e.g. for tooltips)
+   */
+  void addAction(const std::string &ActionName, const std::string &ActionDescription);
+
+  /** Adds a separator (e.g. horizontal line) to menu.
+   *
+   */
   void addSeparator();
+
+  /** Adds a submenu to this menu.
+   *
+   * @param MenuName name of submenu
+   * @param MenuPosition position in sequence of items of submenu
+   */
   void addSubmenu(const std::string &MenuName, const int MenuPosition);
+
+  /** Checks whether an item named \a token exists in this menu.
+   *
+   * @param token name of action of submenu
+   * @return true - item exists, false - item does not exist in this menu
+   */
   bool isPresent(const std::string &token);
 
+  //!> enumeration of all valid item types
   enum ItemType {ActionItem, MenuItem, SeparatorItem, NoItem};
 
-  int TopPosition;  // current position to add
-  enum ItemType LastItem;  // check whether separator followed separator
-  std::set <std::string> DuplicatesList;  // is used to check for duplicates
+  //!> current position to add
+  int TopPosition;
+  //!> check whether separator followed separator
+  enum ItemType LastItem;
+  //!> is used to check for duplicates
+  std::set <std::string> DuplicatesList;
 };