ncurses 5.3
[ncurses.git] / doc / html / man / form_field_opts.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 Free Software Foundation, Inc.                        *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_field_opts.3x,v 1.7 1998/11/29 01:06:54 Rick.Ohnemus Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_field_opts 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_field_opts 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_field_opts</STRONG> - set and get field options
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
53        int set_field_opts(FIELD *field, OPTIONS opts);
54        int field_opts_on(FIELD *field, OPTIONS opts);
55        int field_opts_off(FIELD *field, OPTIONS opts);
56        OPTIONS field_opts(const FIELD *field);
57
58
59 </PRE>
60 <H2>DESCRIPTION</H2><PRE>
61        The  function  <STRONG>set_field_opts</STRONG>  sets  all the given field's
62        option bits (field  option  bits  may  be  logically-OR'ed
63        together).
64
65        The function <STRONG>field_opts_on</STRONG> turns on the given option bits,
66        and leaves others alone.
67
68        The function <STRONG>field_opts_off</STRONG> turns  off  the  given  option
69        bits, and leaves others alone.
70
71        The function <STRONG>field_opts</STRONG> returns the field's current option
72        bits.
73
74        The following options are defined (all are on by default):
75
76        O_VISIBLE
77             The  field is displayed.  If this option is off, dis-
78             play of the field is suppressed,
79
80        O_ACTIVE
81             The field is  visited  during  processing.   If  this
82             option  is  off,  the  field will not be reachable by
83             navigation keys.  Please  notice  that  an  invisible
84             field appears to be inactive also.
85
86        O_PUBLIC
87             The  field contents are displayed as data is entered.
88
89        O_EDIT
90             The field can be edited.
91
92        O_WRAP
93             Words that don't fit on a line  are  wrapped  to  the
94             next line.  Words are blank-separated.
95
96        O_BLANK
97             The  field is cleared whenever a character is entered
98             at the first position.
99
100        O_AUTOSKIP
101             Skip to the next field when this one fills
102
103
104        O_NULLOK
105             Allow a blank field.
106
107        O_STATIC
108             Field buffers are fixed to field's original size.
109
110        O_PASSOK
111             Validate field only if modified by user.
112
113
114 </PRE>
115 <H2>RETURN VALUE</H2><PRE>
116        Except for <STRONG>field_opts</STRONG>, each routine  returns  one  of  the
117        following:
118
119        <STRONG>E_OK</STRONG> The routine succeeded.
120
121        <STRONG>E_SYSTEM_ERROR</STRONG>
122             System error occurred (see <STRONG>errno</STRONG>).
123
124        <STRONG>E_CURRENT</STRONG>
125             The field is the current field.
126
127
128 </PRE>
129 <H2>SEE ALSO</H2><PRE>
130        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
131
132
133        <STRONG>NOTES</STRONG>  The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the
134               header file <STRONG>&lt;curses.h&gt;</STRONG>.
135
136
137 </PRE>
138 <H2>PORTABILITY</H2><PRE>
139        These routines emulate the System V forms  library.   They
140        were not supported on Version 7 or BSD versions.
141
142
143 </PRE>
144 <H2>AUTHORS</H2><PRE>
145        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
146        curses by Eric S. Raymond.
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166 </PRE>
167 <HR>
168 <ADDRESS>
169 Man(1) output converted with
170 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
171 </ADDRESS>
172 </BODY>
173 </HTML>