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