ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / form_field_attributes.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2006,2010 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.16 2020/02/02 23:34:34 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_field_attributes 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_field_attributes 3x</H1>
44 <PRE>
45 <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>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>form_field_attributes</STRONG> - color and attribute control for 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 of <EM>field</EM>.
66        This is the highlight used to display the field contents.  The function
67        <STRONG>field_fore</STRONG>  returns  the foreground attribute.  The default is <STRONG>A_STAND-</STRONG>
68        <STRONG>OUT</STRONG>.
69
70        The function <STRONG>set_field_back</STRONG> sets the background attribute of <EM>form</EM>. This
71        is  the  highlight  used to display the extent fields in the form.  The
72        function <STRONG>field_back</STRONG> returns the background attribute.  The  default  is
73        <STRONG>A_NORMAL</STRONG>.
74
75        The  function  <STRONG>set_field_pad</STRONG> sets the character used to fill the field.
76        The function <STRONG>field_pad</STRONG> returns the given  form's  pad  character.   The
77        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 argument.
87
88        <STRONG>E_SYSTEM_ERROR</STRONG>
89             System error occurred (see <STRONG>errno(3)</STRONG>).
90
91
92 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
93        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>  and  related  pages  whose names begin "form_" for detailed
94        descriptions of the entry points.
95
96
97 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
98        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
99        <STRONG>&lt;curses.h&gt;</STRONG>.
100
101
102 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
103        These  routines emulate the System V forms library.  They were not sup-
104        ported on Version 7 or BSD versions.
105
106
107 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
108        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
109        Raymond.
110
111
112
113                                                      <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
114 </PRE>
115 <div class="nav">
116 <ul>
117 <li><a href="#h2-NAME">NAME</a></li>
118 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
119 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
120 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
121 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
122 <li><a href="#h2-NOTES">NOTES</a></li>
123 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
124 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
125 </ul>
126 </div>
127 </BODY>
128 </HTML>