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