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