diff options
author | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-01-18 12:04:32 +0000 |
---|---|---|
committer | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-01-18 12:04:32 +0000 |
commit | e2d147e01aa8bd00b79c8288fa1c490d187c9e82 (patch) | |
tree | 0e50849418106307cd3b6ae5346d11cdcec8756c /doc/html/man/menu_pattern.3x.html | |
download | ncurses-e2d147e01aa8bd00b79c8288fa1c490d187c9e82.tar.gz |
Tarball conversion
Diffstat (limited to 'doc/html/man/menu_pattern.3x.html')
-rw-r--r-- | doc/html/man/menu_pattern.3x.html | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html new file mode 100644 index 0000000..88e6cdb --- /dev/null +++ b/doc/html/man/menu_pattern.3x.html @@ -0,0 +1,138 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * 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: menu_pattern.3x,v 1.13 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_pattern 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_pattern 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_pattern</STRONG> - get and set a menu's pattern buffer + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_pattern(MENU *menu, const char *pattern); + char *menu_pattern(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + 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 <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>. + + The function <STRONG>set_menu_pattern</STRONG> 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 <STRONG>menu_pattern</STRONG> returns the pattern buffer of + the given <EM>menu</EM>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG> + if the <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. Otherwise, it is a pointer + to a string which is empty if no pattern has been set. It + does not set errno. + + The function <STRONG>set_menu_pattern</STRONG> may return the following + error codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to menu. + + <STRONG>E_NO_MATCH</STRONG> + Character failed to match. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |