ncurses 6.2 - patch 20201212
[ncurses.git] / man / form_field_attributes.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 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 .\"
31 .\" $Id: form_field_attributes.3x,v 1.18 2020/10/18 00:14:20 tom Exp $
32 .TH form_field_attributes 3X ""
33 .ie \n(.g .ds `` \(lq
34 .el       .ds `` ``
35 .ie \n(.g .ds '' \(rq
36 .el       .ds '' ''
37 .SH NAME
38 \fBform_field_attributes\fR \- color and attribute control for form fields
39 .SH SYNOPSIS
40 \fB#include <form.h>\fR
41 .sp
42 \fBint set_field_fore(FIELD *\fP\fIfield\fP\fB, chtype \fP\fIattr\fP\fB);\fP
43 .br
44 \fBchtype field_fore(const FIELD *\fP\fIfield\fP\fB);\fP
45 .sp
46 \fBint set_field_back(FIELD *\fP\fIfield\fP\fB, chtype \fP\fIattr\fP\fB);\fP
47 .br
48 \fBchtype field_back(const FIELD *\fP\fIfield\fP\fB);\fP
49 .sp
50 \fBint set_field_pad(FIELD *\fP\fIfield\fP\fB, int \fP\fIpad\fP\fB);\fP
51 .br
52 \fBint field_pad(const FIELD *\fP\fIfield\fP\fB);\fP
53 .br
54 .SH DESCRIPTION
55 The function \fBset_field_fore\fR sets the foreground attribute of
56 \fIfield\fR. This is the highlight used to display the field contents.  The
57 function \fBfield_fore\fR returns the foreground attribute.
58 The default is
59 \fBA_STANDOUT\fR.
60 .PP
61 The function \fBset_field_back\fR sets the background attribute of
62 \fIform\fR. This is the highlight used to display the extent fields in the
63 form.
64 The function \fBfield_back\fR returns the background attribute.
65 The
66 default is \fBA_NORMAL\fR.
67 .PP
68 The function \fBset_field_pad\fR sets the character used to fill the field.
69 The function \fBfield_pad\fR returns the given form's pad character.
70 The
71 default is a blank.
72 .SH RETURN VALUE
73 These routines return one of the following:
74 .TP 5
75 .B E_OK
76 The routine succeeded.
77 .TP 5
78 .B E_BAD_ARGUMENT
79 Routine detected an incorrect or out-of-range argument.
80 .TP 5
81 .B E_SYSTEM_ERROR
82 System error occurred (see \fBerrno\fR(3)).
83 .
84 .SH SEE ALSO
85 \fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed
86 descriptions of the entry points.
87 .SH NOTES
88 The header file \fB<form.h>\fR automatically includes the header file
89 \fB<curses.h>\fR.
90 .SH PORTABILITY
91 These routines emulate the System V forms library.
92 They were not supported on
93 Version 7 or BSD versions.
94 .SH AUTHORS
95 Juergen Pfeifer.
96 Manual pages and adaptation for new curses by Eric S. Raymond.