xref: /netbsd-src/lib/libmenu/menu_post.3 (revision e4d7c2e329d54c97e0c0bd3016bbe74f550c3d5e)
1.\"	$NetBSD: menu_post.3,v 1.2 1999/11/24 12:43:19 kleink 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, 1999
33.Dt MENU_POST 3
34.Os BSD 4
35.Sh NAME
36.Nm post_menu
37.Nd menu library
38.Sh LIBRARY
39.Lb libmenu
40.Sh SYNOPSIS
41.Fd #include <menu.h>
42.Ft int
43.Fn post_menu "MENU *menu"
44.Ft int
45.Fn unpost_menu "MENU *menu"
46.Sh DESCRIPTION
47The
48.Fn post_menu
49function causes the menu to be drawn on the screen.  Any functions
50defined by either
51.Xr set_menu_init
52or
53.Xr set_item_init
54are called before the menu is placed on the screen.  The
55.Fn unpost_menu
56does the opposite, it removes a menu from the screen.  Any functions
57defined by both
58.Xr set_menu_term
59and
60.Xr set_item_term
61are called prior to the menu's removal.
62.Sh RETURN VALUES
63The functions return one of the following error values:
64.Pp
65.ta 20
66.nf
67E_OK			The function was successful
68E_SYSTEM_ERROR		There was a system error during the call.
69E_BAD_ARGUMENT		One or more of the arguments passed to the function
70			was incorrect.
71E_POSTED		The menu is already posted.
72E_BAD_STATE		The function was called from within an initialisation
73			or termination routine.
74E_NO_ROOM		The menu does not fit within the subwindow.
75E_NOT_CONNECTED		The item is not connected to a menu.
76.fi
77.ft 1
78.br
79.ne 8
80.Sh SEE ALSO
81.Xr curses 3 ,
82.Xr menus 3
83.Sh NOTES
84The header
85.Xr <menus.h>
86automatically includes both
87.Xr <curses.h>
88and
89.Xr <eti.h>
90
91