xref: /netbsd/lib/libmenu/menu_post.3 (revision c4a72b64)
1.\"	$NetBSD: menu_post.3,v 1.8 2002/10/01 19:27:00 wiz Exp $
2.\"
3.\" Copyright (c) 1999
4.\"	Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
5.\"
6.\" This code is donated to The NetBSD Foundation by the author.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of the Author may not be used to endorse or promote
17.\"    products derived from this software without specific prior written
18.\"    permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd September 10, 1999
33.Dt MENU_POST 3
34.Os
35.Sh NAME
36.Nm post_menu
37.Nm unpost_menu
38.Nd post (draw) or unpost a menu
39.Sh LIBRARY
40.Lb libmenu
41.Sh SYNOPSIS
42.Fd #include \*[Lt]menu.h\*[Gt]
43.Ft int
44.Fn post_menu "MENU *menu"
45.Ft int
46.Fn unpost_menu "MENU *menu"
47.Sh DESCRIPTION
48The
49.Fn post_menu
50function causes the menu to be drawn on the screen.
51Any functions defined by either
52.Fn set_menu_init
53or
54.Fn set_item_init
55(see
56.Xr menu_hook 3 )
57are called before the menu is placed on the screen.
58The
59.Fn unpost_menu
60does the opposite, it removes a menu from the screen.
61Any functions defined by both
62.Fn set_menu_term
63and
64.Fn set_item_term
65(see
66.Xr menu_hook 3 )
67are called prior to the menu's removal.
68.Sh RETURN VALUES
69The functions return one of the following error values:
70.Pp
71.Bl -tag -width E_NOT_CONNECTED -compact
72.It Er E_OK
73The function was successful.
74.It Er E_SYSTEM_ERROR
75There was a system error during the call.
76.It Er E_BAD_ARGUMENT
77One or more of the arguments passed to the function was incorrect.
78.It Er E_POSTED
79The menu is already posted.
80.It Er E_BAD_STATE
81The function was called from within an initialization or termination
82routine.
83.It Er E_NO_ROOM
84The menu does not fit within the subwindow.
85.It Er E_NOT_CONNECTED
86The item is not connected to a menu.
87.El
88.Sh SEE ALSO
89.Xr curses 3 ,
90.Xr menu_hook 3 ,
91.Xr menus 3
92.Sh NOTES
93The header
94.Pa \*[Lt]menu.h\*[Gt]
95automatically includes both
96.Pa \*[Lt]curses.h\*[Gt]
97and
98.Pa \*[Lt]eti.h\*[Gt] .
99