ncurses 6.0 - patch 20160326
[ncurses.git] / doc / html / man / menu_pattern.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: menu_pattern.3x,v 1.14 2015/12/05 23:42:45 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>menu_pattern 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">menu_pattern 3x</H1>
42 <PRE>
43 <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>                                       <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>set_menu_pattern</STRONG>, <STRONG>menu_pattern</STRONG> - set and get a menu's pat-
50        tern buffer
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
55        int set_menu_pattern(MENU *menu, const char *pattern);
56        char *menu_pattern(const MENU *menu);
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        Every menu has an associated  pattern  match  buffer.   As
61        input  events  that are printable characters come in, they
62        are appended to this match buffer and tested for a  match,
63        as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>.
64
65        The  function <STRONG>set_menu_pattern</STRONG> sets the pattern buffer for
66        the given menu and tries to find the first matching  item.
67        If  it  succeeds,  that  item becomes current; if not, the
68        current item does not change.
69
70        The function <STRONG>menu_pattern</STRONG> returns the  pattern  buffer  of
71        the given <EM>menu</EM>.
72
73
74 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
75        The function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG>
76        if the <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.  Otherwise, it is a pointer
77        to a string which is empty if no pattern has been set.  It
78        does not set errno.
79
80        The function <STRONG>set_menu_pattern</STRONG>  may  return  the  following
81        error codes:
82
83        <STRONG>E_OK</STRONG> The routine succeeded.
84
85        <STRONG>E_BAD_ARGUMENT</STRONG>
86             Routine  detected  an incorrect or out-of-range argu-
87             ment.
88
89        <STRONG>E_BAD_STATE</STRONG>
90             Routine was called from an initialization or termina-
91             tion function.
92
93        <STRONG>E_NOT_CONNECTED</STRONG>
94             No items are connected to menu.
95
96        <STRONG>E_NO_MATCH</STRONG>
97             Character failed to match.
98
99        <STRONG>E_SYSTEM_ERROR</STRONG>
100             System error occurred (see <STRONG>errno</STRONG>).
101
102
103 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
104        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
105
106
107 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
108        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
109        file <STRONG>&lt;curses.h&gt;</STRONG>.
110
111
112 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
113        These routines emulate the System V  menu  library.   They
114        were not supported on Version 7 or BSD versions.
115
116
117 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
118        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
119        curses by Eric S. Raymond.
120
121
122
123                                                        <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
124 </PRE>
125 <div class="nav">
126 <ul>
127 <li><a href="#h2-NAME">NAME</a></li>
128 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
129 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
130 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
131 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
132 <li><a href="#h2-NOTES">NOTES</a></li>
133 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
134 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
135 </ul>
136 </div>
137 </BODY>
138 </HTML>