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