Debian Codegraph @

upstream/debian-trixie/man3/post.3menu

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 1998-2016,2017 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.36 2024/03/16 15:35:01 tom Exp $
31 .TH post 3MENU 2024-03-16 "ncurses 6.5" "Library calls"
32 .SH NAME
33 \fBpost_menu\fP,
34 \fBunpost_menu\fP \-
35 write or erase menus from associated subwindows
36 .SH SYNOPSIS
37 .nf
38 \fB#include <menu.h>
39 .PP
40 \fBint post_menu(MENU *\fImenu\fP);
41 \fBint unpost_menu(MENU *\fImenu\fP);
42 .fi
43 .SH DESCRIPTION
44 The function \fBpost_menu\fP displays a menu to its associated subwindow.
45 To
46 trigger physical display of the subwindow,
47 use \fB\%refresh\fP(3NCURSES) or some equivalent
48 \fBcurses\fP routine (the implicit \fBdoupdate\fP triggered by an \fBcurses\fP
49 input request will do).
50 \fBpost_menu\fP resets the selection status of all items.
51 .PP
52 The function \fBunpost_menu\fP 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\fP(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\fP 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 PORTABILITY
81 These routines emulate the System V menu library.
82 They were not supported on
83 Version 7 or BSD versions.
84 .SH AUTHORS
85 Juergen Pfeifer.
86 Manual pages and adaptation for new curses by Eric S. Raymond.
87 .SH SEE ALSO
88 \fB\%ncurses\fP(3NCURSES),
89 \fB\%menu\fP(3MENU)