doc/html/man/form_opts.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   5   * Copyright 1998-2010,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_opts.3x,v 1.17 2020/10/18 00:03:49 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_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_opts 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>                                                    <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_form_opts</STRONG>,  <STRONG>form_opts_on</STRONG>,  <STRONG>form_opts_off</STRONG>,  <STRONG>form_opts</STRONG>  - set and get
  52        form 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_form_opts(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  59        <STRONG>Field_Options</STRONG> <STRONG>form_opts(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
  60
  61        <STRONG>int</STRONG> <STRONG>form_opts_on(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  62        <STRONG>int</STRONG> <STRONG>form_opts_off(FORM</STRONG> <STRONG>*</STRONG><EM>form</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_form_opts</STRONG> sets all the given form's option bits  (form
  67        option bits may be logically-OR'ed together).
  68
  69        The  function  <STRONG>form_opts_on</STRONG>  turns on the given option bits, and leaves
  70        others alone.
  71
  72        The function <STRONG>form_opts_off</STRONG> turns off the given option bits, and  leaves
  73        others alone.
  74
  75        The function <STRONG>form_opts</STRONG> returns the form's current option bits.
  76
  77        The following options are defined (all are on by default):
  78
  79        O_NL_OVERLOAD
  80             Overload  the <STRONG>REQ_NEW_LINE</STRONG> forms driver request so that calling it
  81             at the end of a field goes to the next field.
  82
  83        O_BS_OVERLOAD
  84             Overload the <STRONG>REQ_DEL_PREV</STRONG> forms driver request so that calling  it
  85             at the beginning of a field goes to the previous field.
  86
  87
  88 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  89        Except for <STRONG>form_opts</STRONG>, each routine returns one of the following:
  90
  91        <STRONG>E_OK</STRONG> The routine succeeded.
  92
  93        <STRONG>E_SYSTEM_ERROR</STRONG>
  94             System error occurred (see <STRONG>errno(3)</STRONG>).
  95
  96
  97 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  98        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
  99
 100
 101 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 102        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
 103        <STRONG>&lt;curses.h&gt;</STRONG>.
 104
 105
 106 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 107        These routines emulate the System  V  forms  library.   They  were  not
 108        supported on Version 7 or BSD versions.
 109
 110
 111 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 112        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 113        Raymond.
 114
 115
 116
 117                                                                  <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
 118 </PRE>
 119 <div class="nav">
 120 <ul>
 121 <li><a href="#h2-NAME">NAME</a></li>
 122 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 123 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 124 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 125 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 126 <li><a href="#h2-NOTES">NOTES</a></li>
 127 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 128 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 129 </ul>
 130 </div>
 131 </BODY>
 132 </HTML>