ncurses 6.0 - patch 20171118
[ncurses.git] / doc / html / man / form.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2016,2017 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.3x,v 1.29 2017/02/18 16:46:53 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 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 3x</H1>
43 <PRE>
44 <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>                                                              <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>form</STRONG> - curses extension for programming forms
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
55
56
57 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
58        The <STRONG>form</STRONG> library provides terminal-independent facilities for composing
59        form screens on character-cell terminals.  The library includes:  field
60        routines, which create and modify form fields; and form routines, which
61        group fields into forms, display forms on the screen, and handle inter-
62        action with the user.
63
64        The  <STRONG>form</STRONG>  library uses the <STRONG>curses</STRONG> libraries.  To use the <STRONG>form</STRONG> library,
65        link with the options <STRONG>-lform</STRONG> <STRONG>-lcurses</STRONG>.
66
67        Your program should set up the locale, e.g.,
68
69             <STRONG>setlocale(LC_ALL,</STRONG> <STRONG>"");</STRONG>
70
71        so that input/output processing will work.
72
73        A curses initialization routine such as <STRONG>initscr</STRONG> must be  called  before
74        using any of these functions.
75
76
77 </PRE><H3><a name="h3-Current-Default-Values-for-Field-Attributes">Current Default Values for Field Attributes</a></H3><PRE>
78        The  <STRONG>form</STRONG>  library maintains a default value for field attributes.  You
79        can get or  set  this  default  by  calling  the  appropriate  <STRONG>set_</STRONG>  or
80        retrieval  routine  with  a  <STRONG>NULL</STRONG> field pointer.  Changing this default
81        with a <STRONG>set_</STRONG> function affects  future  field  creations,  but  does  not
82        change the rendering of fields already created.
83
84
85 </PRE><H3><a name="h3-Routine-Name-Index">Routine Name Index</a></H3><PRE>
86        The  following table lists each <STRONG>form</STRONG> routine and the name of the manual
87        page on which it is described.
88
89        <STRONG>curses</STRONG> Routine Name     Manual Page Name
90        --------------------------------------------------
91        current_field           <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
92        data_ahead              <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
93        data_behind             <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
94        dup_field               <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
95        dynamic_field_info      <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
96        field_arg               <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
97        field_back              <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
98        field_buffer            <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
99        field_count             <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
100        field_fore              <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
101        field_index             <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
102        field_info              <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
103        field_init              <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
104        field_just              <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>
105        field_opts              <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
106        field_opts_off          <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
107        field_opts_on           <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
108        field_pad               <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
109        field_status            <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
110        field_term              <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
111        field_type              <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
112        field_userptr           <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
113        form_driver             <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
114
115        form_driver_w           <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>*
116        form_fields             <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
117        form_init               <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
118        form_opts               <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
119        form_opts_off           <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
120        form_opts_on            <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
121        form_page               <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
122        form_request_by_name    <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
123        form_request_name       <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
124        form_sub                <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
125        form_term               <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
126        form_userptr            <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
127        form_win                <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
128        free_field              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
129        free_fieldtype          <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
130        free_form               <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
131        link_field              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
132        link_fieldtype          <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
133        move_field              <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
134        new_field               <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
135        new_fieldtype           <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
136        new_form                <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
137        new_page                <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
138        pos_form_cursor         <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG>
139        post_form               <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
140        scale_form              <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
141        set_current_field       <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
142        set_field_back          <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
143        set_field_buffer        <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
144        set_field_fore          <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
145        set_field_init          <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
146        set_field_just          <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>
147        set_field_opts          <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
148        set_field_pad           <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
149        set_field_status        <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
150        set_field_term          <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
151        set_field_type          <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
152        set_field_userptr       <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
153        set_fieldtype_arg       <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
154        set_fieldtype_choice    <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
155        set_form_fields         <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
156        set_form_init           <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
157        set_form_opts           <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
158        set_form_page           <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
159        set_form_sub            <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
160        set_form_term           <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
161        set_form_userptr        <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
162        set_form_win            <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
163        set_max_field           <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
164        set_new_page            <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
165        unfocus_current_field   <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
166        unpost_form             <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
167
168
169 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
170        Routines that return pointers return <STRONG>NULL</STRONG> on error, and  set  errno  to
171        the  corresponding  error-code returned by functions returning an inte-
172        ger.  Routines that return an integer return one of the following error
173        codes:
174
175        <STRONG>E_OK</STRONG> The routine succeeded.
176
177        <STRONG>E_BAD_ARGUMENT</STRONG>
178             Routine detected an incorrect or out-of-range argument.
179
180        <STRONG>E_BAD_STATE</STRONG>
181             Routine was called from an initialization or termination function.
182
183        <STRONG>E_CONNECTED</STRONG>
184             The field is already connected to a form.
185
186        <STRONG>E_INVALID_FIELD</STRONG>
187             Contents of a field are not valid.
188
189        <STRONG>E_NOT_CONNECTED</STRONG>
190             No fields are connected to the form.
191
192        <STRONG>E_NOT_POSTED</STRONG>
193             The form has not been posted.
194
195        <STRONG>E_NO_ROOM</STRONG>
196             Form is too large for its window.
197
198        <STRONG>E_POSTED</STRONG>
199             The form is already posted.
200
201        <STRONG>E_REQUEST_DENIED</STRONG>
202             The form driver could not process the request.
203
204        <STRONG>E_SYSTEM_ERROR</STRONG>
205             System error occurred (see <STRONG>errno</STRONG>).
206
207        <STRONG>E_UNKNOWN_COMMAND</STRONG>
208             The form driver code saw an unknown request code.
209
210
211 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
212        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header files
213        <STRONG>&lt;curses.h&gt;</STRONG> and <STRONG>&lt;eti.h&gt;</STRONG>.
214
215        In your library list, libform.a should be before libncurses.a; that is,
216        you  want  to  say  "-lform -lncurses", not the other way around (which
217        would give you a link error when using static libraries).
218
219
220 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
221        These routines emulate the System V forms library.  They were not  sup-
222        ported on Version 7 or BSD versions.
223
224        A  few functions are extensions added for ncurses, e.g., <STRONG>form_driver_w</STRONG>,
225        <STRONG>unfocus_current_field</STRONG>.
226
227
228 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
229        Juergen Pfeifer.  Manual pages and adaptation for ncurses  by  Eric  S.
230        Raymond.
231
232
233 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
234        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>  and  related  pages  whose names begin "form_" for detailed
235        descriptions of the entry points.
236
237        This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20171118).
238
239
240
241                                                                       <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>
242 </PRE>
243 <div class="nav">
244 <ul>
245 <li><a href="#h2-NAME">NAME</a></li>
246 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
247 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
248 <ul>
249 <li><a href="#h3-Current-Default-Values-for-Field-Attributes">Current Default Values for Field Attributes</a></li>
250 <li><a href="#h3-Routine-Name-Index">Routine Name Index</a></li>
251 </ul>
252 </li>
253 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
254 <li><a href="#h2-NOTES">NOTES</a></li>
255 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
256 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
257 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
258 </ul>
259 </div>
260 </BODY>
261 </HTML>