2 ****************************************************************************
3 * Copyright 2018-2022,2023 Thomas E. Dickey *
4 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: menu_attributes.3x,v 1.34 2023/11/25 13:58:47 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_attributes 3x 2023-11-25 ncurses 6.4 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">menu_attributes 3x 2023-11-25 ncurses 6.4 Library calls</H1>
44 <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> Library calls <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>menu_back</STRONG>, <STRONG>menu_fore</STRONG>, <STRONG>menu_grey</STRONG>, <STRONG>menu_pad</STRONG>, <STRONG>set_menu_back</STRONG>,
51 <STRONG>set_menu_fore</STRONG>, <STRONG>set_menu_grey</STRONG>, <STRONG>set_menu_pad</STRONG> - color and attribute
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
58 <STRONG>int</STRONG> <STRONG>set_menu_fore(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>attr</EM><STRONG>);</STRONG>
59 <STRONG>chtype</STRONG> <STRONG>menu_fore(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>set_menu_back(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>attr</EM><STRONG>);</STRONG>
62 <STRONG>chtype</STRONG> <STRONG>menu_back(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>set_menu_grey(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>attr</EM><STRONG>);</STRONG>
65 <STRONG>chtype</STRONG> <STRONG>menu_grey(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
67 <STRONG>int</STRONG> <STRONG>set_menu_pad(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>pad</EM><STRONG>);</STRONG>
68 <STRONG>int</STRONG> <STRONG>menu_pad(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
71 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
72 The function <STRONG>set_menu_fore</STRONG> sets the foreground attribute of <EM>menu</EM>. This
73 is the highlight used for selected menu items. <STRONG>menu_fore</STRONG> returns the
74 foreground attribute. The default is <STRONG>A_REVERSE</STRONG>.
76 The function <STRONG>set_menu_back</STRONG> sets the background attribute of <EM>menu</EM>. This
77 is the highlight used for selectable (but not currently selected) menu
78 items. The function <STRONG>menu_back</STRONG> returns the background attribute. The
79 default is <STRONG>A_NORMAL</STRONG>.
81 The function <STRONG>set_menu_grey</STRONG> sets the grey attribute of <EM>menu</EM>. This is the
82 highlight used for un-selectable menu items in menus that permit more
83 than one selection. The function <STRONG>menu_grey</STRONG> returns the grey attribute.
84 The default is <STRONG>A_UNDERLINE</STRONG>.
86 The function <STRONG>set_menu_pad</STRONG> sets the character used to fill the space
87 between the name and description parts of a menu item. <STRONG>menu_pad</STRONG>
88 returns the given menu's pad character. The default is a blank.
91 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
92 These routines return one of the following:
94 <STRONG>E_OK</STRONG> The routine succeeded.
96 <STRONG>E_SYSTEM_ERROR</STRONG>
97 System error occurred (see <STRONG>errno(3)</STRONG>).
99 <STRONG>E_BAD_ARGUMENT</STRONG>
100 Routine detected an incorrect or out-of-range argument.
103 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
104 These routines emulate the System V menu library. They were not
105 supported on Version 7 or BSD versions.
108 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
109 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
113 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
114 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for detailed
115 descriptions of the entry points.
119 ncurses 6.4 2023-11-25 <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
123 <li><a href="#h2-NAME">NAME</a></li>
124 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
125 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
126 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
127 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
128 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
129 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>