ncurses 4.1
[ncurses.git] / man / form_field_attributes.3x
1 '\" t
2 .TH form_field_attributes 3X ""
3 .SH NAME
4 \fBform_field_attributes\fR - color and attribute control for form fields
5 .SH SYNOPSIS
6 \fB#include <form.h>\fR
7 .br
8 int set_field_fore(FIELD *field, chtype attr);
9 .br
10 chtype field_fore(const FIELD *field);
11 .br
12 int set_field_back(FIELD *field, chtype attr);
13 .br
14 chtype field_back(const FIELD *field);
15 .br
16 int set_field_pad(FIELD *field, int pad);
17 .br
18 chtype field_pad(const FIELD *field);
19 .br
20 .SH DESCRIPTION
21 The function \fBset_field_fore\fR sets the foreground attribute of
22 \fIfield\fR. This is the highlight used to display the field contents.  The
23 function \fBfield_fore\fR returns the foreground attribute.  The default is
24 \fBA_STANDOUT\fR.
25
26 The function \fBset_field_back\fR sets the background attribute of
27 \fIform\fR. This is the highlight used to display the extent fields in the
28 form.  The function \fBfield_back\fR returns the background attribute.  The
29 default is \fBA_NORMAL\fR.
30
31 The function \fBset_field_pad\fR sets the character used to fill the field.
32 The function \fBfield_pad\fR returns the given form's pad character.  The
33 default is a blank.
34 .SH RETURN VALUE
35 These routines return one of the following:
36 .TP 5
37 \fBE_OK\fR
38 The routine succeeded.
39 .TP 5
40 \fBE_SYSTEM_ERROR\fR
41 System error occurred (see \fBerrno\fR).
42 .TP 5
43 \fBE_BAD_ARGUMENT\fR
44 Routine detected an incorrect or out-of-range argument.
45 .SH SEE ALSO
46 \fBcurses\fR(3X) and 3X pages whose names begin "form_" for detailed
47 descriptions of the entry points.
48 .SH NOTES
49 The header file \fB<form.h>\fR automatically includes the header file
50 \fB<curses.h>\fR.
51 .SH PORTABILITY
52 These routines emulate the System V forms library.  They were not supported on
53 Version 7 or BSD versions.
54 .SH AUTHORS
55 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
56 S. Raymond.
57 .\"#
58 .\"# The following sets edit modes for GNU EMACS
59 .\"# Local Variables:
60 .\"# mode:nroff
61 .\"# fill-column:79
62 .\"# End: