X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_driver.3x.html;h=df2fbe819c3b35c7e16a4b4f748f3bead58acfcb;hp=c2b9b113340a5afb6168acb3feaac728601d53e1;hb=HEAD;hpb=9f479192e3ca3413d235c66bf058f8cc63764898 diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index c2b9b113..d82a7f5c 100644 --- a/doc/html/man/menu_driver.3x.html +++ b/doc/html/man/menu_driver.3x.html @@ -1,6 +1,6 @@
--menu_driver(3X) menu_driver(3X) +menu_driver(3x) Library calls menu_driver(3x)
- menu_driver - command-processing loop of the menu system + menu_driver - command-processing loop of the menu system
- #include <menu.h> + #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: + 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 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 + 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 + o The input is the KEY_MOUSE special key associated with an mouse event. The menu driver requests are as follows: @@ -126,14 +126,14 @@ 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 + 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 @@ -141,85 +141,76 @@ 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_ULINE is generated for a single click, - o a REQ_SCR_UPAGE is generated for a double-click and + o a REQ_SCR_UPAGE is generated for a double-click and - o 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: - o a REQ_SCR_DLINE is generated for a single click, + 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_SCR_DPAGE is generated for a double-click and - o 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: - o the menu cursor is positioned to that item. + 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, + 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 + 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. + 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, + 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: + menu_driver return one of the following error codes: - E_OK The routine succeeded. + E_OK The routine succeeded. - E_SYSTEM_ERROR - System error occurred (see errno(3)). + E_SYSTEM_ERROR + System error occurred (see errno(3)). - E_BAD_ARGUMENT + E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. - E_BAD_STATE + E_BAD_STATE Routine was called from an initialization or termination function. - E_NOT_POSTED + E_NOT_POSTED The menu has not been posted. - E_UNKNOWN_COMMAND + E_UNKNOWN_COMMAND The menu driver code saw an unknown request code. - E_NO_MATCH + E_NO_MATCH Character failed to match. - E_REQUEST_DENIED + E_REQUEST_DENIED The menu driver could not process the request. -
- curses(3X), getch(3X), menu(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 support 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.
@@ -227,8 +218,12 @@ Raymond. +
+ curses(3x), getch(3x), menu(3x) + + - menu_driver(3X) +ncurses 6.5 2024-03-16 menu_driver(3x)