path: root/menu/README
diff options
Diffstat (limited to 'menu/README')
1 files changed, 20 insertions, 5 deletions
diff --git a/menu/README b/menu/README
index 05917f60..dd221426 100644
--- a/menu/README
+++ b/menu/README
@@ -14,14 +14,13 @@ The resulting code runs both under DOS as well as SYSLINUX. A trivial
memory allocation routine is implemented, to reduce the memory footprint
of this utility.
-Features currently supported are:
+Menu Features currently supported are:
* menu items,
* submenus,
* disabled items,
* checkboxes,
* invisible items (useful for dynamic menus), and
* Radio menus
The keys used are:
@@ -29,6 +28,7 @@ The keys used are:
* Space to switch state of a checkbox
* Enter to choose the item
* Escape to exit from it
+* Shortcut keys
@@ -47,14 +47,29 @@ customizable. Some features include:
at a specific location of his choice. This is useful, when the menu's
have lots of options.
* Registering handlers for each menu item
- This is mainly used for checkboxes, where selecting a checkbox, may
- result in disabling another menu item, or de-selecting another
- checkbox.
+ This is mainly used for checkboxes and radiomenu's, where a selection may
+ result in disabling other menu items/checkboxes
* Global Handler
This is called every time the menu is redrawn. The user can display
additional information (usually outside the window where the menu is
being displayed). See the complex.c for an example, where the global
handler is used to display the choices made so far.
+* Shortcut Keys
+ With each item one can register a shortcut key from [A-Za-z0-9].
+ Pressing a key within that range, will take you to the next item
+ with that shortcut key (so you can have multiple items with the
+ same shortcut key). The default shortcut key for each item, is
+ the lower case version of the first char of the item in the range
+ [A-Za-z0-9].
+* Escape Keys
+ Each item entry can have a substring enclosed in < and >. This part
+ is highlighted. Can be used to highlight the shortcut keys. By default
+ if an item has a <, then the first char inside < and > in the range
+ [A-Za-z0-9] is converted to lower case and set as the shortcut key.
+* Ontimeout handler
+ The user can register an ontimeout handler, which gets called if
+ no key has been pressed for a user specific amount of time (default 5 min).
+ For an example see the complex.c file.