ncurses 5.0
[ncurses.git] / Ada95 / html / man / form_field_opts.3x.html
1 <HTML>
2 <BODY>
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><form.h></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.  Please  notice  that  an  invisible
41             field appears to be inactive also.
42
43        O_PUBLIC
44             The  field contents are displayed as data is entered.
45
46        O_EDIT
47             The field can be edited.
48
49        O_WRAP
50             Words that don't fit on a line  are  wrapped  to  the
51             next line.  Words are blank-separated.
52
53        O_BLANK
54             The  field is cleared whenever a character is entered
55             at the first position.
56
57        O_AUTOSKIP
58             Skip to the next field when this one fills
59
60             Allow a blank field.
61
62        O_STATIC
63             Field buffers are fixed to field's original size.
64
65        O_PASSOK
66             Validate field only if modified by user.
67
68
69 </PRE>
70 <H2>RETURN VALUE</H2><PRE>
71        Except for <STRONG>field_opts</STRONG>, each routine  returns  one  of  the
72        following:
73
74        <STRONG>E_OK</STRONG> The routine succeeded.
75
76        <STRONG>E_SYSTEM_ERROR</STRONG>
77             System error occurred (see <STRONG>errno</STRONG>).
78
79        <STRONG>E_CURRENT</STRONG>
80             The field is the current field.
81
82
83 </PRE>
84 <H2>SEE ALSO</H2><PRE>
85        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
86
87
88        <STRONG>NOTES</STRONG>  The header file <STRONG><form.h></STRONG> automatically includes the
89               header file <STRONG><curses.h></STRONG>.
90
91
92 </PRE>
93 <H2>PORTABILITY</H2><PRE>
94        These routines emulate the System V forms  library.   They
95        were not supported on Version 7 or BSD versions.
96
97
98 </PRE>
99 <H2>AUTHORS</H2><PRE>
100        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
101        curses by Eric S. Raymond.
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120 </PRE>
121 </BODY>
122 </HTML>