ncurses 6.0 - patch 20170401
[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>
51        - set and get 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
64        option  bits  (field  option  bits  may be logically-OR'ed
65        together).
66
67        The function <STRONG>field_opts_on</STRONG> turns on the given option bits,
68        and leaves others alone.
69
70        The  function  <STRONG>field_opts_off</STRONG>  turns  off the given option
71        bits, and leaves others alone.
72
73        The function <STRONG>field_opts</STRONG> returns the field's current option
74        bits.
75
76        The  following standard options are defined (all are on by
77        default):
78
79        O_ACTIVE
80             The field is  visited  during  processing.   If  this
81             option  is  off,  the  field will not be reachable by
82             navigation keys.  Please  notice  that  an  invisible
83             field appears to be inactive also.
84
85        O_AUTOSKIP
86             Skip to the next field when this one fills.
87
88        O_BLANK
89             The  field is cleared whenever a character is entered
90             at the first position.
91
92        O_EDIT
93             The field can be edited.
94
95        O_NULLOK
96             Allow a blank field.
97
98        O_PASSOK
99             Validate field only if modified by user.
100
101        O_PUBLIC
102             The field contents are displayed as data is entered.
103
104        O_STATIC
105             Field buffers are fixed  to  field's  original  size.
106             Turn this option off to create a dynamic field.
107
108        O_VISIBLE
109             The  field is displayed.  If this option is off, dis-
110             play of the field is suppressed.
111
112        O_WRAP
113             Words that do not fit on a line are  wrapped  to  the
114             next line.  Words are blank-separated.
115
116        These extension options are defined (extensions are off by
117        default):
118
119        O_DYNAMIC_JUSTIFY
120             Permit dynamic fields to be  justified,  like  static
121             fields.
122
123        O_NO_LEFT_STRIP
124             Preserve  leading  whitespace  in  the  field buffer,
125             which is normally discarded.
126
127
128 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
129        Except for <STRONG>field_opts</STRONG>, each routine  returns  one  of  the
130        following:
131
132        <STRONG>E_OK</STRONG> The routine succeeded.
133
134        <STRONG>E_BAD_ARGUMENT</STRONG>
135             Routine  detected  an incorrect or out-of-range argu-
136             ment.
137
138        <STRONG>E_CURRENT</STRONG>
139             The field is the current field.
140
141        <STRONG>E_SYSTEM_ERROR</STRONG>
142             System error occurred (see <STRONG>errno</STRONG>).
143
144
145 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
146        <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>.
147
148
149 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
150        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
151        file <STRONG>&lt;curses.h&gt;</STRONG>.
152
153
154 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
155        These  routines  emulate the System V forms library.  They
156        were not supported on Version 7 or BSD versions.
157
158
159 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
160        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
161        curses by Eric S. Raymond.
162
163
164
165                                                     <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
166 </PRE>
167 <div class="nav">
168 <ul>
169 <li><a href="#h2-NAME">NAME</a></li>
170 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
171 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
172 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
173 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
174 <li><a href="#h2-NOTES">NOTES</a></li>
175 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
176 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
177 </ul>
178 </div>
179 </BODY>
180 </HTML>