d77562a95ff38b7b3544bb82f4455fd9b5b8c87e
[ncurses.git] / doc / html / man / menu.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998,2000,2002 Free Software Foundation, Inc.              *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: menu.3x,v 1.15 2002/01/19 22:48:58 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>menu 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>menu 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>menu</STRONG> - curses extension for programming menus
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
53
54
55 </PRE>
56 <H2>DESCRIPTION</H2><PRE>
57        The  <STRONG>menu</STRONG> library provides terminal-independent facilities
58        for composing menu systems  on  character-cell  terminals.
59        The library includes: item routines, which create and mod-
60        ify menu items; and menu routines, which group items  into
61        menus, display menus on the screen, and handle interaction
62        with the user.
63
64        The <STRONG>menu</STRONG> library uses the <STRONG>curses</STRONG> libraries, and  a  curses
65        initialization  routine  such  as  <STRONG>initscr</STRONG>  must be called
66        before using any of these  functions.   To  use  the  <STRONG>menu</STRONG>
67        library, link with the options <STRONG>-lmenu</STRONG> <STRONG>-lcurses</STRONG>.
68
69
70    <STRONG>Current</STRONG> <STRONG>Default</STRONG> <STRONG>Values</STRONG> <STRONG>for</STRONG> <STRONG>Item</STRONG> <STRONG>Attributes</STRONG>
71        The  <STRONG>menu</STRONG>  library  maintains  a  default  value  for item
72        attributes.  You can get or set this  default  by  calling
73        the  appropriate  <STRONG>get_</STRONG>  or  <STRONG>set_</STRONG>  routine with a <STRONG>NULL</STRONG> item
74        pointer.  Changing  this  default  with  a  <STRONG>set_</STRONG>  function
75        affects  future  item  creations,  but does not change the
76        rendering of items already created.
77
78
79    <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG>
80        The following table lists each <STRONG>menu</STRONG> routine and  the  name
81        of the manual page on which it is described.
82
83        <STRONG>curses</STRONG> Routine Name    Manual Page Name
84        --------------------------------------------
85        current_item           <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
86        free_item              <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
87        free_menu              <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>
88        item_count             <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
89        item_description       <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG>
90        item_index             <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
91        item_init              <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
92        item_name              <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG>
93        item_opts              <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
94        item_opts_off          <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
95        item_opts_on           <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
96        item_term              <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
97        item_userptr           <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
98        item_value             <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG>
99        item_visible           <STRONG><A HREF="mitem_visible.3x.html">mitem_visible(3x)</A></STRONG>
100        menu_back              <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
101        menu_driver            <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>
102        menu_fore              <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
103
104        menu_format            <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
105        menu_grey              <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
106        menu_init              <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
107        menu_items             <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
108        menu_mark              <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
109        menu_opts              <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
110        menu_opts_off          <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
111        menu_opts_on           <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
112        menu_pad               <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
113        menu_pattern           <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
114        menu_request_by_name   <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG>
115        menu_request_name      <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG>
116        menu_spacing           <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
117        menu_sub               <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
118        menu_term              <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
119        menu_userptr           <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG>
120        menu_win               <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
121        new_item               <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
122        new_menu               <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>
123        pos_menu_cursor        <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG>
124        post_menu              <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
125        scale_menu             <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
126        set_current_item       <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
127        set_item_init          <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
128        set_item_opts          <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
129        set_item_term          <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
130        set_item_userptr       <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
131        set_item_value         <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG>
132        set_menu_back          <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
133        set_menu_fore          <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
134        set_menu_format        <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
135        set_menu_grey          <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
136        set_menu_init          <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
137        set_menu_items         <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
138        set_menu_mark          <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
139        set_menu_opts          <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
140        set_menu_pad           <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
141        set_menu_pattern       <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
142        set_menu_spacing       <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
143        set_menu_sub           <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
144        set_menu_term          <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
145        set_menu_userptr       <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG>
146        set_menu_win           <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
147        set_top_row            <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
148        top_row                <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
149        unpost_menu            <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
150
151
152 </PRE>
153 <H2>RETURN VALUE</H2><PRE>
154        Routines  that return pointers return <STRONG>NULL</STRONG> on error.  Rou-
155        tines that return an integer return one of  the  following
156        error codes:
157
158        <STRONG>E_OK</STRONG> The routine succeeded.
159
160        <STRONG>E_SYSTEM_ERROR</STRONG>
161             System error occurred (see <STRONG>errno</STRONG>).
162
163        <STRONG>E_BAD_ARGUMENT</STRONG>
164             Routine  detected  an incorrect or out-of-range argu-
165             ment.
166
167        <STRONG>E_POSTED</STRONG>
168             The menu is already posted.
169
170        <STRONG>E_BAD_STATE</STRONG>
171             Routine was called from an initialization or termina-
172             tion function.
173
174        <STRONG>E_NO_ROOM</STRONG>
175             Menu is too large for its window.
176
177        <STRONG>E_NOT_POSTED</STRONG>
178             The menu has not been posted.
179
180        <STRONG>E_UNKNOWN_COMMAND</STRONG>
181             The menu driver code saw an unknown request code.
182
183        <STRONG>E_NO_MATCH</STRONG>
184             Character failed to match.
185
186        <STRONG>E_NOT_SELECTABLE</STRONG>
187             The designated item cannot be selected.
188
189        <STRONG>E_NOT_CONNECTED</STRONG>
190             No items are connected to the menu.
191
192        <STRONG>E_REQUEST_DENIED</STRONG>
193             The menu driver could not process the request.
194
195
196 </PRE>
197 <H2>SEE ALSO</H2><PRE>
198        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for
199        detailed descriptions of the entry points.
200
201
202 </PRE>
203 <H2>NOTES</H2><PRE>
204        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
205        files <STRONG>&lt;curses.h&gt;</STRONG> and <STRONG>&lt;eti.h&gt;</STRONG>.
206
207        In  your  library  list,  libmenu.a should be before libn-
208        curses.a; that is, you want to say `-lmenu -lncurses', not
209        the  other  way  around (which would give you a link error
210        using GNU <STRONG><A HREF="ld.1.html">ld(1)</A></STRONG> and many other linkers).
211
212
213 </PRE>
214 <H2>PORTABILITY</H2><PRE>
215        These routines emulate the System V  menu  library.   They
216        were not supported on Version 7 or BSD versions.
217
218
219 </PRE>
220 <H2>AUTHORS</H2><PRE>
221        Juergen  Pfeifer.  Manual pages and adaptation for ncurses
222        by Eric S. Raymond.
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276 </PRE>
277 <HR>
278 <ADDRESS>
279 Man(1) output converted with
280 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
281 </ADDRESS>
282 </BODY>
283 </HTML>