ncurses 4.1
[ncurses.git] / Ada95 / html / form_field_opts.3x.html
1 <HTML>
2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
3 <PRE>
4        <STRONG>form_field_opts</STRONG> - set and get field options
5
6
7 </PRE>
8 <H2>SYNOPSIS</H2><PRE>
9        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
10        int set_field_opts(FIELD *field, OPTIONS opts);
11        int field_opts_on(FIELD *field, OPTIONS opts);
12        int field_opts_off(FIELD *field, OPTIONS opts);
13        OPTIONS field_opts(const FIELD *field);
14
15
16 </PRE>
17 <H2>DESCRIPTION</H2><PRE>
18        The  function  <STRONG>set_field_opts</STRONG>  sets  all the given field's
19        option bits (field  option  bits  may  be  logically-OR'ed
20        together).
21
22        The function <STRONG>field_opts_on</STRONG> turns on the given option bits,
23        and leaves others alone.
24
25        The function <STRONG>field_opts_off</STRONG> turns  off  the  given  option
26        bits, and leaves others alone.
27
28        The function <STRONG>field_opts</STRONG> returns the field's current option
29        bits.
30
31        The following options are defined (all are on by default):
32
33        O_VISIBLE
34             The  field is displayed.  If this option is off, dis-
35             play of the field is suppressed,
36
37        O_ACTIVE
38             The field is  visited  during  processing.   If  this
39             option  is  off,  the  field will not be reachable by
40             navigation keys.
41
42        O_PUBLIC
43             The field contents are displayed as data is  entered.
44
45        O_EDIT
46             The field can be edited.
47
48        O_WRAP
49             Words  that  don't  fit  on a line are wrapped to the
50             next line.  Words are blank-separated.
51
52        O_BLANK
53             The field is cleared whenever a character is  entered
54             at the first position.
55
56        O_AUTOSKIP
57             Skip to the next field when this one fills
58
59        O_NULLOK
60             Field buffers are fixed to field's original size.
61
62        O_PASSOK
63             Validate field only if modified by user.
64
65
66 </PRE>
67 <H2>RETURN VALUE</H2><PRE>
68        Except  for  <STRONG>field_opts</STRONG>,  each  routine returns one of the
69        following:
70
71        <STRONG>E_OK</STRONG> The routine succeeded.
72
73        <STRONG>E_SYSTEM_ERROR</STRONG>
74             System error occurred (see <STRONG>errno</STRONG>).
75
76        <STRONG>E_CURRENT</STRONG>
77             The field is the current field.
78
79
80 </PRE>
81 <H2>SEE ALSO</H2><PRE>
82        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
83
84
85        <STRONG>NOTES</STRONG>  The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the
86               header file <STRONG>&lt;curses.h&gt;</STRONG>.
87
88
89 </PRE>
90 <H2>PORTABILITY</H2><PRE>
91        These  routines  emulate the System V forms library.  They
92        were not supported on Version 7 or BSD versions.
93
94
95 </PRE>
96 <H2>AUTHORS</H2><PRE>
97        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
98        curses by Eric S. Raymond.
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120 </PRE>
121 </BODY>
122 </HTML>