diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2011-04-08 15:39:59 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2011-04-08 15:39:59 +0000 |
commit | 7d428150a7d1d60a127906c29520b4554147ced1 (patch) | |
tree | 887b0cfafce298ee955bcc4a591d38af2778b7f8 /ncurses-5.9/man/menu_pattern.3x | |
parent | 2011-04-08 Joel Sherrill <joel.sherrill@oarcorp.com> (diff) | |
download | rtems-addon-packages-7d428150a7d1d60a127906c29520b4554147ced1.tar.bz2 |
2011-04-08 Joel Sherrill <joel.sherrill@oarcorp.com>
* bit: Update to ncurses-5.9.
* ncurses-5.9/ANNOUNCE, ncurses-5.9/AUTHORS, ncurses-5.9/INSTALL,
ncurses-5.9/MANIFEST, ncurses-5.9/Makefile.in,
ncurses-5.9/Makefile.os2, ncurses-5.9/NEWS, ncurses-5.9/README,
ncurses-5.9/README.MinGW, ncurses-5.9/README.emx, ncurses-5.9/TO-DO,
ncurses-5.9/aclocal.m4, ncurses-5.9/announce.html.in,
ncurses-5.9/config.guess, ncurses-5.9/config.sub,
ncurses-5.9/configure, ncurses-5.9/configure.in,
ncurses-5.9/convert_configure.pl, ncurses-5.9/dist.mk,
ncurses-5.9/install-sh, ncurses-5.9/mk-0th.awk,
ncurses-5.9/mk-1st.awk, ncurses-5.9/mk-2nd.awk,
ncurses-5.9/mk-dlls.sh.in, ncurses-5.9/mk-hdr.awk,
ncurses-5.9/Ada95/Makefile.in, ncurses-5.9/Ada95/README,
ncurses-5.9/Ada95/TODO, ncurses-5.9/Ada95/aclocal.m4,
ncurses-5.9/Ada95/configure, ncurses-5.9/Ada95/configure.in,
ncurses-5.9/Ada95/make-tar.sh, ncurses-5.9/Ada95/mk-1st.awk,
ncurses-5.9/Ada95/doc/Makefile.in, ncurses-5.9/Ada95/gen/Makefile.in,
ncurses-5.9/Ada95/gen/adacurses-config.in,
ncurses-5.9/Ada95/gen/gen.c, ncurses-5.9/Ada95/gen/html.m4,
ncurses-5.9/Ada95/gen/normal.m4, ncurses-5.9/Ada95/gen/table.m4,
ncurses-5.9/Ada95/gen/terminal_interface-curses-aux.ads.m4,
Diffstat (limited to 'ncurses-5.9/man/menu_pattern.3x')
-rw-r--r-- | ncurses-5.9/man/menu_pattern.3x | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/ncurses-5.9/man/menu_pattern.3x b/ncurses-5.9/man/menu_pattern.3x new file mode 100644 index 0000000..eb073ac --- /dev/null +++ b/ncurses-5.9/man/menu_pattern.3x @@ -0,0 +1,85 @@ +.\"*************************************************************************** +.\" Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * +.\" * +.\" Permission is hereby granted, free of charge, to any person obtaining a * +.\" copy of this software and associated documentation files (the * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id$ +.TH menu_pattern 3X "" +.SH NAME +\fBmenu_pattern\fR \- get and set a menu's pattern buffer +.SH SYNOPSIS +\fB#include <menu.h>\fR +.br +int set_menu_pattern(MENU *menu, const char *pattern); +.br +char *menu_pattern(const MENU *menu); +.br +.SH DESCRIPTION +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 \fBmenu_driver\fR(3X). +.PP +The function \fBset_menu_pattern\fR 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. +.PP +The function \fBmenu_pattern\fR returns the pattern buffer of the given +\fImenu\fR. +.SH RETURN VALUE +The function \fBmenu_pattern\fR returns a pointer, which is \fBNULL\fR if the \fImenu\fP parameter is \fBNULL\fP. +Otherwise, it is a pointer to a string which is empty if no pattern has been set. +It does not set errno. +.PP +The function \fBset_menu_pattern\fR may return the following error codes: +.TP 5 +.B E_OK +The routine succeeded. +.TP 5 +.B E_BAD_ARGUMENT +Routine detected an incorrect or out-of-range argument. +.TP 5 +.B E_BAD_STATE +Routine was called from an initialization or termination function. +.TP 5 +.B E_NOT_CONNECTED +No items are connected to menu. +.TP 5 +.B E_NO_MATCH +Character failed to match. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). +.SH SEE ALSO +\fBcurses\fR(3X), \fBmenu\fR(3X). +.SH NOTES +The header file \fB<menu.h>\fR automatically includes the header file +\fB<curses.h>\fR. +.SH PORTABILITY +These routines emulate the System V menu library. They were not supported on +Version 7 or BSD versions. +.SH AUTHORS +Juergen Pfeifer. Manual pages and adaptation for new curses by Eric +S. Raymond. |