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