ncurses 6.1 - patch 20190216
[ncurses.git] / man / form_field_attributes.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_field_attributes.3x,v 1.14 2019/01/20 20:31:42 tom Exp $
31 .TH form_field_attributes 3X ""
32 .SH NAME
33 \fBform_field_attributes\fR \- color and attribute control for form fields
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 int set_field_fore(FIELD *field, chtype attr);
38 .br
39 chtype field_fore(const FIELD *field);
40 .br
41 int set_field_back(FIELD *field, chtype attr);
42 .br
43 chtype field_back(const FIELD *field);
44 .br
45 int set_field_pad(FIELD *field, int pad);
46 .br
47 int field_pad(const FIELD *field);
48 .br
49 .SH DESCRIPTION
50 The function \fBset_field_fore\fR sets the foreground attribute of
51 \fIfield\fR. This is the highlight used to display the field contents.  The
52 function \fBfield_fore\fR returns the foreground attribute.
53 The default is
54 \fBA_STANDOUT\fR.
55 .PP
56 The function \fBset_field_back\fR sets the background attribute of
57 \fIform\fR. This is the highlight used to display the extent fields in the
58 form.
59 The function \fBfield_back\fR returns the background attribute.
60 The
61 default is \fBA_NORMAL\fR.
62 .PP
63 The function \fBset_field_pad\fR sets the character used to fill the field.
64 The function \fBfield_pad\fR returns the given form's pad character.
65 The
66 default is a blank.
67 .SH RETURN VALUE
68 These routines return one of the following:
69 .TP 5
70 .B E_OK
71 The routine succeeded.
72 .TP 5
73 .B E_BAD_ARGUMENT
74 Routine detected an incorrect or out-of-range argument.
75 .TP 5
76 .B E_SYSTEM_ERROR
77 System error occurred (see \fBerrno\fR(3)).
78 .
79 .SH SEE ALSO
80 \fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
81 descriptions of the entry points.
82 .SH NOTES
83 The header file \fB<form.h>\fR automatically includes the header file
84 \fB<curses.h>\fR.
85 .SH PORTABILITY
86 These routines emulate the System V forms library.
87 They were not supported on
88 Version 7 or BSD versions.
89 .SH AUTHORS
90 Juergen Pfeifer.
91 Manual pages and adaptation for new curses by Eric S. Raymond.