X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_pattern.3x.html;h=b3dfd5fa392db46cca12deb5a685033ebc31e13d;hp=ea3a8cce9a5764ed9251dbb3891089841e39c682;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html index ea3a8cce..b3dfd5fa 100644 --- a/doc/html/man/menu_pattern.3x.html +++ b/doc/html/man/menu_pattern.3x.html @@ -1,7 +1,7 @@ - - +
-- +menu_pattern(3X) menu_pattern(3X) --
- menu_pattern - get and set a menu's pattern buffer --
- #include <menu.h> - int set_menu_pattern(MENU *menu, const char *pattern); - char *menu_pattern(const MENU *menu); +
+ set_menu_pattern, menu_pattern - set and get a menu's pattern buffer --
- Every menu has an associated pattern match buffer. As - input events that are printable ASCII characters come in, - they are appended to this match buffer and tested for a - match, as described in menu_driver(3x). - The function set_menu_pattern sets the pattern buffer for - the given menu and tries to find the first matching item. - If it succeeds, that item becomes current; if not, the - current item does not change. +
+ #include <menu.h> - The function menu_pattern returns the pattern buffer of - the given menu. + int set_menu_pattern(MENU *menu, const char *pattern); + char *menu_pattern(const MENU *menu); --
- The function menu_pattern returns NULL on error. The - function set_menu_pattern may return the following error - codes: +
+ Every menu has an associated pattern match buffer. As input events + that are printable characters come in, they are appended to this match + buffer and tested for a match, as described in menu_driver(3X). + + The function set_menu_pattern sets the pattern buffer for the given + menu and tries to find the first matching item. If it succeeds, that + item becomes current; if not, the current item does not change. + + The function menu_pattern returns the pattern buffer of the given menu. + + +
+ The function menu_pattern returns a pointer, which is NULL if the menu + parameter is NULL. Otherwise, it is a pointer to a string which is + empty if no pattern has been set. It does not set errno. + + The function set_menu_pattern may return the following error codes: - E_OK The routine succeeded. + E_OK The routine succeeded. - E_SYSTEM_ERROR - System error occurred (see errno). + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argument. - E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. + E_BAD_STATE + Routine was called from an initialization or termination function. - E_NO_MATCH + E_NOT_CONNECTED + No items are connected to menu. + + E_NO_MATCH Character failed to match. + E_SYSTEM_ERROR + System error occurred (see errno(3)). --
- curses(3x), menu(3x). +
+ curses(3X), menu(3X). --
- The header file <menu.h> automatically includes the header - file <curses.h>. +
+ The header file <menu.h> automatically includes the header file + <curses.h>. --
- These routines emulate the System V menu library. They - were not supported on Version 7 or BSD versions. + +
+ These routines emulate the System V menu library. They were not + supported on Version 7 or BSD versions. + + +
+ 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_pattern(3X)-