3 ****************************************************************************
4 * Copyright (c) 1998-2010,2014 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: form_field_opts.3x,v 1.17 2014/07/26 21:21:57 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_field_opts 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">form_field_opts 3x</H1>
44 <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>form_field_opts</STRONG> - set and get field options
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
57 int set_field_opts(FIELD *field, Field_Options opts);
58 int field_opts_on(FIELD *field, Field_Options opts);
59 int field_opts_off(FIELD *field, Field_Options opts);
60 Field_Options field_opts(const FIELD *field);
64 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65 The function <STRONG>set_field_opts</STRONG> sets all the given field's
66 option bits (field option bits may be logically-OR'ed
69 The function <STRONG>field_opts_on</STRONG> turns on the given option bits,
70 and leaves others alone.
72 The function <STRONG>field_opts_off</STRONG> turns off the given option
73 bits, and leaves others alone.
75 The function <STRONG>field_opts</STRONG> returns the field's current option
78 The following standard options are defined (all are on by
82 The field is visited during processing. If this
83 option is off, the field will not be reachable by
84 navigation keys. Please notice that an invisible
85 field appears to be inactive also.
88 Skip to the next field when this one fills.
91 The field is cleared whenever a character is entered
92 at the first position.
95 The field can be edited.
101 Validate field only if modified by user.
104 The field contents are displayed as data is entered.
107 Field buffers are fixed to field's original size.
108 Turn this option off to create a dynamic field.
111 The field is displayed. If this option is off, dis-
112 play of the field is suppressed.
115 Words that do not fit on a line are wrapped to the
116 next line. Words are blank-separated.
118 One extension option is defined (extensions are off by
122 Permit dynamic fields to be justified, like static
127 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
128 Except for <STRONG>field_opts</STRONG>, each routine returns one of the
131 <STRONG>E_OK</STRONG> The routine succeeded.
133 <STRONG>E_BAD_ARGUMENT</STRONG>
134 Routine detected an incorrect or out-of-range argu-
137 <STRONG>E_CURRENT</STRONG>
138 The field is the current field.
140 <STRONG>E_SYSTEM_ERROR</STRONG>
141 System error occurred (see <STRONG>errno</STRONG>).
145 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
146 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>.
150 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
151 The header file <STRONG><form.h></STRONG> automatically includes the header
152 file <STRONG><curses.h></STRONG>.
156 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
157 These routines emulate the System V forms library. They
158 were not supported on Version 7 or BSD versions.
162 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
163 Juergen Pfeifer. Manual pages and adaptation for new
164 curses by Eric S. Raymond.
168 <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
172 <li><a href="#h2-NAME">NAME</a></li>
173 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
174 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
175 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
176 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
177 <li><a href="#h2-NOTES">NOTES</a></li>
178 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
179 <li><a href="#h2-AUTHORS">AUTHORS</a></li>