693ebe35729a25f3b0ecfd57e323ae2198f69fa2
[ncurses.git] / man / menu_pattern.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .'" $Id: menu_pattern.3x,v 1.5 1998/03/11 21:12:53 juergen Exp $
30 .TH menu_pattern 3X ""
31 .SH NAME
32 \fBmenu_pattern\fR - get and set a menu's pattern buffer
33 .SH SYNOPSIS
34 \fB#include <menu.h>\fR
35 .br
36 int set_menu_pattern(MENU *menu, const char *pattern);
37 .br
38 char *menu_pattern(const MENU *menu);
39 .br
40 .SH DESCRIPTION
41 Every menu has an associated pattern match buffer.  As input events that are
42 printable ASCII characters come in, they are appended to this match buffer
43 and tested for a match, as described in \fBmenu_driver\fR(3X).
44
45 The function \fBset_menu_pattern\fR sets the pattern buffer for the given menu
46 and tries to find the first matching item.  If it succeeds, that item becomes
47 current; if not, the current item does not change.  
48
49 The function \fBmenu_pattern\fR returns the pattern buffer of the given
50 \fImenu\fR.
51 .SH RETURN VALUE
52 The function \fBmenu_pattern\fR returns \fBNULL\fR on error.  The function
53 \fBset_menu_pattern\fR may return the following error codes:
54 .TP 5
55 \fBE_OK\fR
56 The routine succeeded.
57 .TP 5
58 \fBE_SYSTEM_ERROR\fR
59 System error occurred (see \fBerrno\fR).
60 .TP 5
61 \fBE_BAD_ARGUMENT\fR
62 Routine detected an incorrect or out-of-range argument.
63 .TP 5
64 \fBE_NO_MATCH\fR
65 Character failed to match.
66 .SH SEE ALSO
67 \fBcurses\fR(3X), \fBmenu\fR(3X).
68 .SH NOTES
69 The header file \fB<menu.h>\fR automatically includes the header file
70 \fB<curses.h>\fR.
71 .SH PORTABILITY
72 These routines emulate the System V menu library.  They were not supported on
73 Version 7 or BSD versions.
74 .SH AUTHORS
75 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
76 S. Raymond.
77 .\"#
78 .\"# The following sets edit modes for GNU EMACS
79 .\"# Local Variables:
80 .\"# mode:nroff
81 .\"# fill-column:79
82 .\"# End: