3 ****************************************************************************
4 * Copyright 2018-2019,2020 Thomas E. Dickey *
5 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
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: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
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. *
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 *
30 ****************************************************************************
31 * @Id: menu_attributes.3x,v 1.19 2020/10/17 23:58:58 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_attributes 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <H1 class="no-header">menu_attributes 3x</H1>
45 <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>menu_back</STRONG>, <STRONG>menu_fore</STRONG>, <STRONG>menu_grey</STRONG>, <STRONG>menu_pad</STRONG>, <STRONG>set_menu_back</STRONG>,
52 <STRONG>set_menu_fore</STRONG>, <STRONG>set_menu_grey</STRONG>, <STRONG>set_menu_pad</STRONG> - color and attribute
56 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
59 <STRONG>int</STRONG> <STRONG>set_menu_fore(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>attr</EM><STRONG>);</STRONG>
60 <STRONG>chtype</STRONG> <STRONG>menu_fore(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>set_menu_back(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>attr</EM><STRONG>);</STRONG>
63 <STRONG>chtype</STRONG> <STRONG>menu_back(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>set_menu_grey(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>attr</EM><STRONG>);</STRONG>
66 <STRONG>chtype</STRONG> <STRONG>menu_grey(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
68 <STRONG>int</STRONG> <STRONG>set_menu_pad(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>pad</EM><STRONG>);</STRONG>
69 <STRONG>int</STRONG> <STRONG>menu_pad(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
72 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
73 The function <STRONG>set_menu_fore</STRONG> sets the foreground attribute of <EM>menu</EM>. This
74 is the highlight used for selected menu items. <STRONG>menu_fore</STRONG> returns the
75 foreground attribute. The default is <STRONG>A_REVERSE</STRONG>.
77 The function <STRONG>set_menu_back</STRONG> sets the background attribute of <EM>menu</EM>. This
78 is the highlight used for selectable (but not currently selected) menu
79 items. The function <STRONG>menu_back</STRONG> returns the background attribute. The
80 default is <STRONG>A_NORMAL</STRONG>.
82 The function <STRONG>set_menu_grey</STRONG> sets the grey attribute of <EM>menu</EM>. This is the
83 highlight used for un-selectable menu items in menus that permit more
84 than one selection. The function <STRONG>menu_grey</STRONG> returns the grey attribute.
85 The default is <STRONG>A_UNDERLINE</STRONG>.
87 The function <STRONG>set_menu_pad</STRONG> sets the character used to fill the space
88 between the name and description parts of a menu item. <STRONG>menu_pad</STRONG>
89 returns the given menu's pad character. The default is a blank.
92 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
93 These routines return one of the following:
95 <STRONG>E_OK</STRONG> The routine succeeded.
97 <STRONG>E_SYSTEM_ERROR</STRONG>
98 System error occurred (see <STRONG>errno(3)</STRONG>).
100 <STRONG>E_BAD_ARGUMENT</STRONG>
101 Routine detected an incorrect or out-of-range argument.
104 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
105 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for detailed
106 descriptions of the entry points.
109 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
110 The header file <STRONG><menu.h></STRONG> automatically includes the header file
111 <STRONG><curses.h></STRONG>.
114 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
115 These routines emulate the System V menu library. They were not
116 supported on Version 7 or BSD versions.
119 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
120 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
125 <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
129 <li><a href="#h2-NAME">NAME</a></li>
130 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
131 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
132 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
133 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
134 <li><a href="#h2-NOTES">NOTES</a></li>
135 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
136 <li><a href="#h2-AUTHORS">AUTHORS</a></li>