NetBSD/lib/libmenu/menu_post.3

91 lines
2.9 KiB
Groff

.\" $NetBSD: menu_post.3,v 1.3 2001/02/26 01:26:06 blymn Exp $
.\"
.\" Copyright (c) 1999
.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
.\"
.\" This code is donated to The NetBSD Foundation by the author.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the Author may not be used to endorse or promote
.\" products derived from this software without specific prior written
.\" permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd September, 1999
.Dt MENU_POST 3
.Os BSD 4
.Sh NAME
.Nm post_menu
.Nd menu library
.Sh LIBRARY
.Lb libmenu
.Sh SYNOPSIS
.Fd #include <menu.h>
.Ft int
.Fn post_menu "MENU *menu"
.Ft int
.Fn unpost_menu "MENU *menu"
.Sh DESCRIPTION
The
.Fn post_menu
function causes the menu to be drawn on the screen. Any functions
defined by either
.Xr set_menu_init
or
.Xr set_item_init
are called before the menu is placed on the screen. The
.Fn unpost_menu
does the opposite, it removes a menu from the screen. Any functions
defined by both
.Xr set_menu_term
and
.Xr set_item_term
are called prior to the menu's removal.
.Sh RETURN VALUES
The functions return one of the following error values:
.Pp
.ta 20
.nf
E_OK The function was successful
E_SYSTEM_ERROR There was a system error during the call.
E_BAD_ARGUMENT One or more of the arguments passed to the function
was incorrect.
E_POSTED The menu is already posted.
E_BAD_STATE The function was called from within an initialisation
or termination routine.
E_NO_ROOM The menu does not fit within the subwindow.
E_NOT_CONNECTED The item is not connected to a menu.
.fi
.ft 1
.br
.ne 8
.Sh SEE ALSO
.Xr curses 3 ,
.Xr menus 3
.Sh NOTES
The header
.Xr <menu.h>
automatically includes both
.Xr <curses.h>
and
.Xr <eti.h>