X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_pattern.3x.html;h=389a4b4d437e8acf7419576250de89fa0d12bad2;hb=d1a029866f6d84087781eaa81de19949d8533426;hp=b3dfd5fa392db46cca12deb5a685033ebc31e13d;hpb=9f479192e3ca3413d235c66bf058f8cc63764898;p=ncurses.git diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html index b3dfd5fa..389a4b4d 100644 --- a/doc/html/man/menu_pattern.3x.html +++ b/doc/html/man/menu_pattern.3x.html @@ -1,6 +1,6 @@
--menu_pattern(3X) menu_pattern(3X) +menu_pattern(3x) Library calls menu_pattern(3x)
- set_menu_pattern, menu_pattern - set and get a menu's pattern buffer + set_menu_pattern, menu_pattern - set and get a menu's pattern buffer
- #include <menu.h> + #include <menu.h> - int set_menu_pattern(MENU *menu, const char *pattern); - char *menu_pattern(const MENU *menu); + int set_menu_pattern(MENU *menu, const char *pattern); + char *menu_pattern(const MENU *menu);
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). + buffer and tested for a match, as described in menu_driver(3x). - The function set_menu_pattern sets the pattern buffer for the given + 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 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 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: + The function set_menu_pattern may return the following error codes: - E_OK The routine succeeded. + E_OK The routine succeeded. - 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_CONNECTED + E_NOT_CONNECTED No items are connected to menu. - E_NO_MATCH + E_NO_MATCH Character failed to match. - E_SYSTEM_ERROR - System error occurred (see errno(3)). + 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>.
@@ -114,7 +114,7 @@ - menu_pattern(3X) +ncurses 6.4 2023-07-01 menu_pattern(3x)