Diff: src/Menu.cpp

Revision:

2:825f572902c6

Parent:

1:b3907b8d9f65

--- a/src/Menu.cpp	Mon Jun 25 21:01:02 2012 +0000
+++ b/src/Menu.cpp	Mon Jun 25 21:20:22 2012 +0000
@@ -2,6 +2,9 @@
 #include "mbed.h"
 #include <string>
 
+//Drive the menu system
+
+//Initialise and attach button handlers
 Menu::Menu(TextLCD* _screen, PinName ok, PinName left, PinName right)
 {
     screen = _screen;
@@ -38,12 +41,14 @@
 
 void Menu::refresh()
 {
+    //Create chars (if needed) for left and right arrows and editable indicator
     char labelLeft = (!edit & position > 0)?leftArrow:' ';
     char labelRight = (!edit & position < entryCount)?rightArrow:' ';
     char editIndic = (entries[position]->editable)?'*':' ';
 
     screen->locate(0, 0);
     
+    //If position is on an entry, display it
     if(position <= entryCount - 1)
     {
         screen->printf("%c%-14s%c", labelLeft, (entries[position])->label.c_str(), labelRight);
@@ -56,28 +61,36 @@
         screen->locate(15, 1);
         screen->putc(editRight);
     }
+    //Otherwise show the return command
     else
-    {
+    {    
         screen->printf("%cReturn                         ", leftArrow);
     }
 }
 
+//Handler for enter button
 void Menu::enter()
 {
+    //Menu not on screen, display it
     if(!display && !ignoreNextEnter)
     {   
         display = true;
         edit = false;
     }
+    //Menu on screen
     else
     {
+        //On an entry
         if(position <= entryCount - 1)
         {
+            //If its editable, toggle edit status
             if(entries[position]->editable)
                 edit = !edit;
         }
+        //On return
         else
         {
+            //Return, resetting position first
             position = 0;
             done();
         }
@@ -86,31 +99,40 @@
     ignoreNextEnter = false;
 }
 
+//Handler for enter held, clear the menu retaining position
 void Menu::done()
 {
+    //Hide the menu
     display = false;
+    //TODO: Can't remember why I needed this
     ignoreNextEnter = true;
 }
 
+//Handler for left button
 void Menu::left()
 {
+    //If not editing, scroll
     if(!edit && display && position > 0)
         position--;
+    //If editing, edit
     else if(edit)
         entries[position]->decrement();
 }
 
+//Handler for left button held, start scrolling through menu.
 void Menu::leftHeld()
 {
     left();
     leftHeldTimeout.attach(this, &Menu::leftHeld, holdRepeatTime);
 }
 
+//Handler for left button release, stop scrolling
 void Menu::cancelLeftHeld()
 {
     leftHeldTimeout.detach();
 }
 
+//Same as left
 void Menu::right()
 {
     if(!edit && display && position < entryCount)
@@ -119,12 +141,14 @@
         entries[position]->increment();
 }
 
+//Same as left
 void Menu::rightHeld()
 {
     right();
     rightHeldTimeout.attach(this, &Menu::rightHeld, holdRepeatTime);
 }
 
+//Same as left
 void Menu::cancelRightHeld()
 {
     rightHeldTimeout.detach();