ncurses 6.2 - patch 20200328
[ncurses.git] / man / menu_items.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2012,2015 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_items.3x,v 1.15 2020/03/28 19:06:28 tom Exp $
32 .TH menu_items 3X ""
33 .SH NAME
34 \fBset_menu_items\fR,
35 \fBmenu_items\fR,
36 \fBitem_count\fP \- make and break connections between items and menus
37 .SH SYNOPSIS
38 \fB#include <menu.h>\fR
39 .br
40 int set_menu_items(MENU *menu, ITEM **items);
41 .br
42 ITEM **menu_items(const MENU *menu);
43 .br
44 int item_count(const MENU *menu);
45 .br
46 .SH DESCRIPTION
47 The function \fBset_menu_items\fR changes the item pointer array of the given
48 \fImenu\fR.  The array must be terminated by a \fBNULL\fR.
49 .PP
50 The function \fBmenu_items\fR returns the item array of the given menu.
51 .PP
52 The function \fBitem_count\fR returns the count of items in \fImenu\fR.
53 .SH RETURN VALUE
54 The function \fBmenu_items\fR returns a pointer (which may be \fBNULL\fR).
55 It does not set \fBerrno\fP.
56 .PP
57 The function \fBitem_count\fR returns \fBERR\fR (the general \fBcurses\fR error
58 return value) if its \fImenu\fP parameter is \fBNULL\fP.
59 .PP
60 The function \fBset_menu_items\fR returns one of the following codes on error:
61 .TP 5
62 .B E_OK
63 The routine succeeded.
64 .TP 5
65 .B E_BAD_ARGUMENT
66 Routine detected an incorrect or out-of-range argument.
67 .TP 5
68 .B E_NOT_CONNECTED
69 No items are connected to the menu.
70 .TP 5
71 .B E_POSTED
72 The menu is already posted.
73 .TP 5
74 .B E_SYSTEM_ERROR
75 System error occurred (see \fBerrno\fR(3)).
76 .
77 .SH SEE ALSO
78 \fBcurses\fR(3X), \fBmenu\fR(3X).
79 .SH NOTES
80 The header file \fB<menu.h>\fR automatically includes the header file
81 \fB<curses.h>\fR.
82 .SH PORTABILITY
83 These routines emulate the System V menu library.
84 They were not supported on
85 Version 7 or BSD versions.
86 .PP
87 The SVr4 menu library documentation specifies the \fBitem_count\fR error value
88 as \-1 (which is the value of \fBERR\fR).
89 .SH AUTHORS
90 Juergen Pfeifer.
91 Manual pages and adaptation for new curses by Eric S. Raymond.