ncurses 5.3
[ncurses.git] / doc / html / man / form_opts.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 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.6 1998/11/29 01:07:53 Rick.Ohnemus Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_opts 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_opts 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_opts</STRONG> - set and get form options
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
53        int set_form_opts(FORM *form, OPTIONS opts);
54        int form_opts_on(FORM *form, OPTIONS opts);
55        int form_opts_off(FORM *form, OPTIONS opts);
56        OPTIONS form_opts(const FORM *form);
57
58
59 </PRE>
60 <H2>DESCRIPTION</H2><PRE>
61        The  function  <STRONG>set_form_opts</STRONG>  sets  all  the  given form's
62        option bits  (form  option  bits  may  be  logically-OR'ed
63        together).
64
65        The  function <STRONG>form_opts_on</STRONG> turns on the given option bits,
66        and leaves others alone.
67
68        The function <STRONG>form_opts_off</STRONG>  turns  off  the  given  option
69        bits, and leaves others alone.
70
71        The  function  <STRONG>form_opts</STRONG> returns the form's current option
72        bits.
73
74        The following options are defined (all are on by default):
75
76        O_NL_OVERLOAD
77             Overload  the  <STRONG>REQ_NEW_LINE</STRONG>  forms  driver request so
78             that calling it at the end of a  field  goes  to  the
79             next field.
80
81        O_BS_OVERLOAD
82             Overload  the  <STRONG>REQ_DEL_PREV</STRONG>  forms  driver request so
83             that calling it at the beginning of a field  goes  to
84             the previous field.
85
86
87 </PRE>
88 <H2>RETURN VALUE</H2><PRE>
89        Except for <STRONG>form_opts</STRONG>, each routine returns one of the fol-
90        lowing:
91
92        <STRONG>E_OK</STRONG> The routine succeeded.
93
94        <STRONG>E_SYSTEM_ERROR</STRONG>
95             System error occurred (see <STRONG>errno</STRONG>).
96
97
98 </PRE>
99 <H2>SEE ALSO</H2><PRE>
100        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
101
102
103 </PRE>
104 <H2>NOTES</H2><PRE>
105        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
106        file <STRONG>&lt;curses.h&gt;</STRONG>.
107
108
109 </PRE>
110 <H2>PORTABILITY</H2><PRE>
111        These  routines  emulate the System V forms library.  They
112        were not supported on Version 7 or BSD versions.
113
114
115 </PRE>
116 <H2>AUTHORS</H2><PRE>
117        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
118        curses by Eric S. Raymond.
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>