Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / b2cef93693cf7cfd01098c9b69603c90f0f4b803 / . / doc / html / man / menu_pattern.3x.html
blob: 997be0c0aa1bc2394d0bd8338ba276119e0370f5 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]3 * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]29 * @Id: menu_pattern.3x,v 1.13 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]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">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]41<H1 class="no-header">menu_pattern 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]50 <STRONG>menu_pattern</STRONG> - get and set a menu's pattern buffer
51
52
53</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]54<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]55 <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56 int set_menu_pattern(MENU *menu, const char *pattern);
57 char *menu_pattern(const MENU *menu);
58
59
60</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]61<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]62 Every menu has an associated pattern match buffer. As
63 input events that are printable characters come in, they
64 are appended to this match buffer and tested for a match,
65 as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>.
66
67 The function <STRONG>set_menu_pattern</STRONG> sets the pattern buffer for
68 the given menu and tries to find the first matching item.
69 If it succeeds, that item becomes current; if not, the
70 current item does not change.
71
72 The function <STRONG>menu_pattern</STRONG> returns the pattern buffer of
73 the given <EM>menu</EM>.
74
75
76</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]77<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]78 The function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG>
79 if the <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. Otherwise, it is a pointer
80 to a string which is empty if no pattern has been set. It
81 does not set errno.
82
83 The function <STRONG>set_menu_pattern</STRONG> may return the following
84 error codes:
85
86 <STRONG>E_OK</STRONG> The routine succeeded.
87
88 <STRONG>E_BAD_ARGUMENT</STRONG>
89 Routine detected an incorrect or out-of-range argu-
90 ment.
91
92 <STRONG>E_BAD_STATE</STRONG>
93 Routine was called from an initialization or termina-
94 tion function.
95
96 <STRONG>E_NOT_CONNECTED</STRONG>
97 No items are connected to menu.
98
99 <STRONG>E_NO_MATCH</STRONG>
100 Character failed to match.
101
102 <STRONG>E_SYSTEM_ERROR</STRONG>
103 System error occurred (see <STRONG>errno</STRONG>).
104
105
106</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]107<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]108 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
109
110
111</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]112<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]113 The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
114 file <STRONG>&lt;curses.h&gt;</STRONG>.
115
116
117</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]118<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]119 These routines emulate the System V menu library. They
120 were not supported on Version 7 or BSD versions.
121
122
123</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]124<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]125 Juergen Pfeifer. Manual pages and adaptation for new
126 curses by Eric S. Raymond.
127
128
129
130 <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
131</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]132<div class="nav">
133<ul>
134<li><a href="#h2-NAME">NAME</a></li>
135<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
136<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
137<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
138<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
139<li><a href="#h2-NOTES">NOTES</a></li>
140<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
141<li><a href="#h2-AUTHORS">AUTHORS</a></li>
142</ul>
143</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]144</BODY>
145</HTML>