2 .\"***************************************************************************
3 .\" Copyright (c) 1998,2002 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: menu_attributes.3x,v 1.7 2002/01/19 22:49:06 tom Exp $
31 .\" $DragonFly: src/lib/libncurses/man/menu_attributes.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
32 .TH menu_attributes 3X ""
34 \fBmenu_attributes\fR - color and attribute control for menus
36 \fB#include <menu.h>\fR
38 int set_menu_fore(MENU *menu, chtype attr);
40 chtype menu_fore(const MENU *menu);
42 int set_menu_back(MENU *menu, chtype attr);
44 chtype menu_back(const MENU *menu);
46 int set_menu_grey(MENU *menu, chtype attr);
48 chtype menu_grey(const MENU *menu);
50 int set_menu_pad(MENU *menu, int pad);
52 int menu_pad(const MENU *menu);
55 The function \fBset_menu_fore\fR sets the foreground attribute of
56 \fImenu\fR. This is the highlight used for selected menu items.
57 \fBmenu_fore\fR returns the foreground attribute. The default
60 The function \fBset_menu_back\fR sets the background attribute of
61 \fImenu\fR. This is the highlight used for selectable (but not currently
62 selected) menu items. The function \fBmenu_back\fR returns the background
63 attribute. The default is \fBA_NORMAL\fR.
65 The function \fBset_menu_grey\fR sets the grey attribute of \fImenu\fR. This is
66 the highlight used for un-selectable menu items in menus that permit more than
67 one selection. The function \fBmenu_grey\fR returns the grey attribute.
68 The default is \fBA_UNDERLINE\fR.
70 The function \fBset_menu_pad\fR sets the character used to fill the space
71 between the name and description parts of a menu item. \fBmenu_pad\fR returns
72 the given menu's pad character. The default is a blank.
74 These routines return one of the following:
77 The routine succeeded.
80 System error occurred (see \fBerrno\fR).
83 Routine detected an incorrect or out-of-range argument.
85 \fBcurses\fR(3X) and related pages whose names begin "menu_" for detailed
86 descriptions of the entry points.
88 The header file \fB<menu.h>\fR automatically includes the header file
91 These routines emulate the System V menu library. They were not supported on
92 Version 7 or BSD versions.
94 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
97 .\"# The following sets edit modes for GNU EMACS