ncurses 5.9 - patch 20150214
[ncurses.git] / doc / html / man / form_field_opts.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2014 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.17 2014/07/26 21:21:57 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>form_field_opts 3x</H1>
43 <HR>
44 <PRE>
45 <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>
46
47
48
49
50 </PRE>
51 <H2><a name="h2-NAME">NAME</a></H2><PRE>
52        <STRONG>form_field_opts</STRONG> - set and get field options
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
58        int set_field_opts(FIELD *field, Field_Options opts);
59        int field_opts_on(FIELD *field, Field_Options opts);
60        int field_opts_off(FIELD *field, Field_Options opts);
61        Field_Options field_opts(const FIELD *field);
62
63
64 </PRE>
65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66        The  function  <STRONG>set_field_opts</STRONG>  sets  all the given field's
67        option bits (field  option  bits  may  be  logically-OR'ed
68        together).
69
70        The function <STRONG>field_opts_on</STRONG> turns on the given option bits,
71        and leaves others alone.
72
73        The function <STRONG>field_opts_off</STRONG> turns  off  the  given  option
74        bits, and leaves others alone.
75
76        The function <STRONG>field_opts</STRONG> returns the field's current option
77        bits.
78
79        The following standard options are defined (all are on  by
80        default):
81
82        O_ACTIVE
83             The  field  is  visited  during  processing.  If this
84             option is off, the field will  not  be  reachable  by
85             navigation  keys.  Please  notice  that  an invisible
86             field appears to be inactive also.
87
88        O_AUTOSKIP
89             Skip to the next field when this one fills.
90
91        O_BLANK
92             The field is cleared whenever a character is  entered
93             at the first position.
94
95        O_EDIT
96             The field can be edited.
97
98        O_NULLOK
99             Allow a blank field.
100
101        O_PASSOK
102             Validate field only if modified by user.
103
104        O_PUBLIC
105             The field contents are displayed as data is entered.
106
107        O_STATIC
108             Field  buffers  are  fixed  to field's original size.
109             Turn this option off to create a dynamic field.
110
111        O_VISIBLE
112             The field is displayed.  If this option is off,  dis-
113             play of the field is suppressed.
114
115        O_WRAP
116             Words  that  do  not fit on a line are wrapped to the
117             next line.  Words are blank-separated.
118
119        One extension option is defined  (extensions  are  off  by
120        default):
121
122        O_DYNAMIC_JUSTIFY
123             Permit  dynamic  fields  to be justified, like static
124             fields.
125
126
127 </PRE>
128 <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>
146 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
147        <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>.
148
149
150 </PRE>
151 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
152        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
153        file <STRONG>&lt;curses.h&gt;</STRONG>.
154
155
156 </PRE>
157 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
158        These  routines  emulate the System V forms library.  They
159        were not supported on Version 7 or BSD versions.
160
161
162 </PRE>
163 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
164        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
165        curses by Eric S. Raymond.
166
167
168
169                                                     <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
170 </PRE>
171 <div class="nav">
172 <ul>
173 <li><a href="#h2-NAME">NAME</a></li>
174 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
175 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
176 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
177 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
178 <li><a href="#h2-NOTES">NOTES</a></li>
179 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
180 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
181 </ul>
182 </div>
183 </BODY>
184 </HTML>