ncurses 6.0 - patch 20151024
[ncurses.git] / doc / html / man / form_field_attributes.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
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   ****************************************************************************
30   * @Id: form_field_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_field_attributes 3x</H1>
43 <PRE>
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>
45
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>form_field_attributes</STRONG>  -  color  and attribute control for
52        form fields
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
58        int set_field_fore(FIELD *field, chtype attr);
59        chtype field_fore(const FIELD *field);
60        int set_field_back(FIELD *field, chtype attr);
61        chtype field_back(const FIELD *field);
62        int set_field_pad(FIELD *field, int pad);
63        int field_pad(const FIELD *field);
64
65
66 </PRE>
67 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68        The function <STRONG>set_field_fore</STRONG> sets the foreground  attribute
69        of  <EM>field</EM>. This is the highlight used to display the field
70        contents.  The function <STRONG>field_fore</STRONG> returns the  foreground
71        attribute.  The default is <STRONG>A_STANDOUT</STRONG>.
72
73        The  function <STRONG>set_field_back</STRONG> sets the background attribute
74        of <EM>form</EM>. This is the highlight used to display the  extent
75        fields  in  the form.  The function <STRONG>field_back</STRONG> returns the
76        background attribute.  The default is <STRONG>A_NORMAL</STRONG>.
77
78        The function <STRONG>set_field_pad</STRONG> sets the character used to fill
79        the  field.   The  function  <STRONG>field_pad</STRONG>  returns  the given
80        form's pad character.  The default is a blank.
81
82
83 </PRE>
84 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
85        These routines return one of the following:
86
87        <STRONG>E_OK</STRONG> The routine succeeded.
88
89        <STRONG>E_BAD_ARGUMENT</STRONG>
90             Routine detected an incorrect or  out-of-range  argu-
91             ment.
92
93        <STRONG>E_SYSTEM_ERROR</STRONG>
94             System error occurred (see <STRONG>errno</STRONG>).
95
96
97 </PRE>
98 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
99        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
100        detailed descriptions of the entry points.
101
102
103 </PRE>
104 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
105        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
106        file <STRONG>&lt;curses.h&gt;</STRONG>.
107
108
109 </PRE>
110 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
111        These  routines  emulate the System V forms library.  They
112        were not supported on Version 7 or BSD versions.
113
114
115 </PRE>
116 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
117        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
118        curses by Eric S. Raymond.
119
120
121
122                                               <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
123 </PRE>
124 <div class="nav">
125 <ul>
126 <li><a href="#h2-NAME">NAME</a></li>
127 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
128 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
129 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
130 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
131 <li><a href="#h2-NOTES">NOTES</a></li>
132 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
133 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
134 </ul>
135 </div>
136 </BODY>
137 </HTML>