1.\" $NetBSD: menu_attributes.3,v 1.8 2002/10/01 19:26:58 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. 70This attribute is set by the 71.Fn set_menu_back 72call. 73The 74.Fn menu_fore 75function returns the value of the foreground character attribute for 76the menu passed. 77This attribute is set by the 78.Fn set_menu_fore 79function. 80The 81.Fn menu_grey 82function returns the value of the grey or unselectable character 83attribute for the menu passed. 84This attribute is set by the 85.Fn set_menu_grey 86function. 87The 88.Fn menu_pad 89function returns the padding character that will be used between the 90item name and it's description. 91The value of the pad character is set by the 92.Fn set_menu_pad 93function. 94.Sh RETURN VALUES 95The functions return one of the following error values: 96.Pp 97.Bl -tag -width E_UNKNOWN_COMMAND -compact 98.It Er E_OK 99The function was successful. 100.It Er E_SYSTEM_ERROR 101There was a system error during the call. 102.It Er E_BAD_ARGUMENT 103One or more of the arguments passed to the function was incorrect. 104.It Er E_POSTED 105The menu is already posted. 106.It Er E_CONNECTED 107An item was already connected to a menu. 108.It Er E_BAD_STATE 109The function was called from within an initialization or termination 110routine. 111.It Er E_NO_ROOM 112The menu does not fit within the subwindow. 113.It Er E_NOT_POSTED 114The menu is not posted. 115.It Er E_UNKNOWN_COMMAND 116The menu driver does not recognize the request passed to it. 117.It Er E_NO_MATCH 118The character search failed to find a match. 119.It Er E_NOT_SELECTABLE 120The item could not be selected. 121.It Er E_NOT_CONNECTED 122The item is not connected to a menu. 123.It Er E_REQUEST_DENIED 124The menu driver could not process the request. 125.El 126.Sh SEE ALSO 127.Xr curses 3 , 128.Xr menus 3 129.Sh NOTES 130The header 131.Pa \*[Lt]menu.h\*[Gt] 132automatically includes both 133.Pa \*[Lt]curses.h\*[Gt] 134and 135.Pa \*[Lt]eti.h\*[Gt] . 136