ncurses 6.2 - patch 20210911
[ncurses.git] / man / menu_post.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2016,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_post.3x,v 1.19 2020/10/17 23:47:21 tom Exp $
32 .TH menu_post 3X ""
33 .SH NAME
34 \fBpost_menu\fR,
35 \fBunpost_menu\fR \- write or erase menus from associated subwindows
36 .SH SYNOPSIS
37 \fB#include <menu.h>\fR
38 .sp
39 \fBint post_menu(MENU *\fP\fImenu\fP\fB);\fP
40 .br
41 \fBint unpost_menu(MENU *\fP\fImenu\fP\fB);\fP
42 .br
43 .SH DESCRIPTION
44 The function \fBpost_menu\fR displays a menu to its associated subwindow.
45 To
46 trigger physical display of the subwindow,
47 use \fBrefresh\fR(3X) or some equivalent
48 \fBcurses\fR routine (the implicit \fBdoupdate\fR triggered by an \fBcurses\fR
49 input request will do).
50 \fBpost_menu\fR resets the selection status of all items.
51 .PP
52 The function \fBunpost_menu\fR erases menu from its associated subwindow.
53 .SH RETURN VALUE
54 These routines return one of the following:
55 .TP 5
56 .B E_OK
57 The routine succeeded.
58 .TP 5
59 .B E_SYSTEM_ERROR
60 System error occurred (see \fBerrno\fR(3)).
61 .TP 5
62 .B E_BAD_ARGUMENT
63 Routine detected an incorrect or out-of-range argument.
64 .TP 5
65 .B E_POSTED
66 The menu has already been posted.
67 .TP 5
68 .B E_BAD_STATE
69 Routine was called from an initialization or termination function.
70 .TP 5
71 .B E_NO_ROOM
72 Menu is too large for its window.
73 You should consider using \fBset_menu_format\fR to solve the problem.
74 .TP 5
75 .B E_NOT_POSTED
76 The menu has not been posted.
77 .TP 5
78 .B E_NOT_CONNECTED
79 No items are connected to the menu.
80 .SH SEE ALSO
81 \fBcurses\fR(3X), \fBmenu\fR(3X).
82 .SH NOTES
83 The header file \fB<menu.h>\fR automatically includes the header file
84 \fB<curses.h>\fR.
85 .SH PORTABILITY
86 These routines emulate the System V menu library.
87 They were not supported on
88 Version 7 or BSD versions.
89 .SH AUTHORS
90 Juergen Pfeifer.
91 Manual pages and adaptation for new curses by Eric S. Raymond.