ncurses 6.1 - patch 20190713
[ncurses.git] / doc / html / man / menu_pattern.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2018,2019 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.17 2019/01/20 20:32:23 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 https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>menu_pattern 3x</TITLE>
37 <link rel="author" 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 pattern buffer
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
54        int set_menu_pattern(MENU *menu, const char *pattern);
55        char *menu_pattern(const MENU *menu);
56
57
58 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
59        Every  menu  has  an  associated pattern match buffer.  As input events
60        that are printable characters come in, they are appended to this  match
61        buffer and tested for a match, as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>.
62
63        The  function  <STRONG>set_menu_pattern</STRONG>  sets  the pattern buffer for the given
64        menu and tries to find the first matching item.  If it  succeeds,  that
65        item becomes current; if not, the current item does not change.
66
67        The function <STRONG>menu_pattern</STRONG> returns the pattern buffer of the given <EM>menu</EM>.
68
69
70 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
71        The  function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG> if the <EM>menu</EM>
72        parameter is <STRONG>NULL</STRONG>.  Otherwise, it is a pointer to  a  string  which  is
73        empty if no pattern has been set.  It does not set errno.
74
75        The function <STRONG>set_menu_pattern</STRONG> may return the following error codes:
76
77        <STRONG>E_OK</STRONG> The routine succeeded.
78
79        <STRONG>E_BAD_ARGUMENT</STRONG>
80             Routine detected an incorrect or out-of-range argument.
81
82        <STRONG>E_BAD_STATE</STRONG>
83             Routine was called from an initialization or termination function.
84
85        <STRONG>E_NOT_CONNECTED</STRONG>
86             No items are connected to menu.
87
88        <STRONG>E_NO_MATCH</STRONG>
89             Character failed to match.
90
91        <STRONG>E_SYSTEM_ERROR</STRONG>
92             System error occurred (see <STRONG>errno(3)</STRONG>).
93
94
95 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
96        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
97
98
99 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
100        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
101        <STRONG>&lt;curses.h&gt;</STRONG>.
102
103
104 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
105        These routines emulate the System V menu library.  They were  not  sup-
106        ported on Version 7 or BSD versions.
107
108
109 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
110        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
111        Raymond.
112
113
114
115                                                               <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
116 </PRE>
117 <div class="nav">
118 <ul>
119 <li><a href="#h2-NAME">NAME</a></li>
120 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
121 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
122 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124 <li><a href="#h2-NOTES">NOTES</a></li>
125 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
126 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
127 </ul>
128 </div>
129 </BODY>
130 </HTML>