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 <B><A HREF="menu_attributes.3X.html">menu_attributes(3X)</A></B> <B><A HREF="menu_attributes.3X.html">menu_attributes(3X)</A></B>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <B>menu_back</B>, <B>menu_fore</B>, <B>menu_grey</B>, <B>menu_pad</B>, <B>set_menu_back</B>,
52 <B>set_menu_fore</B>, <B>set_menu_grey</B>, <B>set_menu_pad</B> - color and attribute
56 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57 <B>#include</B> <B><menu.h></B>
59 <B>int</B> <B>set_menu_fore(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>chtype</B> <I>attr</I><B>);</B>
60 <B>chtype</B> <B>menu_fore(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
62 <B>int</B> <B>set_menu_back(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>chtype</B> <I>attr</I><B>);</B>
63 <B>chtype</B> <B>menu_back(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
65 <B>int</B> <B>set_menu_grey(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>chtype</B> <I>attr</I><B>);</B>
66 <B>chtype</B> <B>menu_grey(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
68 <B>int</B> <B>set_menu_pad(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>int</B> <I>pad</I><B>);</B>
69 <B>int</B> <B>menu_pad(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
72 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
73 The function <B>set_menu_fore</B> sets the foreground attribute of <I>menu</I>. This
74 is the highlight used for selected menu items. <B>menu_fore</B> returns the
75 foreground attribute. The default is <B>A_REVERSE</B>.
77 The function <B>set_menu_back</B> sets the background attribute of <I>menu</I>. This
78 is the highlight used for selectable (but not currently selected) menu
79 items. The function <B>menu_back</B> returns the background attribute. The
80 default is <B>A_NORMAL</B>.
82 The function <B>set_menu_grey</B> sets the grey attribute of <I>menu</I>. This is the
83 highlight used for un-selectable menu items in menus that permit more
84 than one selection. The function <B>menu_grey</B> returns the grey attribute.
85 The default is <B>A_UNDERLINE</B>.
87 The function <B>set_menu_pad</B> sets the character used to fill the space
88 between the name and description parts of a menu item. <B>menu_pad</B>
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 <B>E_OK</B> The routine succeeded.
98 System error occurred (see <B>errno(3)</B>).
100 <B>E_BAD_ARGUMENT</B>
101 Routine detected an incorrect or out-of-range argument.
104 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
105 <B><A HREF="curses.3X.html">curses(3X)</A></B> 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 <B><menu.h></B> automatically includes the header file
111 <B><curses.h></B>.
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 <B><A HREF="menu_attributes.3X.html">menu_attributes(3X)</A></B>
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>