1.\" $NetBSD: menu_attributes.3,v 1.6 2002/02/20 11:47:55 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_ATTRIBUTES 3 34.Os 35.Sh NAME 36.Nm menu_back , 37.Nm menu_fore , 38.Nm menu_grey , 39.Nm menu_pad , 40.Nm set_menu_back , 41.Nm set_menu_fore , 42.Nm set_menu_grey , 43.Nm set_menu_pad 44.Nd get and set menu attributes 45.Sh LIBRARY 46.Lb libmenu 47.Sh SYNOPSIS 48.Fd #include \*[Lt]menu.h\*[Gt] 49.Ft char 50.Fn menu_back "MENU *menu" 51.Ft char 52.Fn menu_fore "MENU *menu" 53.Ft char 54.Fn menu_grey "MENU *menu" 55.Ft int 56.Fn menu_pad "MENU *menu" 57.Ft int 58.Fn set_menu_back "MENU *menu" "char attr" 59.Ft int 60.Fn set_menu_fore "MENU *menu" "char attr" 61.Ft int 62.Fn set_menu_grey "MENU *menu" "char attr" 63.Ft int 64.Fn set_menu_pad "MENU *menu" "int pad" 65.Sh DESCRIPTION 66The 67.Fn menu_back 68function returns the value of the background attribute for the menu 69passed. This attribute is set by the 70.Fn set_menu_back 71call. 72The 73.Fn menu_fore 74function returns the value of the foreground character attribute for 75the menu passed. This attribute is set by the 76.Fn set_menu_fore 77function. 78The 79.Fn menu_grey 80function returns the value of the grey or unselectable character 81attribute for the menu passed. This attribute is set by the 82.Fn set_menu_grey 83function. 84The 85.Fn menu_pad 86function returns the padding character that will be used between the 87item name and it's description. The value of the pad character is set 88by the 89.Fn set_menu_pad 90function. 91.Sh RETURN VALUES 92The functions return one of the following error values: 93.Pp 94.Bl -tag -width E_UNKNOWN_COMMAND -compact 95.It Er E_OK 96The function was successful. 97.It Er E_SYSTEM_ERROR 98There was a system error during the call. 99.It Er E_BAD_ARGUMENT 100One or more of the arguments passed to the function was incorrect. 101.It Er E_POSTED 102The menu is already posted. 103.It Er E_CONNECTED 104An item was already connected to a menu. 105.It Er E_BAD_STATE 106The function was called from within an initialisation or termination 107routine. 108.It Er E_NO_ROOM 109The menu does not fit within the subwindow. 110.It Er E_NOT_POSTED 111The menu is not posted. 112.It Er E_UNKNOWN_COMMAND 113The menu driver does not recognise the request passed to it. 114.It Er E_NO_MATCH 115The character search failed to find a match. 116.It Er E_NOT_SELECTABLE 117The item could not be selected. 118.It Er E_NOT_CONNECTED 119The item is not connected to a menu. 120.It Er E_REQUEST_DENIED 121The menu driver could not process the request. 122.El 123.Sh SEE ALSO 124.Xr curses 3 , 125.Xr menus 3 126.Sh NOTES 127The header 128.Pa \*[Lt]menu.h\*[Gt] 129automatically includes both 130.Pa \*[Lt]curses.h\*[Gt] 131and 132.Pa \*[Lt]eti.h\*[Gt] . 133