Debian Codegraph @

upstream/debian-unstable/man3/field_attributes.3form

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