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