X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_driver.3x.html;h=c592699410610e5a88c75d7050aa0f0bb0012a4c;hb=f36e772702d4b512a4395e2db96470803485b6df;hp=2c4f5e6e27e9ec86aecac1e7e863e91558244652;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;p=ncurses.git diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index 2c4f5e6e..c5926994 100644 --- a/doc/html/man/menu_driver.3x.html +++ b/doc/html/man/menu_driver.3x.html @@ -1,7 +1,7 @@
@@ -40,6 +40,10 @@+menu_driver(3x) menu_driver(3x) + + +
@@ -56,9 +60,20 @@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: + + - 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. + + - 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. + + - The input is the KEY_MOUSE special key associated with + an mouse event. + The menu driver requests are as follows: REQ_LEFT_ITEM @@ -104,7 +119,7 @@ Clear the menu pattern buffer. REQ_BACK_PATTERN - Delete the previous character from the pattern + Delete the previous character from the pattern buffer. REQ_NEXT_MATCH @@ -113,46 +128,65 @@ 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 + 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 + 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 - E_REQUEST_DENIED is returned. + 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 for a single click, + + a REQ_SCR_UPAGE is generated for a double-click and + + a REQ_FIRST_ITEM is generated for a triple-click. + + If you click below the display region of the menu: + + a REQ_SCR_DLINE is generated for a single click, + + a REQ_SCR_DPAGE is generated for a double-click and - 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. + a REQ_LAST_ITEM is generated for a triple-click. + 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 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 applica- + tion 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 + could not be translated into a menu request an + E_REQUEST_DENIED is returned. + + 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.@@ -187,7 +221,7 @@
- curses(3x), menu(3x). + curses(3x), menu(3x), wgetch(3x).@@ -210,14 +244,7 @@ - - - - - - - - + menu_driver(3x)