diff options
Diffstat (limited to 'doc/html/man/form_field_opts.3x.html')
| -rw-r--r-- | doc/html/man/form_field_opts.3x.html | 145 |
1 files changed, 79 insertions, 66 deletions
diff --git a/doc/html/man/form_field_opts.3x.html b/doc/html/man/form_field_opts.3x.html index b515c46..d370db1 100644 --- a/doc/html/man/form_field_opts.3x.html +++ b/doc/html/man/form_field_opts.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2010,2014 Free Software Foundation, Inc. * + * 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 * @@ -28,31 +28,31 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: form_field_opts.3x,v 1.17 2014/07/26 21:21:57 tom Exp @ + * @Id: form_field_opts.3x,v 1.25 2020/02/02 23:34:34 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 rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>form_field_opts 3x</H1> -<HR> +<H1 class="no-header">form_field_opts 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<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> +<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> -</PRE> -<H2>NAME</H2><PRE> - <STRONG>form_field_opts</STRONG> - set and get field options +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + <STRONG>set_field_opts</STRONG>, <STRONG>field_opts_on</STRONG>, <STRONG>field_opts_off</STRONG>, <STRONG>field_opts</STRONG> - set and get + field options -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><form.h></STRONG> int set_field_opts(FIELD *field, Field_Options opts); int field_opts_on(FIELD *field, Field_Options opts); @@ -60,36 +60,31 @@ Field_Options field_opts(const FIELD *field); -</PRE> -<H2>DESCRIPTION</H2><PRE> - The function <STRONG>set_field_opts</STRONG> sets all the given field's - option bits (field option bits may be logically-OR'ed - together). +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + The function <STRONG>set_field_opts</STRONG> sets all the given field's option bits + (field option bits may be logically-OR'ed together). - The function <STRONG>field_opts_on</STRONG> turns on the given option bits, - and leaves others alone. + The function <STRONG>field_opts_on</STRONG> turns on the given option bits, and leaves + others alone. - The function <STRONG>field_opts_off</STRONG> turns off the given option - bits, and leaves others alone. + The function <STRONG>field_opts_off</STRONG> turns off the given option bits, and leaves + others alone. - The function <STRONG>field_opts</STRONG> returns the field's current option - bits. + The function <STRONG>field_opts</STRONG> returns the field's current option bits. - The following standard options are defined (all are on by - default): + The following standard options are defined (all are on by default): 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 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. O_BLANK - The field is cleared whenever a character is entered - at the first position. + The field is cleared whenever a character is entered at the first + position. O_EDIT The field can be edited. @@ -104,70 +99,88 @@ The field contents are displayed as data is entered. O_STATIC - Field buffers are fixed to field's original size. - Turn this option off to create a dynamic field. + Field buffers are fixed to field's original size. Turn this + option off to create a dynamic field. O_VISIBLE - The field is displayed. If this option is off, dis- - play of the field is suppressed. + 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. + Words that do not fit on a line are wrapped to the next line. + Words are blank-separated. - One extension option is defined (extensions are off by - default): + These extension options are defined (extensions are off by default): O_DYNAMIC_JUSTIFY - Permit dynamic fields to be justified, like static - fields. + Permit dynamic fields to be justified, like static fields. + O_NO_LEFT_STRIP + Preserve leading whitespace in the field buffer, which is normally + discarded. -</PRE> -<H2>RETURN VALUE</H2><PRE> - Except for <STRONG>field_opts</STRONG>, each routine returns one of the - following: + O_EDGE_INSERT_STAY + When inserting into a field up to the boundary position, option- + ally 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 <STRONG>set_max_field</STRONG> 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 <STRONG>field_opts</STRONG>, each routine returns one of the following: <STRONG>E_OK</STRONG> The routine succeeded. <STRONG>E_BAD_ARGUMENT</STRONG> - Routine detected an incorrect or out-of-range argu- - ment. + Routine detected an incorrect or out-of-range argument. <STRONG>E_CURRENT</STRONG> The field is the current field. <STRONG>E_SYSTEM_ERROR</STRONG> - System error occurred (see <STRONG>errno</STRONG>). + System error occurred (see <STRONG>errno(3)</STRONG>). -</PRE> -<H2>SEE ALSO</H2><PRE> +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> <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>. -</PRE> -<H2>NOTES</H2><PRE> - The header file <STRONG><form.h></STRONG> automatically includes the header - file <STRONG><curses.h></STRONG>. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header file + <STRONG><curses.h></STRONG>. -</PRE> -<H2>PORTABILITY</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-PORTABILITY">PORTABILITY</a></H2><PRE> + These routines emulate the System V forms library. They were not sup- + ported on Version 7 or BSD versions. -</PRE> -<H2>AUTHORS</H2><PRE> - Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. - <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> </PRE> -<HR> -Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> +<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> |