Changeset da09909 for molecuilder/src/Menu/TextMenu.hpp

Timestamp:

Dec 16, 2009, 2:40:09 PM (16 years ago)

Author:

Tillmann Crueger <crueger@…>

Children:

38546d

Parents:

c2c893

Message:

Improved documentation for menu framework.

File:

• molecuilder/src/Menu/TextMenu.hpp (modified) (2 diffs)

molecuilder/src/Menu/TextMenu.hpp

@@ -14 +14 @@
 
 #include "Menu/Menu.hpp"
+#include "defs.hpp"
 
 class MenuItem;
 
+/**
+ * Used to produce any kind of text menu
+ *
+ * All Items are displayed and user is prompted for a key. The item corresponding to that key is then activated.
+ */
 class TextMenu : public Menu
 {
 public:
-  TextMenu(ostream&,string,char,int);
-  TextMenu(ostream&,string);
+  TextMenu(ostream& _outputter, string _title, char _spacer=STD_MENU_TITLE_SPACER,int _length=STD_MENU_LENGTH);
   virtual ~TextMenu();
 
@@ -28 +33 @@
   virtual void display();
 
+  /**
+   * Call doQuit if you want to return from this menu.
+   */
   virtual void doQuit();
+  /**
+   * Check wether someone has chosen to quit
+   */
   virtual bool hasQuit();