3 ****************************************************************************
4 * Copyright (c) 1998-2006,2010 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: form_field_attributes.3x,v 1.12 2010/12/04 18:40:45 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 http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_field_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">
42 <H1 class="no-header">form_field_attributes 3x</H1>
44 <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>form_field_attributes</STRONG> - color and attribute control for form fields
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
55 int set_field_fore(FIELD *field, chtype attr);
56 chtype field_fore(const FIELD *field);
57 int set_field_back(FIELD *field, chtype attr);
58 chtype field_back(const FIELD *field);
59 int set_field_pad(FIELD *field, int pad);
60 int field_pad(const FIELD *field);
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64 The function <STRONG>set_field_fore</STRONG> sets the foreground attribute of <EM>field</EM>.
65 This is the highlight used to display the field contents. The function
66 <STRONG>field_fore</STRONG> returns the foreground attribute. The default is <STRONG>A_STAND-</STRONG>
69 The function <STRONG>set_field_back</STRONG> sets the background attribute of <EM>form</EM>. This
70 is the highlight used to display the extent fields in the form. The
71 function <STRONG>field_back</STRONG> returns the background attribute. The default is
72 <STRONG>A_NORMAL</STRONG>.
74 The function <STRONG>set_field_pad</STRONG> sets the character used to fill the field.
75 The function <STRONG>field_pad</STRONG> returns the given form's pad character. The
79 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
80 These routines return one of the following:
82 <STRONG>E_OK</STRONG> The routine succeeded.
84 <STRONG>E_BAD_ARGUMENT</STRONG>
85 Routine detected an incorrect or out-of-range argument.
87 <STRONG>E_SYSTEM_ERROR</STRONG>
88 System error occurred (see <STRONG>errno</STRONG>).
91 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
92 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for detailed
93 descriptions of the entry points.
96 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
97 The header file <STRONG><form.h></STRONG> automatically includes the header file
98 <STRONG><curses.h></STRONG>.
101 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
102 These routines emulate the System V forms library. They were not sup-
103 ported on Version 7 or BSD versions.
106 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
107 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
112 <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
116 <li><a href="#h2-NAME">NAME</a></li>
117 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
118 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
119 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
120 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
121 <li><a href="#h2-NOTES">NOTES</a></li>
122 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
123 <li><a href="#h2-AUTHORS">AUTHORS</a></li>