Changeset 5245 in orxonox.OLD for trunk/src/lib/shell/shell_input.h

Timestamp:

Sep 24, 2005, 8:47:02 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: autoCompletion now gives a very nice output

File:

• trunk/src/lib/shell/shell_input.h (modified) (4 diffs)

trunk/src/lib/shell/shell_input.h

@@ -1 +1 @@
 /*!
  * @file shell_input.h
- * @brief Definition of ...
- * @todo AutoCompletion should print nice output
- * @todo move up and down in Buffer
- * @todo display old shell Commands
+ * @brief Shell Input is an InputLine for the Shell.
 */
 
@@ -18 +15 @@
 class ShellCompletion;
 
-
-//! A class for ...
+//! An InputLine for the Shell
+/**
+ * The ShellInput has the ability to catch and display user input.
+ * The ShellInput is auto-completed after the user presses [TAB]
+ * The ShellInput is executed (and sent back to the Application) on Pressing [ENTER]
+ * [UP] and [DOWN] move through the history of allready given commands.
+ */
 class ShellInput : public Text,  public EventListener {
 
@@ -38 +40 @@
   bool executeCommand();
 
+  /** sets the count of the History's entries */
+  void setHistoryLength(unsigned int historyLength) { this->historyLength = historyLength; };
   void historyMoveUp();
   void historyMoveDown();
@@ -50 +54 @@
    ShellCompletion*         completion;             //!< The Completion Interface.
 
-
-   char*                    inputLine;              //!< the Char-Array of the Buffer @todo not needed anymore
+   char*                    inputLine;              //!< the Char-Array of the Buffer
    float                    repeatRate;             //!< The Repeat-Delay.
    float                    repeatDelay;            //!< The delay of the first Character of a given Character.