ncurses 5.3
[ncurses.git] / doc / html / man / form_field_attributes.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998,2001,2002 Free Software Foundation, Inc.              *
6   *                                                                          *
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:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
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.                               *
25   *                                                                          *
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       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_field_attributes.3x,v 1.7 2002/01/19 22:48:14 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_field_attributes 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_field_attributes 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_field_attributes</STRONG>  -  color  and attribute control for
48        form fields
49
50
51 </PRE>
52 <H2>SYNOPSIS</H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
54        int set_field_fore(FIELD *field, chtype attr);
55        chtype field_fore(const FIELD *field);
56        int set_field_back(FIELD *field, chtype attr);
57        chtype field_back(const FIELD *field);
58        int set_field_pad(FIELD *field, int pad);
59        int field_pad(const FIELD *field);
60
61
62 </PRE>
63 <H2>DESCRIPTION</H2><PRE>
64        The function <STRONG>set_field_fore</STRONG> sets the foreground  attribute
65        of  <EM>field</EM>. This is the highlight used to display the field
66        contents.  The function <STRONG>field_fore</STRONG> returns the  foreground
67        attribute.  The default is <STRONG>A_STANDOUT</STRONG>.
68
69        The  function <STRONG>set_field_back</STRONG> sets the background attribute
70        of <EM>form</EM>. This is the highlight used to display the  extent
71        fields  in  the form.  The function <STRONG>field_back</STRONG> returns the
72        background attribute.  The default is <STRONG>A_NORMAL</STRONG>.
73
74        The function <STRONG>set_field_pad</STRONG> sets the character used to fill
75        the  field.   The  function  <STRONG>field_pad</STRONG>  returns  the given
76        form's pad character.  The default is a blank.
77
78
79 </PRE>
80 <H2>RETURN VALUE</H2><PRE>
81        These routines return one of the following:
82
83        <STRONG>E_OK</STRONG> The routine succeeded.
84
85        <STRONG>E_SYSTEM_ERROR</STRONG>
86             System error occurred (see <STRONG>errno</STRONG>).
87
88        <STRONG>E_BAD_ARGUMENT</STRONG>
89             Routine detected an incorrect or  out-of-range  argu-
90             ment.
91
92
93 </PRE>
94 <H2>SEE ALSO</H2><PRE>
95        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
96        detailed descriptions of the entry points.
97
98
99 </PRE>
100 <H2>NOTES</H2><PRE>
101        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
102        file <STRONG>&lt;curses.h&gt;</STRONG>.
103
104
105 </PRE>
106 <H2>PORTABILITY</H2><PRE>
107        These  routines  emulate the System V forms library.  They
108        were not supported on Version 7 or BSD versions.
109
110
111 </PRE>
112 <H2>AUTHORS</H2><PRE>
113        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
114        curses by Eric S. Raymond.
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>