Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / b2cef93693cf7cfd01098c9b69603c90f0f4b803 / . / doc / html / man / menu_attributes.3x.html
blob: ac338e6edb34ac72d43d665dd487a8925842395a [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 * t
3 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]4 * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]5 * *
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: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
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. *
24 * *
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 *
28 * authorization. *
29 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]30 * @Id: menu_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]31-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]37<TITLE>menu_attributes 3x</TITLE>
38<link rev=made href="mailto:bug-ncurses@gnu.org">
39<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40</HEAD>
41<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]42<H1 class="no-header">menu_attributes 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]44<STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
45
46
47
48
49</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]50<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]51 <STRONG>menu_attributes</STRONG> - color and attribute control for menus
52
53
54</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]55<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]56 <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57 int set_menu_fore(MENU *menu, chtype attr);
58 chtype menu_fore(const MENU *menu);
59 int set_menu_back(MENU *menu, chtype attr);
60 chtype menu_back(const MENU *menu);
61 int set_menu_grey(MENU *menu, chtype attr);
62 chtype menu_grey(const MENU *menu);
63 int set_menu_pad(MENU *menu, int pad);
64 int menu_pad(const MENU *menu);
65
66
67</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]68<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]69 The function <STRONG>set_menu_fore</STRONG> sets the foreground attribute
70 of <EM>menu</EM>. This is the highlight used for selected menu
71 items. <STRONG>menu_fore</STRONG> returns the foreground attribute. The
72 default is <STRONG>A_REVERSE</STRONG>.
73
74 The function <STRONG>set_menu_back</STRONG> sets the background attribute
75 of <EM>menu</EM>. This is the highlight used for selectable (but
76 not currently selected) menu items. The function
77 <STRONG>menu_back</STRONG> returns the background attribute. The default
78 is <STRONG>A_NORMAL</STRONG>.
79
80 The function <STRONG>set_menu_grey</STRONG> sets the grey attribute of
81 <EM>menu</EM>. This is the highlight used for un-selectable menu
82 items in menus that permit more than one selection. The
83 function <STRONG>menu_grey</STRONG> returns the grey attribute. The
84 default is <STRONG>A_UNDERLINE</STRONG>.
85
86 The function <STRONG>set_menu_pad</STRONG> sets the character used to fill
87 the space between the name and description parts of a menu
88 item. <STRONG>menu_pad</STRONG> returns the given menu's pad character.
89 The default is a blank.
90
91
92</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]93<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]94 These routines return one of the following:
95
96 <STRONG>E_OK</STRONG> The routine succeeded.
97
98 <STRONG>E_SYSTEM_ERROR</STRONG>
99 System error occurred (see <STRONG>errno</STRONG>).
100
101 <STRONG>E_BAD_ARGUMENT</STRONG>
102 Routine detected an incorrect or out-of-range argu-
103 ment.
104
105
106</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]107<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]108 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for
109 detailed descriptions of the entry points.
110
111
112</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]113<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]114 The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
115 file <STRONG>&lt;curses.h&gt;</STRONG>.
116
117
118</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]119<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]120 These routines emulate the System V menu library. They
121 were not supported on Version 7 or BSD versions.
122
123
124</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]125<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]126 Juergen Pfeifer. Manual pages and adaptation for new
127 curses by Eric S. Raymond.
128
129
130
131 <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
132</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]133<div class="nav">
134<ul>
135<li><a href="#h2-NAME">NAME</a></li>
136<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
137<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
138<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
139<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
140<li><a href="#h2-NOTES">NOTES</a></li>
141<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
142<li><a href="#h2-AUTHORS">AUTHORS</a></li>
143</ul>
144</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]145</BODY>
146</HTML>