5463815aa61714af8354ffc78d5bbb116f04fc68
[ncurses.git] / doc / html / man / form_field_opts.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_field_opts.3x,v 1.16 2010/12/04 18:41:07 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_field_opts 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_field_opts 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
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>NAME</H2><PRE>
51        <STRONG>form_field_opts</STRONG> - set and get field options
52
53
54 </PRE>
55 <H2>SYNOPSIS</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>DESCRIPTION</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 options are defined (all are on by default):
79
80        O_VISIBLE
81             The field is displayed.  If this option is off,  dis-
82             play of the field is suppressed.
83
84        O_ACTIVE
85             The  field  is  visited  during  processing.  If this
86             option is off, the field will  not  be  reachable  by
87             navigation  keys.  Please  notice  that  an invisible
88             field appears to be inactive also.
89
90        O_PUBLIC
91             The field contents are displayed as data is entered.
92
93        O_EDIT
94             The field can be edited.
95
96        O_WRAP
97             Words that do not fit on a line are  wrapped  to  the
98             next line.  Words are blank-separated.
99
100        O_BLANK
101             The  field is cleared whenever a character is entered
102             at the first position.
103
104        O_AUTOSKIP
105             Skip to the next field when this one fills.
106
107        O_NULLOK
108             Allow a blank field.
109
110        O_STATIC
111             Field buffers are fixed  to  field's  original  size.
112             Turn this option off to create a dynamic field.
113
114        O_PASSOK
115             Validate field only if modified by user.
116
117
118 </PRE>
119 <H2>RETURN VALUE</H2><PRE>
120        Except  for  <STRONG>field_opts</STRONG>,  each  routine returns one of the
121        following:
122
123        <STRONG>E_OK</STRONG> The routine succeeded.
124
125        <STRONG>E_BAD_ARGUMENT</STRONG>
126             Routine detected an incorrect or  out-of-range  argu-
127             ment.
128
129        <STRONG>E_CURRENT</STRONG>
130             The field is the current field.
131
132        <STRONG>E_SYSTEM_ERROR</STRONG>
133             System error occurred (see <STRONG>errno</STRONG>).
134
135
136 </PRE>
137 <H2>SEE ALSO</H2><PRE>
138        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
139
140
141 </PRE>
142 <H2>NOTES</H2><PRE>
143        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
144        file <STRONG>&lt;curses.h&gt;</STRONG>.
145
146
147 </PRE>
148 <H2>PORTABILITY</H2><PRE>
149        These routines emulate the System V forms  library.   They
150        were not supported on Version 7 or BSD versions.
151
152
153 </PRE>
154 <H2>AUTHORS</H2><PRE>
155        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
156        curses by Eric S. Raymond.
157
158
159
160                                                     <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
161 </PRE>
162 <HR>
163 <ADDRESS>
164 Man(1) output converted with
165 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
166 </ADDRESS>
167 </BODY>
168 </HTML>