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