ncurses 4.1
[ncurses.git] / man / form_opts.3x
1 '\" t
2 .TH form_opts 3X ""
3 .SH NAME
4 \fBform_opts\fR - set and get form options
5 .SH SYNOPSIS
6 \fB#include <form.h>\fR
7 .br
8 int set_form_opts(FORM *form, OPTIONS opts);
9 .br
10 int form_opts_on(FORM *form, OPTIONS opts);
11 .br
12 int form_opts_off(FORM *form, OPTIONS opts);
13 .br
14 OPTIONS form_opts(const FORM *form);
15 .br
16 .SH DESCRIPTION
17 The function \fBset_form_opts\fR sets all the given form's option bits (form
18 option bits may be logically-OR'ed together).
19
20 The function \fBform_opts_on\fR turns on the given option bits, and leaves
21 others alone.
22
23 The function \fBform_opts_off\fR turns off the given option bits, and leaves
24 others alone.
25
26 The function \fBform_opts\fR returns the form's current option bits.  
27
28 The following options are defined (all are on by default):
29 .TP 5
30 O_NL_OVERLOAD
31 Overload the \fBREQ_NEW_LINE\fR forms driver request so that calling it at the
32 end of a field goes to the next field. 
33 .TP 5
34 O_BS_OVERLOAD
35 Overload the \fBREQ_DEL_PREV\fR forms driver request so that calling it at the
36 beginning of a field goes to the previous field. 
37 .SH RETURN VALUE
38 Except for \fBform_opts\fR, each routine returns one of the following:
39 .TP 5
40 \fBE_OK\fR
41 The routine succeeded.
42 .TP 5
43 \fBE_SYSTEM_ERROR\fR
44 System error occurred (see \fBerrno\fR).
45 .SH SEE ALSO
46 \fBcurses\fR(3X), \fBform\fR(3X).
47 .SH NOTES
48 The header file \fB<form.h>\fR automatically includes the header file
49 \fB<curses.h>\fR.
50 .SH PORTABILITY
51 These routines emulate the System V forms library.  They were not supported on
52 Version 7 or BSD versions.
53 .SH AUTHORS
54 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
55 S. Raymond.
56 .\"#
57 .\"# The following sets edit modes for GNU EMACS
58 .\"# Local Variables:
59 .\"# mode:nroff
60 .\"# fill-column:79
61 .\"# End: