X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_driver.3x.html;h=98b5de815740d314686cba0e722483ca7728952e;hp=3fd2da9e65551010729407990d4937f25da0a876;hb=302a066a01e4de40f08b397e87ca0e97f20870a7;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e;ds=sidebyside diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index 3fd2da9e..98b5de81 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) --
+
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: - - 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 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). - - 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 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. + o The input is the KEY_MOUSE special key associated with + an mouse event. The menu driver requests are as follows: @@ -137,7 +134,8 @@ 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 @@ -146,41 +144,42 @@ If you click above the display region of the menu: - a REQ_SCR_ULINE is generated for a single click, + o a REQ_SCR_ULINE is generated for a single click, - a REQ_SCR_UPAGE is generated for a double-click and + o a REQ_SCR_UPAGE is generated for a double-click and - a REQ_FIRST_ITEM is generated for a triple-click. + o 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, + o a REQ_SCR_DLINE is generated for a single click, - a REQ_SCR_DPAGE is generated for a double-click and + o a REQ_SCR_DPAGE is generated for a double-click and - a REQ_LAST_ITEM is generated for a triple-click. + o 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. + o 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. + 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. - - 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. - 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 @@ -189,8 +188,7 @@ these pre-defined requests. --
+
menu_driver return one of the following error codes: E_OK The routine succeeded. @@ -219,26 +217,22 @@ The menu driver could not process the request. --
- curses(3x), menu(3x), wgetch(3x). +
+ curses(3x), menu(3x), getch(3x). --
+
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. --
+
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. @@ -246,10 +240,22 @@ menu_driver(3x)-