ncurses 6.0 - patch 20170304
[ncurses.git] / man / menu.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2014,2017 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 .\"
30 .\" $Id: menu.3x,v 1.23 2017/02/18 16:49:46 tom Exp $
31 .TH menu 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .SH NAME
37 \fBmenu\fR \- curses extension for programming menus
38 .SH SYNOPSIS
39 \fB#include <menu.h>\fR
40 .br
41 .SH DESCRIPTION
42 The \fBmenu\fR library provides terminal-independent facilities for composing
43 menu systems on character-cell terminals.  The library includes: item routines,
44 which create and modify menu items; and menu routines, which group items into
45 menus, display menus on the screen, and handle interaction with the user.
46 .PP
47 The \fBmenu\fR library uses the \fBcurses\fR libraries, and a curses
48 initialization routine such as \fBinitscr\fR must be called before using any of
49 these functions.  To use the \fBmenu\fR library, link with the options
50 \fB\-lmenu \-lcurses\fR.
51 .
52 .SS Current Default Values for Item Attributes
53 .
54 The \fBmenu\fR library maintains a default value for item attributes.  You can
55 get or set this default by calling the appropriate \fBget_\fR or \fBset_\fR
56 routine with a \fBNULL\fR item pointer.  Changing this default with a
57 \fBset_\fR function affects future item creations, but does not change the
58 rendering of items already created.
59 .
60 .SS Routine Name Index
61 .
62 The following table lists each \fBmenu\fR routine and the name of
63 the manual page on which it is described.
64 .
65 .TS
66 l l .
67 \fBcurses\fR Routine Name       Manual Page Name
68 =
69 current_item    \fBmitem_current\fR(3X)
70 free_item       \fBmitem_new\fR(3X)
71 free_menu       \fBmenu_new\fR(3X)
72 item_count      \fBmenu_items\fR(3X)
73 item_description        \fBmitem_name\fR(3X)
74 item_index      \fBmitem_current\fR(3X)
75 item_init       \fBmenu_hook\fR(3X)
76 item_name       \fBmitem_name\fR(3X)
77 item_opts       \fBmitem_opts\fR(3X)
78 item_opts_off   \fBmitem_opts\fR(3X)
79 item_opts_on    \fBmitem_opts\fR(3X)
80 item_term       \fBmenu_hook\fR(3X)
81 item_userptr    \fBmitem_userptr\fR(3X)
82 item_value      \fBmitem_value\fR(3X)
83 item_visible    \fBmitem_visible\fR(3X)
84 menu_back       \fBmenu_attributes\fR(3X)
85 menu_driver     \fBmenu_driver\fR(3X)
86 menu_fore       \fBmenu_attributes\fR(3X)
87 menu_format     \fBmenu_format\fR(3X)
88 menu_grey       \fBmenu_attributes\fR(3X)
89 menu_init       \fBmenu_hook\fR(3X)
90 menu_items      \fBmenu_items\fR(3X)
91 menu_mark       \fBmenu_mark\fR(3X)
92 menu_opts       \fBmenu_opts\fR(3X)
93 menu_opts_off   \fBmenu_opts\fR(3X)
94 menu_opts_on    \fBmenu_opts\fR(3X)
95 menu_pad        \fBmenu_attributes\fR(3X)
96 menu_pattern    \fBmenu_pattern\fR(3X)
97 menu_request_by_name    \fBmenu_requestname\fR(3X)
98 menu_request_name       \fBmenu_requestname\fR(3X)
99 menu_spacing    \fBmenu_spacing\fR(3X)
100 menu_sub        \fBmenu_win\fR(3X)
101 menu_term       \fBmenu_hook\fR(3X)
102 menu_userptr    \fBmenu_userptr\fR(3X)
103 menu_win        \fBmenu_win\fR(3X)
104 new_item        \fBmitem_new\fR(3X)
105 new_menu        \fBmenu_new\fR(3X)
106 pos_menu_cursor \fBmenu_cursor\fR(3X)
107 post_menu       \fBmenu_post\fR(3X)
108 scale_menu      \fBmenu_win\fR(3X)
109 set_current_item        \fBmitem_current\fR(3X)
110 set_item_init   \fBmenu_hook\fR(3X)
111 set_item_opts   \fBmitem_opts\fR(3X)
112 set_item_term   \fBmenu_hook\fR(3X)
113 set_item_userptr        \fBmitem_userptr\fR(3X)
114 set_item_value  \fBmitem_value\fR(3X)
115 set_menu_back   \fBmenu_attributes\fR(3X)
116 set_menu_fore   \fBmenu_attributes\fR(3X)
117 set_menu_format \fBmenu_format\fR(3X)
118 set_menu_grey   \fBmenu_attributes\fR(3X)
119 set_menu_init   \fBmenu_hook\fR(3X)
120 set_menu_items  \fBmenu_items\fR(3X)
121 set_menu_mark   \fBmenu_mark\fR(3X)
122 set_menu_opts   \fBmitem_opts\fR(3X)
123 set_menu_pad    \fBmenu_attributes\fR(3X)
124 set_menu_pattern        \fBmenu_pattern\fR(3X)
125 set_menu_spacing        \fBmenu_spacing\fR(3X)
126 set_menu_sub    \fBmenu_win\fR(3X)
127 set_menu_term   \fBmenu_hook\fR(3X)
128 set_menu_userptr        \fBmenu_userptr\fR(3X)
129 set_menu_win    \fBmenu_win\fR(3X)
130 set_top_row     \fBmitem_current\fR(3X)
131 top_row         \fBmitem_current\fR(3X)
132 unpost_menu     \fBmenu_post\fR(3X)
133 .TE
134 .SH RETURN VALUE
135 Routines that return pointers return \fBNULL\fR on error.  Routines that return
136 an integer return one of the following error codes:
137 .TP 5
138 .B E_OK
139 The routine succeeded.
140 .TP 5
141 .B E_BAD_ARGUMENT
142 Routine detected an incorrect or out-of-range argument.
143 .TP 5
144 .B E_BAD_STATE
145 Routine was called from an initialization or termination function.
146 .TP 5
147 .B E_NO_MATCH
148 Character failed to match.
149 .TP 5
150 .B E_NO_ROOM
151 Menu is too large for its window.
152 .TP 5
153 .B E_NOT_CONNECTED
154 No items are connected to the menu.
155 .TP 5
156 .B E_NOT_POSTED
157 The menu has not been posted.
158 .TP 5
159 .B E_NOT_SELECTABLE
160 The designated item cannot be selected.
161 .TP 5
162 .B E_POSTED
163 The menu is already posted.
164 .TP 5
165 .B E_REQUEST_DENIED
166 The menu driver could not process the request.
167 .TP 5
168 .B E_SYSTEM_ERROR
169 System error occurred (see \fBerrno\fR).
170 .TP 5
171 .B E_UNKNOWN_COMMAND
172 The menu driver code saw an unknown request code.
173 .SH NOTES
174 The header file \fB<menu.h>\fR automatically includes the header files
175 \fB<curses.h>\fR and \fB<eti.h>\fR.
176 .PP
177 In your library list, libmenu.a should be before libncurses.a; that is,
178 you should say \*(``\-lmenu \-lncurses\*('', not the other way around
179 (which would give a link-error when using static libraries).
180 .SH PORTABILITY
181 These routines emulate the System V menu library.  They were not supported on
182 Version 7 or BSD versions.
183 .SH AUTHORS
184 Juergen Pfeifer.  Manual pages and adaptation for ncurses by Eric
185 S. Raymond.
186 .SH SEE ALSO
187 \fBcurses\fR(3X) and related pages whose names begin \*(``menu_\*(''
188 for detailed descriptions of the entry points.
189 .PP
190 This describes \fBncurses\fR
191 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).