ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / form_opts.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: form_opts.3x,v 1.12 2015/12/05 23:55:51 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_opts 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_opts 3x</H1>
43 <PRE>
44 <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>                                             <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <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> -
52        set and get form options
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
58        int set_form_opts(FORM *form, Field_Options opts);
59        int form_opts_on(FORM *form, Field_Options opts);
60        int form_opts_off(FORM *form, Field_Options opts);
61        Field_Options form_opts(const FORM *form);
62
63
64 </PRE>
65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66        The function  <STRONG>set_form_opts</STRONG>  sets  all  the  given  form's
67        option  bits  (form  option  bits  may  be logically-OR'ed
68        together).
69
70        The function <STRONG>form_opts_on</STRONG> turns on the given option  bits,
71        and leaves others alone.
72
73        The  function  <STRONG>form_opts_off</STRONG>  turns  off  the given option
74        bits, and leaves others alone.
75
76        The function <STRONG>form_opts</STRONG> returns the form's  current  option
77        bits.
78
79        The following options are defined (all are on by default):
80
81        O_NL_OVERLOAD
82             Overload  the  <STRONG>REQ_NEW_LINE</STRONG>  forms  driver request so
83             that calling it at the end of a  field  goes  to  the
84             next field.
85
86        O_BS_OVERLOAD
87             Overload  the  <STRONG>REQ_DEL_PREV</STRONG>  forms  driver request so
88             that calling it at the beginning of a field  goes  to
89             the previous field.
90
91
92 </PRE>
93 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
94        Except for <STRONG>form_opts</STRONG>, each routine returns one of the fol-
95        lowing:
96
97        <STRONG>E_OK</STRONG> The routine succeeded.
98
99        <STRONG>E_SYSTEM_ERROR</STRONG>
100             System error occurred (see <STRONG>errno</STRONG>).
101
102
103 </PRE>
104 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
105        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
106
107
108 </PRE>
109 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
110        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
111        file <STRONG>&lt;curses.h&gt;</STRONG>.
112
113
114 </PRE>
115 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
116        These  routines  emulate the System V forms library.  They
117        were not supported on Version 7 or BSD versions.
118
119
120 </PRE>
121 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
122        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
123        curses by Eric S. Raymond.
124
125
126
127                                                           <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
128 </PRE>
129 <div class="nav">
130 <ul>
131 <li><a href="#h2-NAME">NAME</a></li>
132 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
133 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
134 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
135 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
136 <li><a href="#h2-NOTES">NOTES</a></li>
137 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
138 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
139 </ul>
140 </div>
141 </BODY>
142 </HTML>