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