X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_driver.3x.html;h=bf5da3e832ca4f6e40beface155e808b487004c3;hb=5899b5e464ecec4b1613f6fef8cb7b75793c88e3;hp=fa65d9760c760622b7902f1ba29ad11b23dcd588;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index fa65d976..bf5da3e8 100644 --- a/doc/html/man/menu_driver.3x.html +++ b/doc/html/man/menu_driver.3x.html @@ -1,7 +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); --
- 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. +
+ 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(3x). + + o The input is a printable character. Printable characters (which + must be positive, less than 256) are checked according to the pro- + gram'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 +115,7 @@ Clear the menu pattern buffer. REQ_BACK_PATTERN - Delete the previous character from the pattern - buffer. + Delete the previous character from the pattern buffer. REQ_NEXT_MATCH Move to the next item matching the pattern match. @@ -117,63 +123,75 @@ 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 - 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 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 - 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 + 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 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: + + 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 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. + + 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 applica- + tion-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. @@ -188,37 +206,45 @@ The menu driver could not process the request. --
- curses(3x), menu(3x). +
+ curses(3x), menu(3x), getch(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 sup- + ported 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)-