Changeset b59da6 for src/UIElements/Menu/TextMenu

Timestamp:

Dec 4, 2010, 11:33:47 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:

0af7ef

Parents:

5813ac

git-author:

Frederik Heber <heber@…> (11/08/10 09:36:45)

git-committer:

Frederik Heber <heber@…> (12/04/10 23:33:47)

Message:

Refactoring of Menu structure for Qt and Text UI done.

• Menu is now the initialising class for the menu structure.
• MenuInterface contains virtual declarations of all functions that Menu needs to call.
• TextMenu and QtMenu are templated classes which contain both Menu and MenuInterface and implement the virtual functions.
• class TxMenu and its ...MenuItems contain most of the old Menu code for the text-based system. Most of the stuff, such as triggers, are now hidden internally.
• in ..MainWindow() we basically just construct the desired Menu and call init at the correct time.

Location:

src/UIElements/Menu/TextMenu

Files:

• ActionMenuItem.cpp (moved) (moved from src/UIElements/Menu/ActionMenuItem.cpp ) (2 diffs)
• ActionMenuItem.hpp (moved) (moved from src/UIElements/Menu/ActionMenuItem.hpp ) (3 diffs)
• DisplayMenuItem.cpp (moved) (moved from src/UIElements/Menu/DisplayMenuItem.cpp ) (4 diffs)
• DisplayMenuItem.hpp (moved) (moved from src/UIElements/Menu/DisplayMenuItem.hpp ) (3 diffs)
• MenuItem.cpp (moved) (moved from src/UIElements/Menu/MenuItem.cpp ) (5 diffs)
• MenuItem.hpp (moved) (moved from src/UIElements/Menu/MenuItem.hpp ) (3 diffs)
• SeperatorItem.cpp (moved) (moved from src/UIElements/Menu/SeperatorItem.cpp ) (3 diffs)
• SeperatorItem.hpp (moved) (moved from src/UIElements/Menu/SeperatorItem.hpp ) (3 diffs)
• SubMenuItem.cpp (moved) (moved from src/UIElements/Menu/SubMenuItem.cpp ) (1 diff)
• SubMenuItem.hpp (added)
• TextMenu.hpp (added)
• TxMenu.cpp (moved) (moved from src/UIElements/Menu/TextMenu.cpp ) (11 diffs)
• TxMenu.hpp (moved) (moved from src/UIElements/Menu/TextMenu.hpp ) (5 diffs)

src/UIElements/Menu/TextMenu/ActionMenuItem.cpp

@@ -22 +22 @@
 #include <iostream>
 
-#include "Menu/ActionMenuItem.hpp"
-#include "Actions/MethodAction.hpp"
+#include "Menu/TextMenu/ActionMenuItem.hpp"
+#include "Actions/Action.hpp"
+#include "Actions/ActionRegistry.hpp"
 
 using namespace std;
 
-ActionMenuItem::ActionMenuItem(char _trigger, const char* _description,Menu* _menu,Action* _action)
+ActionMenuItem::ActionMenuItem(char _trigger, const std::string &_description,TxMenu* const _menu,const std::string &_ActionName)
 : MenuItem(_trigger,_description,_menu),
-  action(_action)
+  ActionName(_ActionName)
 {
 }
@@ -37 +38 @@
 
 void ActionMenuItem::doTrigger() {
+  Action* action = ActionRegistry::getInstance().getActionByName(ActionName);
   action->call();
 }
 
 bool ActionMenuItem::isActive() {
+  Action* action = ActionRegistry::getInstance().getActionByName(ActionName);
   return action->isActive();
 }

src/UIElements/Menu/TextMenu/ActionMenuItem.hpp

@@ -11 +11 @@
 #include <string>
 
-#include "Menu/MenuItem.hpp"
+#include "Menu/TextMenu/MenuItem.hpp"
 
 class Action;
+class TxMenu;
 
 /**
@@ -21 +22 @@
 {
 public:
-  ActionMenuItem(char,const char*,Menu*,Action*);
+  ActionMenuItem(char,const std::string &,TxMenu* const,const std::string &);
   virtual ~ActionMenuItem();
 
@@ -29 +30 @@
 
 private:
-  Action* action; //!< this action will be called when the trigger matches
+  const std::string ActionName; //!< this action will be called when the trigger matches
 };
 

src/UIElements/Menu/TextMenu/DisplayMenuItem.cpp

@@ -23 +23 @@
 #include <cmath>
 
-#include "Menu/DisplayMenuItem.hpp"
+#include "Menu/TextMenu/DisplayMenuItem.hpp"
 #include "Views/StringView.hpp"
 
 
-DisplayMenuItem::DisplayMenuItem(Menu* _menu, StringView *_view):
+DisplayMenuItem::DisplayMenuItem(TxMenu* const _menu, StringView *_view):
   MenuItem('\0',"",_menu),
   view(_view),
@@ -34 +34 @@
 }
 
-DisplayMenuItem::DisplayMenuItem(Menu* _menu, StringView *_view, string _title, char _spacer, int _length ):
+DisplayMenuItem::DisplayMenuItem(TxMenu* const _menu, StringView *_view, const std::string &_title, char _spacer, int _length ):
   MenuItem('\0',"",_menu),
   view(_view),
@@ -52 +52 @@
 }
 
-const string DisplayMenuItem::formatEntry(){
-  stringstream s;
+const std::string DisplayMenuItem::formatEntry(){
+  std::stringstream s;
   if(title.length()>0) {
     int pre = floor((length-title.length())/2.0);
@@ -69 +69 @@
 
 
-const string DisplayMenuItem::getDescription(){
-  return string("");
+const std::string DisplayMenuItem::getDescription(){
+  return std::string("");
 }

src/UIElements/Menu/TextMenu/DisplayMenuItem.hpp

@@ -9 +9 @@
 #define DISPLAYMENUITEM_HPP_
 
-#include "Menu/MenuItem.hpp"
+#include <string>
+
+#include "Menu/TextMenu/MenuItem.hpp"
 #include "defs.hpp"
 
 class StringView;
+class TxMenu;
 
 /**
@@ -22 +25 @@
 {
 public:
-  DisplayMenuItem(Menu* _menu, StringView *_view);
-  DisplayMenuItem(Menu* _menu, StringView *_view, string _title,
+  DisplayMenuItem(TxMenu* const _menu, StringView *_view);
+  DisplayMenuItem(TxMenu* const _menu, StringView *_view, const std::string &_title,
                   char _spacer=STD_MENU_TITLE_SPACER, int _length=STD_MENU_LENGTH);
   virtual ~DisplayMenuItem();
@@ -30 +33 @@
   virtual bool checkTrigger(char);
 
-  virtual const string formatEntry();
+  virtual const std::string formatEntry();
 
-  virtual const string getDescription();
+  virtual const std::string getDescription();
 
 private:
   StringView *view;
-  string title;
+  std::string title;
   int length;
   char spacer;

src/UIElements/Menu/TextMenu/MenuItem.cpp

@@ -20 +20 @@
 #include "Helpers/MemDebug.hpp"
 
-#include "Menu/MenuItem.hpp"
+#include "Menu/TextMenu/MenuItem.hpp"
+#include "Menu/TextMenu/TxMenu.hpp"
 #include "Menu/Menu.hpp"
 #include <sstream>
-#include <iostream>
 
 /**
@@ -29 +29 @@
  * The MenuItem is then added to the menu passed to it.
  */
-MenuItem::MenuItem(char _trigger, const char* _description,Menu* menu) :
+MenuItem::MenuItem(char _trigger, const std::string &_description,TxMenu* const menu) :
   trigger(_trigger),
+  description(_description),
   added(false)
 {
-  description = new string(_description);
   add_to_menu(menu);
 }
 
 MenuItem::~MenuItem()
-{
-  delete description;
-}
+{}
 
 /**
@@ -59 +57 @@
 }
 
-const string MenuItem::getDescription() {
-  return *description;
+const std::string MenuItem::getDescription() {
+  return description;
 }
 
@@ -67 +65 @@
  * Normal format is: "<trigger> - <description>"
  */
-const string MenuItem::formatEntry(){
-  stringstream s;
+const std::string MenuItem::formatEntry(){
+  std::stringstream s;
   s << getTrigger() << " - " << getDescription();
 
@@ -80 +78 @@
  * TODO: include funtionality to move Items from one menu to another
  */
-void MenuItem::add_to_menu(Menu* menu) {
+void MenuItem::add_to_menu(TxMenu* const menu) {
   if(!wasAdded()) {
     menu->addItem(this);

src/UIElements/Menu/TextMenu/MenuItem.hpp

@@ -11 +11 @@
 #include <string>
 
-using namespace std;
-
-class Menu;
+class TxMenu;
 
 /**
@@ -22 +20 @@
 class MenuItem {
 public:
-  MenuItem(char,const char*,Menu*);
+  MenuItem(char,const std::string &,TxMenu* const);
   virtual ~MenuItem();
 
@@ -28 +26 @@
   virtual bool checkTrigger(char);
 
-  virtual const string formatEntry();
+  virtual const std::string formatEntry();
 
-  virtual const string getDescription();
+  virtual const std::string getDescription();
   char getTrigger();
 
-  void add_to_menu(Menu*);
+  void add_to_menu(TxMenu* const);
   bool wasAdded();
 
   virtual bool isActive();
 
-protected:
-  void setDescription(string);
-
 private:
   char trigger;
-  string *description;
+  const std::string description;
   bool added;
 };

src/UIElements/Menu/TextMenu/SeperatorItem.cpp

@@ -23 +23 @@
 #include <sstream>
 
-#include "Menu/SeperatorItem.hpp"
-#include "Menu/Menu.hpp"
+#include "Menu/TextMenu/SeperatorItem.hpp"
 #include "defs.hpp"
 
 
-SeperatorItem::SeperatorItem(Menu* menu):
+SeperatorItem::SeperatorItem(TxMenu* const menu):
   MenuItem('\0',"",menu),
   spacer(STD_SEPERATOR_SPACER),
@@ -37 +36 @@
 }
 
-SeperatorItem::SeperatorItem(Menu* menu,char _spacer, int _length):
+SeperatorItem::SeperatorItem(TxMenu* const menu,char _spacer, int _length):
   MenuItem('\0',"",menu),
   spacer(_spacer),
@@ -57 +56 @@
 }
 
-const string SeperatorItem::getDescription() {
-  return string("");
+const std::string SeperatorItem::getDescription() {
+  return std::string("");
 }
 
-const string SeperatorItem::formatEntry(){
-  stringstream s;
+const std::string SeperatorItem::formatEntry(){
+  std::stringstream s;
   for(int i=0; i<length;i++)
     s << spacer;

src/UIElements/Menu/TextMenu/SeperatorItem.hpp

@@ -9 +9 @@
 #define SEPERATORITEM_H_
 
-#include "Menu/MenuItem.hpp"
+#include <string>
+
+#include "Menu/TextMenu/MenuItem.hpp"
+
+class TxMenu;
 
 /**
@@ -19 +23 @@
 {
 public:
-  SeperatorItem(Menu*);
-  SeperatorItem(Menu*,char,int);
+  SeperatorItem(TxMenu* const );
+  SeperatorItem(TxMenu* const ,char,int);
   virtual ~SeperatorItem();
 
@@ -26 +30 @@
   virtual bool checkTrigger(char);
 
-  virtual const string getDescription();
+  virtual const std::string getDescription();
 
-  virtual const string formatEntry();
+  virtual const std::string formatEntry();
 private:
   char spacer;

src/UIElements/Menu/TextMenu/SubMenuItem.cpp

@@ -20 +20 @@
 #include "Helpers/MemDebug.hpp"
 
-#include "SubMenuItem.hpp"
+#include <iostream>
 
-SubMenuItem::SubMenuItem(char _trigger,const char* _description,Menu* _parent, Menu* _theMenu) :
+#include "Menu/TextMenu/SubMenuItem.hpp"
+#include "Menu/TextMenu/TxMenu.hpp"
+
+SubMenuItem::SubMenuItem(char _trigger,const std::string &_description,TxMenu* const _parent, TxMenu* const _instance) :
   MenuItem(_trigger,_description,_parent),
-  theMenu(_theMenu)
-{
-}
+  theMenu(_instance)
+{}
 
 SubMenuItem::~SubMenuItem()
-{
-  delete theMenu;
-}
+{}
 
 void SubMenuItem::doTrigger() {

src/UIElements/Menu/TextMenu/TxMenu.cpp

@@ -7 +7 @@
 
 /*
- * TextMenu.cpp
+ * TxMenu.cpp
  *
  *  Created on: Dec 10, 2009
@@ -21 +21 @@
 
 #include <boost/bind.hpp>
+#include <algorithm>
 #include <iostream>
 #include <cmath>
-#include "Menu/TextMenu.hpp"
-#include "Menu/MenuItem.hpp"
+#include "Actions/Action.hpp"
+#include "Actions/ActionTraits.hpp"
+#include "Menu/TextMenu/TxMenu.hpp"
+#include "Menu/TextMenu/MenuItem.hpp"
 #include "Helpers/Assert.hpp"
 
@@ -32 +35 @@
  * The text will later be displayed using the stream passed to the constructor.
  */
-TextMenu::TextMenu(ostream& _outputter, const string _title, char _spacer,int _length) :
+TxMenu::TxMenu(std::ostream& _outputter, const std::string _title, char _spacer,int _length) :
   defaultItem(0),
   outputter(_outputter),
@@ -42 +45 @@
 }
 
-TextMenu::~TextMenu()
+TxMenu::~TxMenu()
 {
-  for(list<MenuItem*>::iterator it=items.begin(); it != items.end(); it++)
+  for(std::list<MenuItem*>::iterator it=items.begin(); it != items.end(); it++)
     delete (*it);
 }
 
-
-void TextMenu::addItem(MenuItem* item) {
+void TxMenu::addItem(MenuItem* item) {
   items.push_back(item);
 }
 
-void TextMenu::removeItem(MenuItem* item) {
+void TxMenu::removeItem(MenuItem* item) {
   items.remove(item);
 }
 
-void TextMenu::doQuit(){
+void TxMenu::doQuit(){
   quit = true;
 }
 
-bool TextMenu::hasQuit(){
+bool TxMenu::hasQuit(){
   return quit;
 }
 
-void TextMenu::showEntry(MenuItem* entry){
+void TxMenu::showEntry(MenuItem* entry){
   if(entry->isActive()==false){
     outputter << "(";
@@ -76 +78 @@
 }
 
-void TextMenu::display() {
+void TxMenu::display() {
   char choice;
   bool somethingChosen = false;
@@ -89 +91 @@
           outputter << spacer;
     outputter << '\n';
-    for_each(items.begin(), items.end(), boost::bind(&TextMenu::showEntry,this,_1));
+    for_each(items.begin(), items.end(), boost::bind(&TxMenu::showEntry,this,_1));
     outputter.flush();
 
-    cin >> choice;
+    std::cin >> choice;
 
-    list<MenuItem*>::iterator iter;
+    std::list<MenuItem*>::iterator iter;
     for(iter = items.begin(); iter!=items.end();iter++){
       if((*iter)->isActive()){
@@ -106 +108 @@
       }
       else{
-        outputter << "Invalid Choice!" <<  endl;
+        outputter << "Invalid Choice!" <<  std::endl;
       }
     }
@@ -112 +114 @@
 }
 
-string TextMenu::getTitle(){
+std::string TxMenu::getTitle(){
   return title;
 }
 
-void TextMenu::addDefault(MenuItem* _defaultItem) {
+std::ostream& TxMenu::getOutputter()
+{
+  return outputter;
+}
+
+
+void TxMenu::addDefault(MenuItem* _defaultItem) {
   defaultItem = _defaultItem;
 }
@@ -122 +130 @@
 /****************************** Contained Actions ****************/
 
-TextMenu::LeaveAction::LeaveAction(TextMenu* _menu, const ActionTraits & LeaveActionTrait) :
-  Action(LeaveActionTrait, false),
+TxMenu::LeaveAction::LeaveAction(TxMenu* const _menu, const ActionTraits & LeaveActionTrait) :
+  Action(LeaveActionTrait, true),
   menu(_menu)
 {}
 
-TextMenu::LeaveAction::~LeaveAction(){}
+TxMenu::LeaveAction::~LeaveAction(){}
 
-bool TextMenu::LeaveAction::canUndo(){
+bool TxMenu::LeaveAction::canUndo(){
   return false;
 }
 
-bool TextMenu::LeaveAction::shouldUndo(){
+bool TxMenu::LeaveAction::shouldUndo(){
   return false;
 }
 
-void TextMenu::LeaveAction::getParametersfromValueStorage()
+void TxMenu::LeaveAction::getParametersfromValueStorage()
 {}
 
-Dialog* TextMenu::LeaveAction::fillDialog(Dialog *dialog){
+Dialog* TxMenu::LeaveAction::fillDialog(Dialog *dialog){
   ASSERT(dialog,"No Dialog given when filling action dialog");
   return dialog;
@@ -146 +154 @@
 
 
-Action::state_ptr TextMenu::LeaveAction::performCall(){
+Action::state_ptr TxMenu::LeaveAction::performCall(){
   menu->doQuit();
   return Action::success;
@@ -152 +160 @@
 
 
-Action::state_ptr TextMenu::LeaveAction::performUndo(Action::state_ptr){
+Action::state_ptr TxMenu::LeaveAction::performUndo(Action::state_ptr){
   ASSERT(0,"Cannot undo leaving a menu");
   return Action::success;
 }
 
-Action::state_ptr TextMenu::LeaveAction::performRedo(Action::state_ptr){
+Action::state_ptr TxMenu::LeaveAction::performRedo(Action::state_ptr){
   ASSERT(0,"Cannot redo leaving a menu");
   return Action::success;

src/UIElements/Menu/TextMenu/TxMenu.hpp

@@ -1 +1 @@
 /*
- * TextMenu.h
+ * TxMenu.h
  *
  *  Created on: Dec 10, 2009
@@ -6 +6 @@
  */
 
-#ifndef TEXTMENU_H_
-#define TEXTMENU_H_
+#ifndef TXMENU_H_
+#define TXMENU_H_
 
 #include <list>
@@ -25 +25 @@
  * All Items are displayed and user is prompted for a key. The item corresponding to that key is then activated.
  */
-class TextMenu : public Menu
+class TxMenu
 {
 public:
   class LeaveAction : public Action {
   public:
-    LeaveAction(TextMenu*, const ActionTraits &_trait);
+    LeaveAction(TxMenu* const, const ActionTraits &_trait);
     virtual ~LeaveAction();
 
@@ -44 +44 @@
     virtual Action::state_ptr performRedo(Action::state_ptr);
 
-    ActionTraits *LeaveActionTrait;
-    TextMenu* menu;
+    TxMenu* const menu;
   };
 
-  TextMenu(ostream& _outputter, const string _title, char _spacer=STD_MENU_TITLE_SPACER,int _length=STD_MENU_LENGTH);
-  virtual ~TextMenu();
+  TxMenu(std::ostream& _outputter, const std::string _title, char _spacer=STD_MENU_TITLE_SPACER,int _length=STD_MENU_LENGTH);
+  virtual ~TxMenu();
 
-  virtual void addItem(MenuItem*);
-  virtual void removeItem(MenuItem*);
-  virtual void display();
-  virtual string getTitle();
+  void addItem(MenuItem*);
+  void removeItem(MenuItem*);
+  void display();
+  std::string getTitle();
+  std::ostream& getOutputter();
+  char getSuitableShortForm(std::set <char> &ShortcutList, const std::string name) const;
 
   /**
    * Call doQuit if you want to return from this menu.
    */
-  virtual void doQuit();
+  void doQuit();
   /**
    * Check whether someone has chosen to quit
    */
-  virtual bool hasQuit();
+  bool hasQuit();
 
-  virtual void addDefault(MenuItem*);
+  void addDefault(MenuItem*);
 
 protected:
-  virtual void showEntry(MenuItem*);
+  void showEntry(MenuItem*);
 
 private:
-  list<MenuItem*> items;
+  std::list<MenuItem*> items;
 
   MenuItem* defaultItem;
 
-  ostream& outputter;
-  string title;
+  std::ostream& outputter;
+  std::string title;
   char spacer;
   int length;
@@ -83 +84 @@
 };
 
-#endif /* TEXTMENU_H_ */
+#endif /* TXMENU_H_ */