ncurses 4.1
[ncurses.git] / man / menu_attribs.3x
1 '\" t
2 .TH menu_attributes 3X ""
3 .SH NAME
4 \fBmenu_attributes\fR - color and attribute control for menus
5 .SH SYNOPSIS
6 \fB#include <menu.h>\fR
7 .br
8 int set_menu_fore(MENU *menu, chtype attr);
9 .br
10 chtype menu_fore(const MENU *menu);
11 .br
12 int set_menu_back(MENU *menu, chtype attr);
13 .br
14 chtype menu_back(const MENU *menu);
15 .br
16 int set_menu_grey(MENU *menu, chtype attr);
17 .br
18 chtype menu_grey(const MENU *menu);
19 .br
20 int set_menu_pad(MENU *menu, int pad);
21 .br
22 int menu_pad(const MENU *menu);
23 .br
24 .SH DESCRIPTION
25 The function \fBset_menu_fore\fR sets the foreground attribute of
26 \fImenu\fR. This is the highlight used for selected menu items.
27 \fBmenu_fore\fR returns the foreground attribute.  The default
28 is \fBA_STANDOUT\fR.
29
30 The function \fBset_menu_back\fR sets the background attribute of
31 \fImenu\fR. This is the highlight used for selectable (but not currently
32 selected) menu items.  The function \fBmenu_back\fR returns the background
33 attribute.  The default is \fBA_NORMAL\fR.
34
35 The function \fBset_menu_grey\fR sets the grey attribute of \fImenu\fR. This is
36 the highlight used for un-selectable menu items in menus that permit more than
37 one selection.  The function \fBmenu_grey\fR returns the grey attribute.
38 The default is \fBA_UNDERLINE\fR.
39
40 The function \fBset_menu_pad\fR sets the character used to fill the space
41 between the name and description parts of a menu item.  \fBmenu_pad\fR returns
42 the given menu's pad character.  The default is a blank.
43 .SH RETURN VALUE
44 These routines return one of the following:
45 .TP 5
46 \fBE_OK\fR
47 The routine succeeded.
48 .TP 5
49 \fBE_SYSTEM_ERROR\fR
50 System error occurred (see \fBerrno\fR).
51 .TP 5
52 \fBE_BAD_ARGUMENT\fR
53 Routine detected an incorrect or out-of-range argument.
54 .SH SEE ALSO
55 \fBcurses\fR(3X) and 3X pages whose names begin "menu_" for detailed
56 descriptions of the entry points.
57 .SH NOTES
58 The header file \fB<menu.h>\fR automatically includes the header file
59 \fB<curses.h>\fR.
60 .SH PORTABILITY
61 These routines emulate the System V menu library.  They were not supported on
62 Version 7 or BSD versions.
63 .SH AUTHORS
64 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
65 S. Raymond.
66 .\"#
67 .\"# The following sets edit modes for GNU EMACS
68 .\"# Local Variables:
69 .\"# mode:nroff
70 .\"# fill-column:79
71 .\"# End: