ncurses 6.2 - patch 20210109
[ncurses.git] / man / menu_win.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2006,2010 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_win.3x,v 1.15 2020/10/17 23:50:51 tom Exp $
32 .TH menu_win 3X ""
33 .SH NAME
34 \fBmenu_win\fR \- make and break menu window and subwindow associations
35 .SH SYNOPSIS
36 \fB#include <menu.h>\fR
37 .sp
38 \fBint set_menu_win(MENU *\fP\fImenu\fP\fB, WINDOW *\fP\fIwin\fP\fB);\fP
39 .br
40 \fBWINDOW *menu_win(const MENU *\fP\fImenu\fP\fB);\fP
41 .sp
42 \fBint set_menu_sub(MENU *\fP\fImenu\fP\fB, WINDOW *\fP\fIsub\fP\fB);\fP
43 .br
44 \fBWINDOW *menu_sub(const MENU *\fP\fImenu\fP\fB);\fP
45 .sp
46 \fBint scale_menu(const MENU *\fP\fImenu, int *\fP\fIrows\fP\fB, int *\fP\fIcolumns);\fP
47 .br
48 .SH DESCRIPTION
49 Every menu has an associated pair of \fBcurses\fR windows.
50 The menu window
51 displays any title and border associated with the window; the menu subwindow
52 displays the items of the menu that are currently available for selection.
53 .PP
54 The first four functions get and set those windows.
55 It is not necessary to set
56 either window; by default, the driver code uses \fBstdscr\fR for both.
57 .PP
58 In the \fBset_\fR functions, window argument of \fBNULL\fR is treated as though
59 it were \fBstsdcr\fR.  A menu argument of \fBNULL\fR is treated as a request
60 to change the system default menu window or subwindow.
61 .PP
62 The function \fBscale_menu\fR returns the minimum size required for the
63 subwindow of \fImenu\fR.
64 .SH RETURN VALUE
65 Routines that return pointers return \fBNULL\fR on error.
66 Routines that return
67 an integer return one of the following error codes:
68 .TP 5
69 .B E_OK
70 The routine succeeded.
71 .TP 5
72 .B E_SYSTEM_ERROR
73 System error occurred (see \fBerrno\fR(3)).
74 .TP 5
75 .B E_BAD_ARGUMENT
76 Routine detected an incorrect or out-of-range argument.
77 .TP 5
78 .B E_POSTED
79 The menu has already been posted.
80 .TP 5
81 .B E_NOT_CONNECTED
82 No items are connected to the menu.
83 .SH SEE ALSO
84 \fBcurses\fR(3X),
85 \fBcurs_variables\fR(3X),
86 \fBmenu\fR(3X).
87 .SH NOTES
88 The header file \fB<menu.h>\fR automatically includes the header file
89 \fB<curses.h>\fR.
90 .SH PORTABILITY
91 These routines emulate the System V menu library.
92 They were not supported on
93 Version 7 or BSD versions.
94 .SH AUTHORS
95 Juergen Pfeifer.
96 Manual pages and adaptation for new curses by Eric S. Raymond.