ncurses 5.0
[ncurses.git] / Ada95 / html / man / form_field_attributes.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4        <STRONG>form_field_attributes</STRONG>  -  color  and attribute control for
5        form fields
6
7
8 </PRE>
9 <H2>SYNOPSIS</H2><PRE>
10        <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
11        int set_field_fore(FIELD *field, chtype attr);
12        chtype field_fore(const FIELD *field);
13        int set_field_back(FIELD *field, chtype attr);
14        chtype field_back(const FIELD *field);
15        int set_field_pad(FIELD *field, int pad);
16        chtype field_pad(const FIELD *field);
17
18
19 </PRE>
20 <H2>DESCRIPTION</H2><PRE>
21        The function <STRONG>set_field_fore</STRONG> sets the foreground  attribute
22        of  <EM>field</EM>. This is the highlight used to display the field
23        contents.  The function <STRONG>field_fore</STRONG> returns the  foreground
24        attribute.  The default is <STRONG>A_STANDOUT</STRONG>.
25
26        The  function <STRONG>set_field_back</STRONG> sets the background attribute
27        of <EM>form</EM>. This is the highlight used to display the  extent
28        fields  in  the form.  The function <STRONG>field_back</STRONG> returns the
29        background attribute.  The default is <STRONG>A_NORMAL</STRONG>.
30
31        The function <STRONG>set_field_pad</STRONG> sets the character used to fill
32        the  field.   The  function  <STRONG>field_pad</STRONG>  returns  the given
33        form's pad character.  The default is a blank.
34
35
36 </PRE>
37 <H2>RETURN VALUE</H2><PRE>
38        These routines return one of the following:
39
40        <STRONG>E_OK</STRONG> The routine succeeded.
41
42        <STRONG>E_SYSTEM_ERROR</STRONG>
43             System error occurred (see <STRONG>errno</STRONG>).
44
45        <STRONG>E_BAD_ARGUMENT</STRONG>
46             Routine detected an incorrect or  out-of-range  argu-
47             ment.
48
49
50 </PRE>
51 <H2>SEE ALSO</H2><PRE>
52        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>  and  3X  pages  whose  names begin "form_" for
53        detailed descriptions of the entry points.
54
55
56 </PRE>
57 <H2>NOTES</H2><PRE>
58        The header file <STRONG><form.h></STRONG> automatically includes the header
59        file <STRONG><curses.h></STRONG>.
60
61
62 </PRE>
63 <H2>PORTABILITY</H2><PRE>
64        These  routines  emulate the System V forms library.  They
65        were not supported on Version 7 or BSD versions.
66
67
68 </PRE>
69 <H2>AUTHORS</H2><PRE>
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122 </PRE>
123 </BODY>
124 </HTML>