1.\"	$NetBSD: form_field_attributes.3,v 1.4 2002/02/20 11:30:58 wiz Exp $
2.\"
3.\" Copyright (c) 2001
4.\"	Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
5.\"
6.\" This code is donated to The NetBSD Foundation by the author.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of the Author may not be used to endorse or promote
17.\"    products derived from this software without specific prior written
18.\"    permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd January 1, 2001
33.Dt FORMS 3
34.Os
35.Sh NAME
36.Nm field_back ,
37.Nm field_fore ,
38.Nm field_pad ,
39.Nm set_field_back ,
40.Nm set_field_fore ,
41.Nm set_field_pad
42.Nd form library
43.Sh LIBRARY
44.Lb libform
45.Sh SYNOPSIS
46.Fd #include \*[Lt]form.h\*[Gt]
47.Ft chtype
48.Fn field_back "FIELD *field"
49.Ft chtype
50.Fn field_fore "FIELD *field"
51.Ft int
52.Fn field_pad "FIELD *field"
53.Ft int
54.Fn set_field_back "FIELD *field, chtype attribute"
55.Ft int
56.Fn set_field_fore "FIELD *field, chtype attribute"
57.Ft int
58.Fn set_field_pad "FIELD *field, int pad"
59.Sh DESCRIPTION
60Calling the function
61.Fn field_back
62will return the character attributes that will be applied to a field
63that is not the current field, these attributes can be set by the
64.Fn set_field_back
65function.  The
66.Fn field_fore
67function returns the character attributes that will be used to
68indicate that a field is the currently active one on the form, this
69attribute may be set by using the
70.Fn set_field_fore
71function.  The
72pad character for a field is the character that will be printed in all
73field locations not occupied with actual field contents.  The pad
74character can be retrieved by calling the
75.Fn field_pad
76function, the pad character is set by using the
77.Fn set_field_pad
78function.
79.Sh RETURN VALUES
80Functions returning pointers will return NULL if an error is detected.
81The functions that return an int will return one of the following error
82values:
83.Pp
84.Bl -tag -width E_UNKNOWN_COMMAND -compact
85.It Er E_OK
86The function was successful.
87.El
88.Sh SEE ALSO
89.Xr curses 3 ,
90.Xr forms 3
91.Sh NOTES
92The header
93.Pa \*[Lt]form.h\*[Gt]
94automatically includes both
95.Pa \*[Lt]curses.h\*[Gt]
96and
97.Pa \*[Lt]eti.h\*[Gt] .
98