X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_driver.3x.html;h=f7000ae9fddee4c5acf30f92f2b403f6fd8d0c33;hb=81304798ee736c467839c779c9ca5dca48db7bea;hp=86eacc4ded0e1c11069d8da85de49c738a16a431;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;p=ncurses.git diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index 86eacc4d..f7000ae9 100644 --- a/doc/html/man/menu_driver.3x.html +++ b/doc/html/man/menu_driver.3x.html @@ -1,6 +1,7 @@ -
- +-menu_driver(3x) menu_driver(3x) +menu_driver(3x) menu_driver(3x) --
+
menu_driver - command-processing loop of the menu system --
+
#include <menu.h> - int menu_driver(MENU *menu, int c); + int menu_driver(MENU *menu, int c); --
- Once a menu has been posted (displayed), you should funnel - input events to it through menu_driver. This routine has - three major input cases: - o The input is a form navigation request. Navigation - request codes are constants defined in <form.h>, which - are distinct from the key- and character codes - returned by wgetch. +
+ Once a menu has been posted (displayed), you should funnel input events + to it through menu_driver. This routine has three major input cases: - o The input is a printable character. Printable charac- - ters (which must be positive, less than 256) are - checked according to the program's locale settings. + o The input is a form navigation request. Navigation request codes + are constants defined in <form.h>, which are distinct from the key- + and character codes returned by wgetch(3x). - o The input is the KEY_MOUSE special key associated with - an mouse event. + o The input is a printable character. Printable characters (which + must be positive, less than 256) are checked according to the + program's locale settings. + + o The input is the KEY_MOUSE special key associated with an mouse + event. The menu driver requests are as follows: @@ -120,8 +116,7 @@ Clear the menu pattern buffer. REQ_BACK_PATTERN - Delete the previous character from the pattern buf- - fer. + Delete the previous character from the pattern buffer. REQ_NEXT_MATCH Move to the next item matching the pattern match. @@ -129,23 +124,20 @@ REQ_PREV_MATCH Move to the previous item matching the pattern match. - If the second argument is a printable 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 - appended character from the buffer. + If the second argument is a printable 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 appended character from the buffer. - If the second argument is one of the above pre-defined - requests, the corresponding action is performed. + If the second argument is one of the above pre-defined requests, the + corresponding action is performed. --
- If the second argument is the KEY_MOUSE special key, the - associated mouse event is translated into one of the above - pre-defined requests. Currently only clicks in the user - window (e.g., inside the menu display area or the decora- - tion window) are handled. +
+ If the second argument is the KEY_MOUSE special key, the associated + mouse event is translated into one of the above pre-defined requests. + Currently only clicks in the user window (e.g., inside the menu display + area or the decoration window) are handled. If you click above the display region of the menu: @@ -163,53 +155,44 @@ o a REQ_LAST_ITEM is generated for a triple-click. - If you click at an item inside the display area of the - menu: + If you click at an item inside the display area of the menu: o the menu cursor is positioned to that item. - o If you double-click an item a REQ_TOGGLE_ITEM is gen- - erated and 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 is exactly the purpose of this return value to sig- - nal that an application specific command should be - executed. + o If you double-click an item a REQ_TOGGLE_ITEM is generated and + 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 is exactly the purpose of this return value + to signal that an application specific command should be executed. - o If a translation into a request was done, menu_driver - returns the result of this request. + o If a translation into a request was done, menu_driver returns the + result of this request. - If you clicked outside the user window or the mouse event - could not be translated into a menu request an - E_REQUEST_DENIED is returned. + If you clicked outside the user window or the mouse event could not be + translated into a menu request an E_REQUEST_DENIED is returned. --
- If the second argument is neither printable 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 value of - these pre-defined requests. +
+ If the second argument is neither printable 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 value of these pre-defined requests. --
+
menu_driver return one of the following error codes: E_OK The routine succeeded. E_SYSTEM_ERROR - System error occurred (see errno). + System error occurred (see errno(3)). E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. + Routine detected an incorrect or out-of-range argument. E_BAD_STATE - Routine was called from an initialization or termina- - tion function. + Routine was called from an initialization or termination function. E_NOT_POSTED The menu has not been posted. @@ -224,32 +207,28 @@ The menu driver could not process the request. --
- curses(3x), menu(3x), curs_getch(3x). +
+ curses(3x), getch(3x), menu(3x). --
- The header file <menu.h> automatically includes the header - files <curses.h>. +
+ The header file <menu.h> automatically includes the header files + <curses.h>. --
- These routines emulate the System V menu library. They - were not supported on Version 7 or BSD versions. The sup- - port for mouse events is ncurses specific. +
+ These routines emulate the System V menu library. They were not + supported on Version 7 or BSD versions. The support for mouse events + is ncurses specific. --
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. - menu_driver(3x) + menu_driver(3x)