ncurses 5.7 - patch 20100828
[ncurses.git] / man / form_opts.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
4 .\"                                                                          *
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:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
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.                               *
23 .\"                                                                          *
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       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_opts.3x,v 1.10 2010/07/31 16:08:48 tom Exp $
31 .TH form_opts 3X ""
32 .SH NAME
33 \fBform_opts\fR \- set and get form options
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 int set_form_opts(FORM *form, Field_Options opts);
38 .br
39 int form_opts_on(FORM *form, Field_Options opts);
40 .br
41 int form_opts_off(FORM *form, Field_Options opts);
42 .br
43 Field_Options form_opts(const FORM *form);
44 .br
45 .SH DESCRIPTION
46 The function \fBset_form_opts\fR sets all the given form's option bits (form
47 option bits may be logically-OR'ed together).
48 .PP
49 The function \fBform_opts_on\fR turns on the given option bits, and leaves
50 others alone.
51 .PP
52 The function \fBform_opts_off\fR turns off the given option bits, and leaves
53 others alone.
54 .PP
55 The function \fBform_opts\fR returns the form's current option bits.
56 .PP
57 The following options are defined (all are on by default):
58 .TP 5
59 O_NL_OVERLOAD
60 Overload the \fBREQ_NEW_LINE\fR forms driver request so that calling it at the
61 end of a field goes to the next field.
62 .TP 5
63 O_BS_OVERLOAD
64 Overload the \fBREQ_DEL_PREV\fR forms driver request so that calling it at the
65 beginning of a field goes to the previous field.
66 .SH RETURN VALUE
67 Except for \fBform_opts\fR, each routine returns one of the following:
68 .TP 5
69 .B E_OK
70 The routine succeeded.
71 .TP 5
72 .B E_SYSTEM_ERROR
73 System error occurred (see \fBerrno\fR).
74 .SH SEE ALSO
75 \fBcurses\fR(3X), \fBform\fR(3X).
76 .SH NOTES
77 The header file \fB<form.h>\fR automatically includes the header file
78 \fB<curses.h>\fR.
79 .SH PORTABILITY
80 These routines emulate the System V forms library.  They were not supported on
81 Version 7 or BSD versions.
82 .SH AUTHORS
83 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
84 S. Raymond.
85 .\"#
86 .\"# The following sets edit modes for GNU EMACS
87 .\"# Local Variables:
88 .\"# mode:nroff
89 .\"# fill-column:79
90 .\"# End: