3 ****************************************************************************
4 * Copyright (c) 1998-2015,2018 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.22 2018/07/28 21:18:11 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 https://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>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>set_field_opts</STRONG>, <STRONG>field_opts_on</STRONG>, <STRONG>field_opts_off</STRONG>, <STRONG>field_opts</STRONG> - set and get
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
56 int set_field_opts(FIELD *field, Field_Options opts);
57 int field_opts_on(FIELD *field, Field_Options opts);
58 int field_opts_off(FIELD *field, Field_Options opts);
59 Field_Options field_opts(const FIELD *field);
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63 The function <STRONG>set_field_opts</STRONG> sets all the given field's option bits
64 (field option bits may be logically-OR'ed together).
66 The function <STRONG>field_opts_on</STRONG> turns on the given option bits, and leaves
69 The function <STRONG>field_opts_off</STRONG> turns off the given option bits, and leaves
72 The function <STRONG>field_opts</STRONG> returns the field's current option bits.
74 The following standard options are defined (all are on by default):
77 The field is visited during processing. If this option is off,
78 the field will not be reachable by navigation keys. Please notice
79 that an invisible field appears to be inactive also.
82 Skip to the next field when this one fills.
85 The field is cleared whenever a character is entered at the first
89 The field can be edited.
95 Validate field only if modified by user.
98 The field contents are displayed as data is entered.
101 Field buffers are fixed to field's original size. Turn this
102 option off to create a dynamic field.
105 The field is displayed. If this option is off, display of the
109 Words that do not fit on a line are wrapped to the next line.
110 Words are blank-separated.
112 These extension options are defined (extensions are off by default):
115 Permit dynamic fields to be justified, like static fields.
118 Preserve leading whitespace in the field buffer, which is normally
122 When inserting into a field up to the boundary position, option-
123 ally delay the scrolling, so that the last inserted character
124 remains visible, but advance the cursor to reflect the insertion.
125 This allows the form library to display the inserted character in
126 one-character fields as well as allowing the library to maintain
130 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
131 Except for <STRONG>field_opts</STRONG>, each routine returns one of the following:
133 <STRONG>E_OK</STRONG> The routine succeeded.
135 <STRONG>E_BAD_ARGUMENT</STRONG>
136 Routine detected an incorrect or out-of-range argument.
138 <STRONG>E_CURRENT</STRONG>
139 The field is the current field.
141 <STRONG>E_SYSTEM_ERROR</STRONG>
142 System error occurred (see <STRONG>errno</STRONG>).
145 </PRE><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>.
149 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
150 The header file <STRONG><form.h></STRONG> automatically includes the header file
151 <STRONG><curses.h></STRONG>.
154 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
155 These routines emulate the System V forms library. They were not sup-
156 ported on Version 7 or BSD versions.
159 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
160 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
165 <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
169 <li><a href="#h2-NAME">NAME</a></li>
170 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
171 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
172 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
173 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
174 <li><a href="#h2-NOTES">NOTES</a></li>
175 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
176 <li><a href="#h2-AUTHORS">AUTHORS</a></li>