ncurses 6.0 - patch 20150808
[ncurses.git] / man / form.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2014,2015 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form.3x,v 1.26 2015/08/02 18:14:50 tom Exp $
31 .TH form 3X ""
32 .SH NAME
33 \fBform\fR \- curses extension for programming forms
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 .SH DESCRIPTION
38 The \fBform\fR library provides terminal-independent facilities for composing
39 form screens on character-cell terminals.  The library includes: field
40 routines, which create and modify form fields; and form routines, which group
41 fields into forms, display forms on the screen, and handle interaction with the
42 user.
43 .PP
44 The \fBform\fR library uses the \fBcurses\fR libraries.
45 To use the \fBform\fR library, link with the options
46 \fB\-lform \-lcurses\fR.
47 .PP
48 Your program should set up the locale, e.g.,
49 .sp
50      \fBsetlocale(LC_ALL, "");\fP
51 .sp
52 so that input/output processing will work.
53 .PP
54 A curses initialization routine such as \fBinitscr\fR must be called
55 before using any of these functions.
56 .
57 .SS Current Default Values for Field Attributes
58 .
59 The \fBform\fR library maintains a default value for field attributes.  You
60 can get or set this default by calling the appropriate \fBset_\fR
61 or retrieval
62 routine with a \fBNULL\fR field pointer.  Changing this default with a
63 \fBset_\fR function affects future field creations, but does not change the
64 rendering of fields already created.
65 .
66 .SS Routine Name Index
67 .
68 The following table lists each \fBform\fR routine and the name of
69 the manual page on which it is described.
70 .
71 .TS
72 l l
73 l l .
74 \fBcurses\fR Routine Name       Manual Page Name
75 =
76 current_field   \fBform_page\fR(3X)
77 data_ahead      \fBform_data\fR(3X)
78 data_behind     \fBform_data\fR(3X)
79 dup_field       \fBform_field_new\fR(3X)
80 dynamic_field_info      \fBform_field_info\fR(3X)
81 field_arg       \fBform_field_validation\fR(3X)
82 field_back      \fBform_field_attributes\fR(3X)
83 field_buffer    \fBform_field_buffer\fR(3X)
84 field_count     \fBform_field\fR(3X)
85 field_fore      \fBform_field_attributes\fR(3X)
86 field_index     \fBform_page\fR(3X)
87 field_info      \fBform_field_info\fR(3X)
88 field_init      \fBform_hook\fR(3X)
89 field_just      \fBform_field_just\fR(3X)
90 field_opts      \fBform_field_opts\fR(3X)
91 field_opts_off  \fBform_field_opts\fR(3X)
92 field_opts_on   \fBform_field_opts\fR(3X)
93 field_pad       \fBform_field_attributes\fR(3X)
94 field_status    \fBform_field_buffer\fR(3X)
95 field_term      \fBform_hook\fR(3X)
96 field_type      \fBform_field_validation\fR(3X)
97 field_userptr   \fBform_field_userptr\fR(3X)
98 form_driver     \fBform_driver\fR(3X)
99 form_driver_w   \fBform_driver\fR(3X)*
100 form_fields     \fBform_field\fR(3X)
101 form_init       \fBform_hook\fR(3X)
102 form_opts       \fBform_opts\fR(3X)
103 form_opts_off   \fBform_opts\fR(3X)
104 form_opts_on    \fBform_opts\fR(3X)
105 form_page       \fBform_page\fR(3X)
106 form_request_by_name    \fBform_requestname\fR(3X)
107 form_request_name       \fBform_requestname\fR(3X)
108 form_sub        \fBform_win\fR(3X)
109 form_term       \fBform_hook\fR(3X)
110 form_userptr    \fBform_userptr\fR(3X)
111 form_win        \fBform_win\fR(3X)
112 free_field      \fBform_field_new\fR(3X)
113 free_fieldtype  \fBform_fieldtype\fR(3X)
114 free_form       \fBform_new\fR(3X)
115 link_field      \fBform_field_new\fR(3X)
116 link_fieldtype  \fBform_fieldtype\fR(3X)
117 move_field      \fBform_field\fR(3X)
118 new_field       \fBform_field_new\fR(3X)
119 new_fieldtype   \fBform_fieldtype\fR(3X)
120 new_form        \fBform_new\fR(3X)
121 new_page        \fBform_new_page\fR(3X)
122 pos_form_cursor \fBform_cursor\fR(3X)
123 post_form       \fBform_post\fR(3X)
124 scale_form      \fBform_win\fR(3X)
125 set_current_field       \fBform_page\fR(3X)
126 set_field_back  \fBform_field_attributes\fR(3X)
127 set_field_buffer        \fBform_field_buffer\fR(3X)
128 set_field_fore  \fBform_field_attributes\fR(3X)
129 set_field_init  \fBform_hook\fR(3X)
130 set_field_just  \fBform_field_just\fR(3X)
131 set_field_opts  \fBform_field_opts\fR(3X)
132 set_field_pad   \fBform_field_attributes\fR(3X)
133 set_field_status        \fBform_field_buffer\fR(3X)
134 set_field_term  \fBform_hook\fR(3X)
135 set_field_type  \fBform_field_validation\fR(3X)
136 set_field_userptr       \fBform_field_userptr\fR(3X)
137 set_fieldtype_arg       \fBform_fieldtype\fR(3X)
138 set_fieldtype_choice    \fBform_fieldtype\fR(3X)
139 set_form_fields \fBform_field\fR(3X)
140 set_form_init   \fBform_hook\fR(3X)
141 set_form_opts   \fBform_field_opts\fR(3X)
142 set_form_page   \fBform_page\fR(3X)
143 set_form_sub    \fBform_win\fR(3X)
144 set_form_term   \fBform_hook\fR(3X)
145 set_form_userptr        \fBform_userptr\fR(3X)
146 set_form_win    \fBform_win\fR(3X)
147 set_max_field   \fBform_field_buffer\fR(3X)
148 set_new_page    \fBform_new_page\fR(3X)
149 unpost_form     \fBform_post\fR(3X)
150 .TE
151 .SH RETURN VALUE
152 Routines that return pointers return \fBNULL\fR on error,
153 and set errno to the corresponding error-code returned by functions
154 returning an integer.
155 Routines that return
156 an integer return one of the following error codes:
157 .TP 5
158 .B E_OK
159 The routine succeeded.
160 .TP 5
161 .B E_BAD_ARGUMENT
162 Routine detected an incorrect or out-of-range argument.
163 .TP 5
164 .B E_BAD_STATE
165 Routine was called from an initialization or termination function.
166 .TP 5
167 .B E_CONNECTED
168 The field is already connected to a form.
169 .TP 5
170 .B E_INVALID_FIELD
171 Contents of a field are not valid.
172 .TP 5
173 .B E_NOT_CONNECTED
174 No fields are connected to the form.
175 .TP 5
176 .B E_NOT_POSTED
177 The form has not been posted.
178 .TP 5
179 .B E_NO_ROOM
180 Form is too large for its window.
181 .TP 5
182 .B E_POSTED
183 The form is already posted.
184 .TP 5
185 .B E_REQUEST_DENIED
186 The form driver could not process the request.
187 .TP 5
188 .B E_SYSTEM_ERROR
189 System error occurred (see \fBerrno\fR).
190 .TP 5
191 .B E_UNKNOWN_COMMAND
192 The form driver code saw an unknown request code.
193 .SH NOTES
194 The header file \fB<form.h>\fR automatically includes the header files
195 \fB<curses.h>\fR and \fB<eti.h>\fR.
196 .PP
197 In your library list, libform.a should be before libncurses.a; that is,
198 you want to say `\-lform \-lncurses', not the other way around (which would
199 give you a link error using most linkers).
200 .SH PORTABILITY
201 These routines emulate the System V forms library.  They were not supported on
202 Version 7 or BSD versions.
203 .SH AUTHORS
204 Juergen Pfeifer.  Manual pages and adaptation for ncurses by Eric
205 S. Raymond.
206 .SH SEE ALSO
207 \fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
208 descriptions of the entry points.
209 .PP
210 This describes \fBncurses\fR
211 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).