2 .\"***************************************************************************
3 .\" Copyright (c) 1998 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: form_opts.3x,v 1.6 1998/11/29 01:07:53 Rick.Ohnemus Exp $
31 .\" $DragonFly: src/lib/libncurses/man/form_opts.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
34 \fBform_opts\fR - set and get form options
36 \fB#include <form.h>\fR
38 int set_form_opts(FORM *form, OPTIONS opts);
40 int form_opts_on(FORM *form, OPTIONS opts);
42 int form_opts_off(FORM *form, OPTIONS opts);
44 OPTIONS form_opts(const FORM *form);
47 The function \fBset_form_opts\fR sets all the given form's option bits (form
48 option bits may be logically-OR'ed together).
50 The function \fBform_opts_on\fR turns on the given option bits, and leaves
53 The function \fBform_opts_off\fR turns off the given option bits, and leaves
56 The function \fBform_opts\fR returns the form's current option bits.
58 The following options are defined (all are on by default):
61 Overload the \fBREQ_NEW_LINE\fR forms driver request so that calling it at the
62 end of a field goes to the next field.
65 Overload the \fBREQ_DEL_PREV\fR forms driver request so that calling it at the
66 beginning of a field goes to the previous field.
68 Except for \fBform_opts\fR, each routine returns one of the following:
71 The routine succeeded.
74 System error occurred (see \fBerrno\fR).
76 \fBcurses\fR(3X), \fBform\fR(3X).
78 The header file \fB<form.h>\fR automatically includes the header file
81 These routines emulate the System V forms library. They were not supported on
82 Version 7 or BSD versions.
84 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
87 .\"# The following sets edit modes for GNU EMACS