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