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