+<!--
+ * t
+ ****************************************************************************
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2014,2015 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: form_field_opts.3x,v 1.27 2020/10/18 00:11:45 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>form_field_opts 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1 class="no-header">form_field_opts 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<B><A HREF="form_field_opts.3X.html">form_field_opts(3X)</A></B> <B><A HREF="form_field_opts.3X.html">form_field_opts(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <B>form_field_opts</B> - set and get field options
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><form.h></B>
- int set_field_opts(FIELD *field, OPTIONS opts);
- int field_opts_on(FIELD *field, OPTIONS opts);
- int field_opts_off(FIELD *field, OPTIONS opts);
- OPTIONS field_opts(const FIELD *field);
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>set_field_opts</B>, <B>field_opts_on</B>, <B>field_opts_off</B>, <B>field_opts</B> - set and get
+ field options
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- The function <B>set_field_opts</B> sets all the given field's
- option bits (field option bits may be logically-OR'ed
- together).
- The function <B>field_opts_on</B> turns on the given option bits,
- and leaves others alone.
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+ <B>#include</B> <B><form.h></B>
- The function <B>field_opts_off</B> turns off the given option
- bits, and leaves others alone.
+ <B>int</B> <B>set_field_opts(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>Field_Options</B> <I>opts</I><B>);</B>
+ <B>Field_Options</B> <B>field_opts(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
- The function <B>field_opts</B> returns the field's current option
- bits.
+ <B>int</B> <B>field_opts_on(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>Field_Options</B> <I>opts</I><B>);</B>
+ <B>int</B> <B>field_opts_off(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>Field_Options</B> <I>opts</I><B>);</B>
- The following options are defined (all are on by default):
- O_VISIBLE
- The field is displayed. If this option is off, dis-
- play of the field is suppressed,
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ The function <B>set_field_opts</B> sets all the given field's option bits
+ (field option bits may be logically-OR'ed together).
- O_ACTIVE
- The field is visited during processing. If this
- option is off, the field will not be reachable by
- navigation keys. Please notice that an invisible
- field appears to be inactive also.
+ The function <B>field_opts_on</B> turns on the given option bits, and leaves
+ others alone.
- O_PUBLIC
- The field contents are displayed as data is entered.
+ The function <B>field_opts_off</B> turns off the given option bits, and leaves
+ others alone.
- O_EDIT
- The field can be edited.
+ The function <B>field_opts</B> returns the field's current option bits.
- O_WRAP
- Words that don't fit on a line are wrapped to the
- next line. Words are blank-separated.
+ The following standard options are defined (all are on by default):
- O_BLANK
- The field is cleared whenever a character is entered
- at the first position.
+ O_ACTIVE
+ The field is visited during processing. If this option is off,
+ the field will not be reachable by navigation keys. Please notice
+ that an invisible field appears to be inactive also.
O_AUTOSKIP
- Skip to the next field when this one fills
+ Skip to the next field when this one fills.
+ O_BLANK
+ The field is cleared whenever a character is entered at the first
+ position.
+
+ O_EDIT
+ The field can be edited.
O_NULLOK
Allow a blank field.
- O_STATIC
- Field buffers are fixed to field's original size.
-
O_PASSOK
Validate field only if modified by user.
+ O_PUBLIC
+ The field contents are displayed as data is entered.
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- Except for <B>field_opts</B>, each routine returns one of the
- following:
-
- <B>E_OK</B> The routine succeeded.
-
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno</B>).
-
- <B>E_CURRENT</B>
- The field is the current field.
-
-
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
-
+ O_STATIC
+ Field buffers are fixed to field's original size. Turn this
+ option off to create a dynamic field.
- <B>NOTES</B> The header file <B><form.h></B> automatically includes the
- header file <B><curses.h></B>.
+ O_VISIBLE
+ The field is displayed. If this option is off, display of the
+ field is suppressed.
+ O_WRAP
+ Words that do not fit on a line are wrapped to the next line.
+ Words are blank-separated.
-</PRE>
-<H2>PORTABILITY</H2><PRE>
- These routines emulate the System V forms library. They
- were not supported on Version 7 or BSD versions.
+ These extension options are defined (extensions are off by default):
+ O_DYNAMIC_JUSTIFY
+ Permit dynamic fields to be justified, like static fields.
-</PRE>
-<H2>AUTHORS</H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
- curses by Eric S. Raymond.
+ O_NO_LEFT_STRIP
+ Preserve leading whitespace in the field buffer, which is normally
+ discarded.
+ O_EDGE_INSERT_STAY
+ When inserting into a field up to the boundary position,
+ optionally delay the scrolling, so that the last inserted
+ character remains visible, but advance the cursor to reflect the
+ insertion. This allows the form library to display the inserted
+ character in one-character fields as well as allowing the library
+ to maintain consistent state.
+ O_INPUT_FIELD
+ The <B>set_max_field</B> function checks for this extension, which allows
+ a dynamic field to shrink if the new limit is smaller than the
+ current field size.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Except for <B>field_opts</B>, each routine returns one of the following:
+ <B>E_OK</B> The routine succeeded.
+ <B>E_BAD_ARGUMENT</B>
+ Routine detected an incorrect or out-of-range argument.
+ <B>E_CURRENT</B>
+ The field is the current field.
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno(3)</B>).
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="form.3X.html">form(3X)</A></B>. <B><A HREF="form_field_just.3X.html">form_field_just(3X)</A></B>.
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ The header file <B><form.h></B> automatically includes the header file
+ <B><curses.h></B>.
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ These routines emulate the System V forms library. They were not
+ supported on Version 7 or BSD versions.
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
+ Raymond.
+ <B><A HREF="form_field_opts.3X.html">form_field_opts(3X)</A></B>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
+</ul>
+</div>
</BODY>
</HTML>