X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_pattern.3x.html;h=bf7bf8f2af0285f81a6e8cb85fd36cb77d3a8f45;hb=59c1a9740d123db3cecafe76e18f7848081a670b;hp=4a2f09b3396e70c0ad898fee8568baa58f491de6;hpb=761e4f0825b330e970558e82a4bd638383914429;p=ncurses.git diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html index 4a2f09b3..bf7bf8f2 100644 --- a/doc/html/man/menu_pattern.3x.html +++ b/doc/html/man/menu_pattern.3x.html @@ -1,7 +1,6 @@ - +
+ +- menu_pattern(3x) menu_pattern(3x) --
- menu_pattern - get and set a menu's pattern buffer +
+ set_menu_pattern, menu_pattern - set and get a menu's pat- + tern buffer --
+
#include <menu.h> 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, +
+ 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 + 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 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 + The function set_menu_pattern may return the following error codes: E_OK The routine succeeded. E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- + Routine detected an incorrect or out-of-range argu- ment. E_BAD_STATE @@ -103,36 +100,39 @@ System error occurred (see errno). --
+
curses(3x), menu(3x). --
+
The header file <menu.h> automatically includes the header file <curses.h>. --
- These routines emulate the System V menu library. They +
+ 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 +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. menu_pattern(3x)-