ncurses 6.0 - patch 20170506
[ncurses.git] / doc / html / man / form_field_opts.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2014,2015 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: form_field_opts.3x,v 1.20 2015/12/05 23:53:43 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_field_opts 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_field_opts 3x</H1>
43 <PRE>
44 <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>                                        <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>set_field_opts</STRONG>, <STRONG>field_opts_on</STRONG>, <STRONG>field_opts_off</STRONG>, <STRONG>field_opts</STRONG> - set and get
51        field options
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
56        int set_field_opts(FIELD *field, Field_Options opts);
57        int field_opts_on(FIELD *field, Field_Options opts);
58        int field_opts_off(FIELD *field, Field_Options opts);
59        Field_Options field_opts(const FIELD *field);
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The function <STRONG>set_field_opts</STRONG> sets all  the  given  field's  option  bits
64        (field option bits may be logically-OR'ed together).
65
66        The  function  <STRONG>field_opts_on</STRONG> turns on the given option bits, and leaves
67        others alone.
68
69        The function <STRONG>field_opts_off</STRONG> turns off the given option bits, and leaves
70        others alone.
71
72        The function <STRONG>field_opts</STRONG> returns the field's current option bits.
73
74        The following standard options are defined (all are on by default):
75
76        O_ACTIVE
77             The  field  is  visited during processing.  If this option is off,
78             the field will not be reachable by navigation keys. Please  notice
79             that an invisible field appears to be inactive also.
80
81        O_AUTOSKIP
82             Skip to the next field when this one fills.
83
84        O_BLANK
85             The  field is cleared whenever a character is entered at the first
86             position.
87
88        O_EDIT
89             The field can be edited.
90
91        O_NULLOK
92             Allow a blank field.
93
94        O_PASSOK
95             Validate field only if modified by user.
96
97        O_PUBLIC
98             The field contents are displayed as data is entered.
99
100        O_STATIC
101             Field buffers are fixed  to  field's  original  size.   Turn  this
102             option off to create a dynamic field.
103
104        O_VISIBLE
105             The  field  is  displayed.   If this option is off, display of the
106             field is suppressed.
107
108        O_WRAP
109             Words that do not fit on a line are  wrapped  to  the  next  line.
110             Words are blank-separated.
111
112        These extension options are defined (extensions are off by default):
113
114        O_DYNAMIC_JUSTIFY
115             Permit dynamic fields to be justified, like static fields.
116
117        O_NO_LEFT_STRIP
118             Preserve leading whitespace in the field buffer, which is normally
119             discarded.
120
121
122 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
123        Except for <STRONG>field_opts</STRONG>, each routine returns one of the following:
124
125        <STRONG>E_OK</STRONG> The routine succeeded.
126
127        <STRONG>E_BAD_ARGUMENT</STRONG>
128             Routine detected an incorrect or out-of-range argument.
129
130        <STRONG>E_CURRENT</STRONG>
131             The field is the current field.
132
133        <STRONG>E_SYSTEM_ERROR</STRONG>
134             System error occurred (see <STRONG>errno</STRONG>).
135
136
137 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
138        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.  <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>.
139
140
141 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
142        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
143        <STRONG>&lt;curses.h&gt;</STRONG>.
144
145
146 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
147        These  routines emulate the System V forms library.  They were not sup-
148        ported on Version 7 or BSD versions.
149
150
151 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
152        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
153        Raymond.
154
155
156
157                                                            <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
158 </PRE>
159 <div class="nav">
160 <ul>
161 <li><a href="#h2-NAME">NAME</a></li>
162 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
163 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
164 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
165 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
166 <li><a href="#h2-NOTES">NOTES</a></li>
167 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
168 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
169 </ul>
170 </div>
171 </BODY>
172 </HTML>