doc/html/man/form_field_opts.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   5   * Copyright 1998-2014,2015 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.25 2020/02/02 23:34:34 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>form_field_opts 3x</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">form_field_opts 3x</H1>
  44 <PRE>
  45 <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>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_field_opts</STRONG>, <STRONG>field_opts_on</STRONG>, <STRONG>field_opts_off</STRONG>, <STRONG>field_opts</STRONG> - set and get
  52        field options
  53
  54
  55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</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);
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64        The function <STRONG>set_field_opts</STRONG> sets all  the  given  field's  option  bits
  65        (field option bits may be logically-OR'ed together).
  66
  67        The  function  <STRONG>field_opts_on</STRONG> turns on the given option bits, and leaves
  68        others alone.
  69
  70        The function <STRONG>field_opts_off</STRONG> turns off the given option bits, and leaves
  71        others alone.
  72
  73        The function <STRONG>field_opts</STRONG> returns the field's current option bits.
  74
  75        The following standard options are defined (all are on by default):
  76
  77        O_ACTIVE
  78             The  field  is  visited during processing.  If this option is off,
  79             the field will not be reachable by navigation keys.  Please notice
  80             that an invisible field appears to be inactive also.
  81
  82        O_AUTOSKIP
  83             Skip to the next field when this one fills.
  84
  85        O_BLANK
  86             The  field is cleared whenever a character is entered at the first
  87             position.
  88
  89        O_EDIT
  90             The field can be edited.
  91
  92        O_NULLOK
  93             Allow a blank field.
  94
  95        O_PASSOK
  96             Validate field only if modified by user.
  97
  98        O_PUBLIC
  99             The field contents are displayed as data is entered.
 100
 101        O_STATIC
 102             Field buffers are fixed  to  field's  original  size.   Turn  this
 103             option off to create a dynamic field.
 104
 105        O_VISIBLE
 106             The  field  is  displayed.   If this option is off, display of the
 107             field is suppressed.
 108
 109        O_WRAP
 110             Words that do not fit on a line are  wrapped  to  the  next  line.
 111             Words are blank-separated.
 112
 113        These extension options are defined (extensions are off by default):
 114
 115        O_DYNAMIC_JUSTIFY
 116             Permit dynamic fields to be justified, like static fields.
 117
 118        O_NO_LEFT_STRIP
 119             Preserve leading whitespace in the field buffer, which is normally
 120             discarded.
 121
 122        O_EDGE_INSERT_STAY
 123             When inserting into a field up to the boundary  position,  option-
 124             ally  delay  the  scrolling,  so  that the last inserted character
 125             remains visible, but advance the cursor to reflect the  insertion.
 126             This  allows the form library to display the inserted character in
 127             one-character fields as well as allowing the library  to  maintain
 128             consistent state.
 129
 130        O_INPUT_FIELD
 131             The <STRONG>set_max_field</STRONG> function checks for this extension, which allows
 132             a dynamic field to shrink if the new limit  is  smaller  than  the
 133             current field size.
 134
 135
 136 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 137        Except for <STRONG>field_opts</STRONG>, each routine returns one of the following:
 138
 139        <STRONG>E_OK</STRONG> The routine succeeded.
 140
 141        <STRONG>E_BAD_ARGUMENT</STRONG>
 142             Routine detected an incorrect or out-of-range argument.
 143
 144        <STRONG>E_CURRENT</STRONG>
 145             The field is the current field.
 146
 147        <STRONG>E_SYSTEM_ERROR</STRONG>
 148             System error occurred (see <STRONG>errno(3)</STRONG>).
 149
 150
 151 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 152        <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>.
 153
 154
 155 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 156        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
 157        <STRONG>&lt;curses.h&gt;</STRONG>.
 158
 159
 160 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 161        These routines emulate the System V forms library.  They were not  sup-
 162        ported on Version 7 or BSD versions.
 163
 164
 165 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 166        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 167        Raymond.
 168
 169
 170
 171                                                            <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
 172 </PRE>
 173 <div class="nav">
 174 <ul>
 175 <li><a href="#h2-NAME">NAME</a></li>
 176 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 177 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 178 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 179 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 180 <li><a href="#h2-NOTES">NOTES</a></li>
 181 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 182 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 183 </ul>
 184 </div>
 185 </BODY>
 186 </HTML>