ncurses 6.1 - patch 20190406
[ncurses.git] / man / menu_attributes.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
4 .\"                                                                          *
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:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
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.                               *
23 .\"                                                                          *
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       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: menu_attributes.3x,v 1.15 2019/01/20 20:32:23 tom Exp $
31 .TH menu_attributes 3X ""
32 .SH NAME
33 \fBmenu_back\fR,
34 \fBmenu_fore\fR,
35 \fBmenu_grey\fR,
36 \fBmenu_pad\fR,
37 \fBset_menu_back\fR,
38 \fBset_menu_fore\fR,
39 \fBset_menu_grey\fR,
40 \fBset_menu_pad\fR \- color and attribute control for menus
41 .SH SYNOPSIS
42 \fB#include <menu.h>\fR
43 .br
44 int set_menu_fore(MENU *menu, chtype attr);
45 .br
46 chtype menu_fore(const MENU *menu);
47 .br
48 int set_menu_back(MENU *menu, chtype attr);
49 .br
50 chtype menu_back(const MENU *menu);
51 .br
52 int set_menu_grey(MENU *menu, chtype attr);
53 .br
54 chtype menu_grey(const MENU *menu);
55 .br
56 int set_menu_pad(MENU *menu, int pad);
57 .br
58 int menu_pad(const MENU *menu);
59 .br
60 .SH DESCRIPTION
61 The function \fBset_menu_fore\fR sets the foreground attribute of
62 \fImenu\fR. This is the highlight used for selected menu items.
63 \fBmenu_fore\fR returns the foreground attribute.
64 The default
65 is \fBA_REVERSE\fR.
66 .PP
67 The function \fBset_menu_back\fR sets the background attribute of
68 \fImenu\fR. This is the highlight used for selectable (but not currently
69 selected) menu items.
70 The function \fBmenu_back\fR returns the background
71 attribute.
72 The default is \fBA_NORMAL\fR.
73 .PP
74 The function \fBset_menu_grey\fR sets the grey attribute of \fImenu\fR. This is
75 the highlight used for un-selectable menu items in menus that permit more than
76 one selection.
77 The function \fBmenu_grey\fR returns the grey attribute.
78 The default is \fBA_UNDERLINE\fR.
79 .PP
80 The function \fBset_menu_pad\fR sets the character used to fill the space
81 between the name and description parts of a menu item.
82 \fBmenu_pad\fR returns
83 the given menu's pad character.
84 The default is a blank.
85 .SH RETURN VALUE
86 These routines return one of the following:
87 .TP 5
88 .B E_OK
89 The routine succeeded.
90 .TP 5
91 .B E_SYSTEM_ERROR
92 System error occurred (see \fBerrno\fR(3)).
93 .TP 5
94 .B E_BAD_ARGUMENT
95 Routine detected an incorrect or out-of-range argument.
96 .SH SEE ALSO
97 \fBcurses\fR(3X) and related pages whose names begin "menu_" for detailed
98 descriptions of the entry points.
99 .SH NOTES
100 The header file \fB<menu.h>\fR automatically includes the header file
101 \fB<curses.h>\fR.
102 .SH PORTABILITY
103 These routines emulate the System V menu library.
104 They were not supported on
105 Version 7 or BSD versions.
106 .SH AUTHORS
107 Juergen Pfeifer.
108 Manual pages and adaptation for new curses by Eric S. Raymond.