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.27 2020/10/18 00:11:45 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
  58        <STRONG>int</STRONG> <STRONG>set_field_opts(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  59        <STRONG>Field_Options</STRONG> <STRONG>field_opts(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
  60
  61        <STRONG>int</STRONG> <STRONG>field_opts_on(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  62        <STRONG>int</STRONG> <STRONG>field_opts_off(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  63
  64
  65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  66        The function <STRONG>set_field_opts</STRONG> sets all  the  given  field's  option  bits
  67        (field option bits may be logically-OR'ed together).
  68
  69        The  function  <STRONG>field_opts_on</STRONG> turns on the given option bits, and leaves
  70        others alone.
  71
  72        The function <STRONG>field_opts_off</STRONG> turns off the given option bits, and leaves
  73        others alone.
  74
  75        The function <STRONG>field_opts</STRONG> returns the field's current option bits.
  76
  77        The following standard options are defined (all are on by default):
  78
  79        O_ACTIVE
  80             The  field  is  visited during processing.  If this option is off,
  81             the field will not be reachable by navigation keys.  Please notice
  82             that an invisible field appears to be inactive also.
  83
  84        O_AUTOSKIP
  85             Skip to the next field when this one fills.
  86
  87        O_BLANK
  88             The  field is cleared whenever a character is entered at the first
  89             position.
  90
  91        O_EDIT
  92             The field can be edited.
  93
  94        O_NULLOK
  95             Allow a blank field.
  96
  97        O_PASSOK
  98             Validate field only if modified by user.
  99
 100        O_PUBLIC
 101             The field contents are displayed as data is entered.
 102
 103        O_STATIC
 104             Field buffers are fixed  to  field's  original  size.   Turn  this
 105             option off to create a dynamic field.
 106
 107        O_VISIBLE
 108             The  field  is  displayed.   If this option is off, display of the
 109             field is suppressed.
 110
 111        O_WRAP
 112             Words that do not fit on a line are  wrapped  to  the  next  line.
 113             Words are blank-separated.
 114
 115        These extension options are defined (extensions are off by default):
 116
 117        O_DYNAMIC_JUSTIFY
 118             Permit dynamic fields to be justified, like static fields.
 119
 120        O_NO_LEFT_STRIP
 121             Preserve leading whitespace in the field buffer, which is normally
 122             discarded.
 123
 124        O_EDGE_INSERT_STAY
 125             When  inserting  into  a  field  up  to  the  boundary   position,
 126             optionally   delay  the  scrolling,  so  that  the  last  inserted
 127             character remains visible, but advance the cursor to  reflect  the
 128             insertion.   This  allows the form library to display the inserted
 129             character in one-character fields as well as allowing the  library
 130             to maintain consistent state.
 131
 132        O_INPUT_FIELD
 133             The <STRONG>set_max_field</STRONG> function checks for this extension, which allows
 134             a dynamic field to shrink if the new limit  is  smaller  than  the
 135             current field size.
 136
 137
 138 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 139        Except for <STRONG>field_opts</STRONG>, each routine returns one of the following:
 140
 141        <STRONG>E_OK</STRONG> The routine succeeded.
 142
 143        <STRONG>E_BAD_ARGUMENT</STRONG>
 144             Routine detected an incorrect or out-of-range argument.
 145
 146        <STRONG>E_CURRENT</STRONG>
 147             The field is the current field.
 148
 149        <STRONG>E_SYSTEM_ERROR</STRONG>
 150             System error occurred (see <STRONG>errno(3)</STRONG>).
 151
 152
 153 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 154        <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>.
 155
 156
 157 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 158        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
 159        <STRONG>&lt;curses.h&gt;</STRONG>.
 160
 161
 162 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 163        These routines emulate the System  V  forms  library.   They  were  not
 164        supported on Version 7 or BSD versions.
 165
 166
 167 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 168        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 169        Raymond.
 170
 171
 172
 173                                                            <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
 174 </PRE>
 175 <div class="nav">
 176 <ul>
 177 <li><a href="#h2-NAME">NAME</a></li>
 178 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 179 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 180 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 181 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 182 <li><a href="#h2-NOTES">NOTES</a></li>
 183 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 184 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 185 </ul>
 186 </div>
 187 </BODY>
 188 </HTML>