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