- menu_driver - command-processing loop of the menu system
+ menu_driver - command-processing loop of the menu system
SYNOPSIS
- #include<menu.h>
+ #include<menu.h>
int menu_driver(MENU *menu, int c);
DESCRIPTION
Once a menu has been posted (displayed), you should funnel
- input events to it through menu_driver. This routine has
+ input events to it through menu_driver. This routine has
three major input cases; either the input is a menu navi-
gation request, it's a printable ASCII character or it is
the KEY_MOUSE special key associated with an mouse event.
@@ -78,7 +120,7 @@
If the second argument is a printable ASCII character, the
code appends it to the pattern buffer and attempts to move
to the next item matching the new pattern. If there is no
- such match, menu_driver returns E_NO_MATCH and deletes the
+ such match, menu_driver returns E_NO_MATCH and deletes the
appended character from the buffer.
If the second argument is one of the above pre-defined
@@ -98,64 +140,63 @@
you click at an item inside the display area of the menu,
the menu cursor is positioned to that item. If you double-
click at an item a REQ_TOGGLE_ITEM is generated and
- E_UNKNOWN_COMMAND is returned. This return value makes
+ E_UNKNOWN_COMMAND is returned. This return value makes
sense, because a double click usually means that an item-
specific action should be returned. It's exactly the pur-
pose of this return value to signal that an application
specific command should be executed. If a translation into
- a request was done, menu_driver returns the result of this
+ a request was done, menu_driver returns the result of this
request. If you clicked outside the user window or the
mouse event couldn't be translated into a menu request an
- E_REQUEST_DENIED is returned.
+ E_REQUEST_DENIED is returned.
If the second argument is neither printable ASCII nor one
of the above pre-defined menu requests or KEY_MOUSE, the
drive assumes it is an application-specific command and
- returns E_UNKNOWN_COMMAND. Application-defined commands
- should be defined relative to MAX_COMMAND, the maximum
+ returns E_UNKNOWN_COMMAND. Application-defined commands
+ should be defined relative to MAX_COMMAND, the maximum
value of these pre-defined requests.
-
RETURN VALUE
- menu_driver return one of the following error codes:
+ menu_driver return one of the following error codes:
- E_OK The routine succeeded.
+ E_OK The routine succeeded.
- E_SYSTEM_ERROR
- System error occurred (see errno).
+ E_SYSTEM_ERROR
+ System error occurred (see errno).
- E_BAD_ARGUMENT
+ E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argu-
ment.
- E_BAD_STATE
+ E_BAD_STATE
Routine was called from an initialization or termina-
tion function.
- E_NOT_POSTED
+ E_NOT_POSTED
The menu has not been posted.
- E_UNKNOWN_COMMAND
+ E_UNKNOWN_COMMAND
The menu driver code saw an unknown request code.
- E_NO_MATCH
+ E_NO_MATCH
Character failed to match.
- E_REQUEST_DENIED
+ E_REQUEST_DENIED
The menu driver could not process the request.
- The header file <menu.h> automatically includes the header
- files <curses.h>.
+ The header file <menu.h> automatically includes the header
+ files <curses.h>.