1.\" $NetBSD: menu_win.3,v 1.6 2002/02/20 11:47:56 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_WIN 3 34.Os 35.Sh NAME 36.Nm menu_sub , 37.Nm menu_win , 38.Nm scale_window , 39.Nm set_menu_sub , 40.Nm set_menu_win 41.Nd sub-menu handling 42.Sh LIBRARY 43.Lb libmenu 44.Sh SYNOPSIS 45.Fd #include \*[Lt]menu.h\*[Gt] 46.Ft WINDOW * 47.Fn menu_sub "MENU *menu" 48.Ft WINDOW * 49.Fn menu_win "MENU *menu" 50.Ft int 51.Fn scale_window "MENU *menu" "int *rows" "int *cols" 52.Ft int 53.Fn set_menu_sub "MENU *menu" "WINDOW *sub" 54.Ft int 55.Fn set_menu_win "MENU *menu" "WINDOW *win" 56.Sh DESCRIPTION 57The 58.Fn menu_sub 59function returns a pointer to the window that will be used to post a 60menu into, this pointer is set by the 61.Fn set_menu_sub 62function. The 63.Fn menu_win 64function returns a pointer to the window in which the menu subwindow 65will be created when the menu is posted, this pointer is set by the 66.Fn set_menu_win 67function. The 68.Fn scale_window 69function calculates the minimum size a window needs to be to hold the 70items for a given menu, the parameters rows and cols are set to the 71required number of rows and columns respectively. 72.Sh RETURN VALUES 73The functions return one of the following error values: 74.Pp 75.Bl -tag -width E_UNKNOWN_COMMAND -compact 76.It Er E_OK 77The function was successful. 78.It Er E_SYSTEM_ERROR 79There was a system error during the call. 80.It Er E_BAD_ARGUMENT 81One or more of the arguments passed to the function was incorrect. 82.It Er E_POSTED 83The menu is already posted. 84.It Er E_CONNECTED 85An item was already connected to a menu. 86.It Er E_BAD_STATE 87The function was called from within an initialisation or termination 88routine. 89.It Er E_NO_ROOM 90The menu does not fit within the subwindow. 91.It Er E_NOT_POSTED 92The menu is not posted 93.It Er E_UNKNOWN_COMMAND 94The menu driver does not recognise the request passed to it. 95.It Er E_NO_MATCH 96The character search failed to find a match. 97.It Er E_NOT_SELECTABLE 98The item could not be selected. 99.It Er E_NOT_CONNECTED 100The item is not connected to a menu. 101.It Er E_REQUEST_DENIED 102The menu driver could not process the request. 103.El 104.Sh SEE ALSO 105.Xr curses 3 , 106.Xr menus 3 107.Sh NOTES 108The header 109.Pa \*[Lt]menu.h\*[Gt] 110automatically includes both 111.Pa \*[Lt]curses.h\*[Gt] 112and 113.Pa \*[Lt]eti.h\*[Gt] . 114