blob: 53869a51c58d79b4f91044676c3914db86fc2557 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2<!--
3 * t
4 ****************************************************************************
5 * Copyright (c) 1998-2006,2007 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.9 2007/02/24 17:34:36 tom 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<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>NAME</H2><PRE>
51 <STRONG>form_opts</STRONG> - set and get form options
52
53
54</PRE>
55<H2>SYNOPSIS</H2><PRE>
56 <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57 int set_form_opts(FORM *form, Field_Options opts);
58 int form_opts_on(FORM *form, Field_Options opts);
59 int form_opts_off(FORM *form, Field_Options opts);
60 Field_Options form_opts(const FORM *form);
61
62
63</PRE>
64<H2>DESCRIPTION</H2><PRE>
65 The function <STRONG>set_form_opts</STRONG> sets all the given form's
66 option bits (form option bits may be logically-OR'ed
67 together).
68
69 The function <STRONG>form_opts_on</STRONG> turns on the given option bits,
70 and leaves others alone.
71
72 The function <STRONG>form_opts_off</STRONG> turns off the given option
73 bits, and leaves others alone.
74
75 The function <STRONG>form_opts</STRONG> returns the form's current option
76 bits.
77
78 The following options are defined (all are on by default):
79
80 O_NL_OVERLOAD
81 Overload the <STRONG>REQ_NEW_LINE</STRONG> forms driver request so
82 that calling it at the end of a field goes to the
83 next field.
84
85 O_BS_OVERLOAD
86 Overload the <STRONG>REQ_DEL_PREV</STRONG> forms driver request so
87 that calling it at the beginning of a field goes to
88 the previous field.
89
90
91</PRE>
92<H2>RETURN VALUE</H2><PRE>
93 Except for <STRONG>form_opts</STRONG>, each routine returns one of the fol-
94 lowing:
95
96 <STRONG>E_OK</STRONG> The routine succeeded.
97
98 <STRONG>E_SYSTEM_ERROR</STRONG>
99 System error occurred (see <STRONG>errno</STRONG>).
100
101
102</PRE>
103<H2>SEE ALSO</H2><PRE>
104 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
105
106
107</PRE>
108<H2>NOTES</H2><PRE>
109 The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
110 file <STRONG>&lt;curses.h&gt;</STRONG>.
111
112
113</PRE>
114<H2>PORTABILITY</H2><PRE>
115 These routines emulate the System V forms library. They
116 were not supported on Version 7 or BSD versions.
117
118
119</PRE>
120<H2>AUTHORS</H2><PRE>
121 Juergen Pfeifer. Manual pages and adaptation for new
122 curses by Eric S. Raymond.
123
124
125
126 <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
127</PRE>
128<HR>
129<ADDRESS>
130Man(1) output converted with
131<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
132</ADDRESS>
133</BODY>
134</HTML>