ncurses 5.7 - patch 20100731
[ncurses.git] / man / form_field_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_field_opts.3x,v 1.15 2010/07/31 14:49:44 tom Exp $
31 .TH form_field_opts 3X ""
32 .SH NAME
33 \fBform_field_opts\fR \- set and get field options
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 int set_field_opts(FIELD *field, Field_Options opts);
38 .br
39 int field_opts_on(FIELD *field, Field_Options opts);
40 .br
41 int field_opts_off(FIELD *field, Field_Options opts);
42 .br
43 Field_Options field_opts(const FIELD *field);
44 .br
45 .SH DESCRIPTION
46 The function \fBset_field_opts\fR sets all the given field's option bits (field
47 option bits may be logically-OR'ed together).
48 .PP
49 The function \fBfield_opts_on\fR turns on the given option bits, and leaves
50 others alone.
51 .PP
52 The function \fBfield_opts_off\fR turns off the given option bits, and leaves
53 others alone.
54 .PP
55 The function \fBfield_opts\fR returns the field's current option bits.
56 .PP
57 The following options are defined (all are on by default):
58 .TP 5
59 O_VISIBLE
60 The field is displayed.  If this option is off, display of the field is
61 suppressed.
62 .TP 5
63 O_ACTIVE
64 The field is visited during processing.  If this option is off, the field will
65 not be reachable by navigation keys. Please notice that an invisible field
66 appears to be inactive also.
67 .TP 5
68 O_PUBLIC
69 The field contents are displayed as data is entered.
70 .TP 5
71 O_EDIT
72 The field can be edited.
73 .TP 5
74 O_WRAP
75 Words that do not fit on a line are wrapped to the next line.  Words are
76 blank-separated.
77 .TP 5
78 O_BLANK
79 The field is cleared whenever a character is entered at the first position.
80 .TP 5
81 O_AUTOSKIP
82 Skip to the next field when this one fills.
83 .TP 5
84 O_NULLOK
85 Allow a blank field.
86 .TP 5
87 O_STATIC
88 Field buffers are fixed to field's original size.
89 Turn this option off to create a dynamic field.
90 .TP 5
91 O_PASSOK
92 Validate field only if modified by user.
93 .SH RETURN VALUE
94 Except for \fBfield_opts\fR, each routine returns one of the following:
95 .TP 5
96 .B E_OK
97 The routine succeeded.
98 .TP 5
99 .B E_BAD_ARGUMENT
100 Routine detected an incorrect or out-of-range argument.
101 .TP 5
102 .B E_CURRENT
103 The field is the current field.
104 .TP 5
105 .B E_SYSTEM_ERROR
106 System error occurred (see \fBerrno\fR).
107 .SH SEE ALSO
108 \fBcurses\fR(3X), \fBform\fR(3X).
109 .SH NOTES
110 The header file \fB<form.h>\fR automatically includes the header file
111 \fB<curses.h>\fR.
112 .SH PORTABILITY
113 These routines emulate the System V forms library.  They were not supported on
114 Version 7 or BSD versions.
115 .SH AUTHORS
116 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
117 S. Raymond.
118 .\"#
119 .\"# The following sets edit modes for GNU EMACS
120 .\"# Local Variables:
121 .\"# mode:nroff
122 .\"# fill-column:79
123 .\"# End: