ncurses 5.8 - patch 20110226
[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-2006,2010 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.21 2010/12/04 18:40:45 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 <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>                                                       <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
51        <STRONG>menu</STRONG> - curses extension for programming menus
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57
58
59 </PRE>
60 <H2>DESCRIPTION</H2><PRE>
61        The  <STRONG>menu</STRONG> library provides terminal-independent facilities
62        for composing menu systems  on  character-cell  terminals.
63        The library includes: item routines, which create and mod-
64        ify menu items; and menu routines, which group items  into
65        menus, display menus on the screen, and handle interaction
66        with the user.
67
68        The <STRONG>menu</STRONG> library uses the <STRONG>curses</STRONG> libraries, and  a  curses
69        initialization  routine  such  as  <STRONG>initscr</STRONG>  must be called
70        before using any of these  functions.   To  use  the  <STRONG>menu</STRONG>
71        library, link with the options <STRONG>-lmenu</STRONG> <STRONG>-lcurses</STRONG>.
72
73    <STRONG>Current</STRONG> <STRONG>Default</STRONG> <STRONG>Values</STRONG> <STRONG>for</STRONG> <STRONG>Item</STRONG> <STRONG>Attributes</STRONG>
74        The  <STRONG>menu</STRONG>  library  maintains  a  default  value  for item
75        attributes.  You can get or set this  default  by  calling
76        the  appropriate  <STRONG>get_</STRONG>  or  <STRONG>set_</STRONG>  routine with a <STRONG>NULL</STRONG> item
77        pointer.  Changing  this  default  with  a  <STRONG>set_</STRONG>  function
78        affects  future  item  creations,  but does not change the
79        rendering of items already created.
80
81    <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG>
82        The following table lists each <STRONG>menu</STRONG> routine and  the  name
83        of the manual page on which it is described.
84
85        <STRONG>curses</STRONG> Routine Name    Manual Page Name
86        --------------------------------------------
87        current_item           <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
88        free_item              <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
89        free_menu              <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>
90        item_count             <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
91        item_description       <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG>
92        item_index             <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
93        item_init              <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
94        item_name              <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG>
95        item_opts              <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
96        item_opts_off          <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
97        item_opts_on           <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
98        item_term              <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
99        item_userptr           <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
100        item_value             <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG>
101        item_visible           <STRONG><A HREF="mitem_visible.3x.html">mitem_visible(3x)</A></STRONG>
102        menu_back              <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
103        menu_driver            <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>
104        menu_fore              <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
105        menu_format            <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
106        menu_grey              <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
107        menu_init              <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
108        menu_items             <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
109        menu_mark              <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
110        menu_opts              <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
111        menu_opts_off          <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
112        menu_opts_on           <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
113        menu_pad               <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
114        menu_pattern           <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
115
116        menu_request_by_name   <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG>
117        menu_request_name      <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG>
118        menu_spacing           <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
119        menu_sub               <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
120        menu_term              <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
121        menu_userptr           <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG>
122        menu_win               <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
123        new_item               <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
124        new_menu               <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>
125        pos_menu_cursor        <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG>
126        post_menu              <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
127        scale_menu             <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
128        set_current_item       <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
129        set_item_init          <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
130        set_item_opts          <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
131        set_item_term          <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
132        set_item_userptr       <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
133        set_item_value         <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG>
134        set_menu_back          <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
135        set_menu_fore          <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
136        set_menu_format        <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
137        set_menu_grey          <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
138        set_menu_init          <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
139        set_menu_items         <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
140        set_menu_mark          <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
141        set_menu_opts          <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
142        set_menu_pad           <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
143        set_menu_pattern       <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
144        set_menu_spacing       <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
145        set_menu_sub           <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
146        set_menu_term          <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
147        set_menu_userptr       <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG>
148        set_menu_win           <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
149        set_top_row            <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
150        top_row                <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
151        unpost_menu            <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
152
153
154 </PRE>
155 <H2>RETURN VALUE</H2><PRE>
156        Routines  that return pointers return <STRONG>NULL</STRONG> on error.  Rou-
157        tines that return an integer return one of  the  following
158        error codes:
159
160        <STRONG>E_OK</STRONG> The routine succeeded.
161
162        <STRONG>E_BAD_ARGUMENT</STRONG>
163             Routine  detected  an incorrect or out-of-range argu-
164             ment.
165
166        <STRONG>E_BAD_STATE</STRONG>
167             Routine was called from an initialization or termina-
168             tion function.
169
170        <STRONG>E_NO_MATCH</STRONG>
171             Character failed to match.
172
173        <STRONG>E_NO_ROOM</STRONG>
174             Menu is too large for its window.
175
176        <STRONG>E_NOT_CONNECTED</STRONG>
177             No items are connected to the menu.
178
179        <STRONG>E_NOT_POSTED</STRONG>
180             The menu has not been posted.
181
182        <STRONG>E_NOT_SELECTABLE</STRONG>
183             The designated item cannot be selected.
184
185        <STRONG>E_POSTED</STRONG>
186             The menu is already posted.
187
188        <STRONG>E_REQUEST_DENIED</STRONG>
189             The menu driver could not process the request.
190
191        <STRONG>E_SYSTEM_ERROR</STRONG>
192             System error occurred (see <STRONG>errno</STRONG>).
193
194        <STRONG>E_UNKNOWN_COMMAND</STRONG>
195             The menu driver code saw an unknown request code.
196
197
198 </PRE>
199 <H2>SEE ALSO</H2><PRE>
200        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for
201        detailed descriptions of the entry points.
202
203
204 </PRE>
205 <H2>NOTES</H2><PRE>
206        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
207        files <STRONG>&lt;curses.h&gt;</STRONG> and <STRONG>&lt;eti.h&gt;</STRONG>.
208
209        In  your  library  list,  libmenu.a should be before libn-
210        curses.a; that is, you want to say `-lmenu -lncurses', not
211        the  other  way  around  (which would usually give a link-
212        error).
213
214
215 </PRE>
216 <H2>PORTABILITY</H2><PRE>
217        These routines emulate the System V  menu  library.   They
218        were not supported on Version 7 or BSD versions.
219
220
221 </PRE>
222 <H2>AUTHORS</H2><PRE>
223        Juergen  Pfeifer.  Manual pages and adaptation for ncurses
224        by Eric S. Raymond.
225
226
227 </PRE>
228 <H2>SEE ALSO</H2><PRE>
229        This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226).
230
231
232
233                                                                <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
234 </PRE>
235 <HR>
236 <ADDRESS>
237 Man(1) output converted with
238 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
239 </ADDRESS>
240 </BODY>
241 </HTML>