X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_driver.3x.html;h=7de5eba3e8f857de9259e5395cb22b2dc3435d24;hp=6182405990d9f0454566f6b608f1f204ee0d3ec7;hb=a0b91dc27f0c411e343161b0a4b5459d15a43f85;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index 61824059..7de5eba3 100644 --- a/doc/html/man/menu_driver.3x.html +++ b/doc/html/man/menu_driver.3x.html @@ -1,7 +1,6 @@ - +
+ +- menu_driver(3x) menu_driver(3x)-
+NAME
menu_driver - command-processing loop of the menu system-SYNOPSIS
+SYNOPSIS
#include <menu.h> int menu_driver(MENU *menu, int c);-DESCRIPTION
+DESCRIPTION
Once a menu has been posted (displayed), you should funnel 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. + 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. + + 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 the KEY_MOUSE special key associated with + an mouse event. + The menu driver requests are as follows: REQ_LEFT_ITEM @@ -108,8 +119,8 @@ Clear the menu pattern buffer. REQ_BACK_PATTERN - Delete the previous character from the pattern - buffer. + Delete the previous character from the pattern buf- + fer. REQ_NEXT_MATCH Move to the next item matching the pattern match. @@ -117,49 +128,73 @@ REQ_PREV_MATCH Move to the previous item matching the pattern match. - 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 + 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. + ++MOUSE HANDLING
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 you click above the display - region of the menu, a REQ_SCR_ULINE is generated, if you - doubleclick a REQ_SCR_UPAGE is generated and if you - tripleclick a REQ_FIRST_ITEM is generated. If you click - below the display region of the menu, a REQ_SCR_DLINE is - generated, if you doubleclick a REQ_SCR_DPAGE is generated - and if you tripleclick a REQ_LAST_ITEM is generated. If - 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 - 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 - request. If you clicked outside the user window or the - mouse event couldn't be translated into a menu request an + window (e.g., inside the menu display area or the decora- + tion window) are handled. + + If you click above the display region of the menu: + + o a REQ_SCR_ULINE is generated for a single click, + + o a REQ_SCR_UPAGE is generated for a double-click and + + o a REQ_FIRST_ITEM is generated for a triple-click. + + If you click below the display region of the menu: + + o a REQ_SCR_DLINE is generated for a single click, + + o a REQ_SCR_DPAGE is generated for a double-click and + + o a REQ_LAST_ITEM is generated for a triple-click. + + 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 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 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 - value of these pre-defined requests. + ++APPLICATION-DEFINED COMMANDS
+ 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.-RETURN VALUE
+RETURN VALUE
menu_driver return one of the following error codes: E_OK The routine succeeded. @@ -189,25 +224,25 @@-SEE ALSO
- curses(3x), menu(3x). +SEE ALSO
+ curses(3x), menu(3x), curs_getch(3x).-NOTES
+NOTES
The header file <menu.h> automatically includes the header files <curses.h>.-PORTABILITY
+PORTABILITY
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.-AUTHORS
+AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. @@ -215,10 +250,22 @@ menu_driver(3x)-
- -Man(1) output converted with -man2html - +