ncurses 5.3
[ncurses.git] / doc / html / man / menu_attributes.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: menu_attributes.3x,v 1.7 2002/01/19 22:49:06 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>menu_attributes 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>menu_attributes 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>menu_attributes</STRONG> - color and attribute control for menus
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
53        int set_menu_fore(MENU *menu, chtype attr);
54        chtype menu_fore(const MENU *menu);
55        int set_menu_back(MENU *menu, chtype attr);
56        chtype menu_back(const MENU *menu);
57        int set_menu_grey(MENU *menu, chtype attr);
58        chtype menu_grey(const MENU *menu);
59        int set_menu_pad(MENU *menu, int pad);
60        int menu_pad(const MENU *menu);
61
62
63 </PRE>
64 <H2>DESCRIPTION</H2><PRE>
65        The  function  <STRONG>set_menu_fore</STRONG> sets the foreground attribute
66        of <EM>menu</EM>. This is the  highlight  used  for  selected  menu
67        items.   <STRONG>menu_fore</STRONG>  returns the foreground attribute.  The
68        default is <STRONG>A_STANDOUT</STRONG>.
69
70        The function <STRONG>set_menu_back</STRONG> sets the  background  attribute
71        of  <EM>menu</EM>.  This  is the highlight used for selectable (but
72        not  currently  selected)  menu   items.    The   function
73        <STRONG>menu_back</STRONG>  returns  the background attribute.  The default
74        is <STRONG>A_NORMAL</STRONG>.
75
76        The function <STRONG>set_menu_grey</STRONG>  sets  the  grey  attribute  of
77        <EM>menu</EM>.  This  is  the highlight used for un-selectable menu
78        items in menus that permit more than one  selection.   The
79        function   <STRONG>menu_grey</STRONG>  returns  the  grey  attribute.   The
80        default is <STRONG>A_UNDERLINE</STRONG>.
81
82        The function <STRONG>set_menu_pad</STRONG> sets the character used to  fill
83        the space between the name and description parts of a menu
84        item.  <STRONG>menu_pad</STRONG> returns the given  menu's  pad  character.
85        The default is a blank.
86
87
88 </PRE>
89 <H2>RETURN VALUE</H2><PRE>
90        These routines return one of the following:
91
92        <STRONG>E_OK</STRONG> The routine succeeded.
93
94        <STRONG>E_SYSTEM_ERROR</STRONG>
95             System error occurred (see <STRONG>errno</STRONG>).
96
97        <STRONG>E_BAD_ARGUMENT</STRONG>
98             Routine  detected  an incorrect or out-of-range argu-
99             ment.
100
101
102 </PRE>
103 <H2>SEE ALSO</H2><PRE>
104        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for
105        detailed descriptions of the entry points.
106
107
108
109 </PRE>
110 <H2>NOTES</H2><PRE>
111        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
112        file <STRONG>&lt;curses.h&gt;</STRONG>.
113
114
115 </PRE>
116 <H2>PORTABILITY</H2><PRE>
117        These routines emulate the System V  menu  library.   They
118        were not supported on Version 7 or BSD versions.
119
120
121 </PRE>
122 <H2>AUTHORS</H2><PRE>
123        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
124        curses by Eric S. Raymond.
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>