ncurses 6.2 - patch 20201219
[ncurses.git] / man / form.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 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 .\"
31 .\" $Id: form.3x,v 1.36 2020/12/12 16:34:33 tom Exp $
32 .TH form 3X ""
33 .ie \n(.g .ds `` \(lq
34 .el       .ds `` ``
35 .ie \n(.g .ds '' \(rq
36 .el       .ds '' ''
37 .de bP
38 .ie n  .IP \(bu 4
39 .el    .IP \(bu 2
40 ..
41 .SH NAME
42 \fBform\fR \- curses extension for programming forms
43 .SH SYNOPSIS
44 \fB#include <form.h>\fR
45 .br
46 .SH DESCRIPTION
47 The \fBform\fR library provides terminal-independent facilities for composing
48 form screens on character-cell terminals.
49 The library includes: field
50 routines, which create and modify form fields; and form routines, which group
51 fields into forms, display forms on the screen, and handle interaction with the
52 user.
53 .PP
54 The \fBform\fR library uses the \fBcurses\fR libraries.
55 To use the \fBform\fR library, link with the options
56 \fB\-lform \-lcurses\fR.
57 .PP
58 Your program should set up the locale, e.g.,
59 .sp
60      \fBsetlocale(LC_ALL, "");\fP
61 .sp
62 so that input/output processing will work.
63 .PP
64 A curses initialization routine such as \fBinitscr\fR must be called
65 before using any of these functions.
66 .
67 .SS Current Default Values for Field Attributes
68 .
69 The \fBform\fR library maintains a default value for field attributes.
70 You
71 can get or set this default by calling the appropriate \fBset_\fR
72 or retrieval
73 routine with a \fBNULL\fR field pointer.
74 Changing this default with a
75 \fBset_\fR function affects future field creations, but does not change the
76 rendering of fields already created.
77 .
78 .SS Routine Name Index
79 .
80 The following table lists each \fBform\fR routine and the name of
81 the manual page on which it is described.
82 Routines flagged with \*(``*\*(''
83 are ncurses-specific, not present in SVr4.
84 .
85 .TS
86 l l
87 l l .
88 \fBcurses\fR Routine Name       Manual Page Name
89 =
90 current_field   \fBform_page\fR(3X)
91 data_ahead      \fBform_data\fR(3X)
92 data_behind     \fBform_data\fR(3X)
93 dup_field       \fBform_field_new\fR(3X)
94 dynamic_field_info      \fBform_field_info\fR(3X)
95 field_arg       \fBform_field_validation\fR(3X)
96 field_back      \fBform_field_attributes\fR(3X)
97 field_buffer    \fBform_field_buffer\fR(3X)
98 field_count     \fBform_field\fR(3X)
99 field_fore      \fBform_field_attributes\fR(3X)
100 field_index     \fBform_page\fR(3X)
101 field_info      \fBform_field_info\fR(3X)
102 field_init      \fBform_hook\fR(3X)
103 field_just      \fBform_field_just\fR(3X)
104 field_opts      \fBform_field_opts\fR(3X)
105 field_opts_off  \fBform_field_opts\fR(3X)
106 field_opts_on   \fBform_field_opts\fR(3X)
107 field_pad       \fBform_field_attributes\fR(3X)
108 field_status    \fBform_field_buffer\fR(3X)
109 field_term      \fBform_hook\fR(3X)
110 field_type      \fBform_field_validation\fR(3X)
111 field_userptr   \fBform_field_userptr\fR(3X)
112 form_driver     \fBform_driver\fR(3X)
113 form_driver_w   \fBform_driver\fR(3X)*
114 form_fields     \fBform_field\fR(3X)
115 form_init       \fBform_hook\fR(3X)
116 form_opts       \fBform_opts\fR(3X)
117 form_opts_off   \fBform_opts\fR(3X)
118 form_opts_on    \fBform_opts\fR(3X)
119 form_page       \fBform_page\fR(3X)
120 form_request_by_name    \fBform_requestname\fR(3X)*
121 form_request_name       \fBform_requestname\fR(3X)*
122 form_sub        \fBform_win\fR(3X)
123 form_term       \fBform_hook\fR(3X)
124 form_userptr    \fBform_userptr\fR(3X)
125 form_win        \fBform_win\fR(3X)
126 free_field      \fBform_field_new\fR(3X)
127 free_fieldtype  \fBform_fieldtype\fR(3X)
128 free_form       \fBform_new\fR(3X)
129 link_field      \fBform_field_new\fR(3X)
130 link_fieldtype  \fBform_fieldtype\fR(3X)
131 move_field      \fBform_field\fR(3X)
132 new_field       \fBform_field_new\fR(3X)
133 new_fieldtype   \fBform_fieldtype\fR(3X)
134 new_form        \fBform_new\fR(3X)
135 new_page        \fBform_new_page\fR(3X)
136 pos_form_cursor \fBform_cursor\fR(3X)
137 post_form       \fBform_post\fR(3X)
138 scale_form      \fBform_win\fR(3X)
139 set_current_field       \fBform_page\fR(3X)
140 set_field_back  \fBform_field_attributes\fR(3X)
141 set_field_buffer        \fBform_field_buffer\fR(3X)
142 set_field_fore  \fBform_field_attributes\fR(3X)
143 set_field_init  \fBform_hook\fR(3X)
144 set_field_just  \fBform_field_just\fR(3X)
145 set_field_opts  \fBform_field_opts\fR(3X)
146 set_field_pad   \fBform_field_attributes\fR(3X)
147 set_field_status        \fBform_field_buffer\fR(3X)
148 set_field_term  \fBform_hook\fR(3X)
149 set_field_type  \fBform_field_validation\fR(3X)
150 set_field_userptr       \fBform_field_userptr\fR(3X)
151 set_fieldtype_arg       \fBform_fieldtype\fR(3X)
152 set_fieldtype_choice    \fBform_fieldtype\fR(3X)
153 set_form_fields \fBform_field\fR(3X)
154 set_form_init   \fBform_hook\fR(3X)
155 set_form_opts   \fBform_field_opts\fR(3X)
156 set_form_page   \fBform_page\fR(3X)
157 set_form_sub    \fBform_win\fR(3X)
158 set_form_term   \fBform_hook\fR(3X)
159 set_form_userptr        \fBform_userptr\fR(3X)
160 set_form_win    \fBform_win\fR(3X)
161 set_max_field   \fBform_field_buffer\fR(3X)
162 set_new_page    \fBform_new_page\fR(3X)
163 unfocus_current_field   \fBform_page\fR(3X)*
164 unpost_form     \fBform_post\fR(3X)
165 .TE
166 .SH RETURN VALUE
167 Routines that return pointers return \fBNULL\fR on error,
168 and set \fBerrno\fP to the corresponding error-code returned by functions
169 returning an integer.
170 Routines that return
171 an integer return one of the following error codes:
172 .TP 5
173 .B E_OK
174 The routine succeeded.
175 .TP 5
176 .B E_BAD_ARGUMENT
177 Routine detected an incorrect or out-of-range argument.
178 .TP 5
179 .B E_BAD_STATE
180 Routine was called from an initialization or termination function.
181 .TP 5
182 .B E_CONNECTED
183 The field is already connected to a form.
184 .TP 5
185 .B E_INVALID_FIELD
186 Contents of a field are not valid.
187 .TP 5
188 .B E_NOT_CONNECTED
189 No fields are connected to the form.
190 .TP 5
191 .B E_NOT_POSTED
192 The form has not been posted.
193 .TP 5
194 .B E_NO_ROOM
195 Form is too large for its window.
196 .TP 5
197 .B E_POSTED
198 The form is already posted.
199 .TP 5
200 .B E_REQUEST_DENIED
201 The form driver could not process the request.
202 .TP 5
203 .B E_SYSTEM_ERROR
204 System error occurred (see \fBerrno\fR(3)).
205 .TP 5
206 .B E_UNKNOWN_COMMAND
207 The form driver code saw an unknown request code.
208 .SH NOTES
209 The header file \fB<form.h>\fR automatically includes the header files
210 \fB<curses.h>\fR and \fB<eti.h>\fR.
211 .PP
212 In your library list, libform.a should be before libncurses.a; that is,
213 you want to say \*(``\-lform \-lncurses\*('', not the other way around
214 (which would give you a link error when using static libraries).
215 .SH PORTABILITY
216 These routines emulate the System V forms library.
217 They were not supported on
218 Version 7 or BSD versions.
219 .PP
220 The menu facility was documented in SVr4.2 in
221 \fICharacter User Interface Programming (UNIX SVR4.2)\fP.
222 .PP
223 It is not part of X/Open Curses.
224 .PP
225 Aside from ncurses, there are few implementations:
226 .bP
227 systems based on SVr4 source code, e.g., Solaris.
228 .bP
229 NetBSD curses.
230 .PP
231 A few functions in this implementation are extensions added for ncurses,
232 but not provided by other implementations, e.g.,
233 \fBform_driver_w\fP,
234 \fBunfocus_current_field\fP.
235 .SH AUTHORS
236 Juergen Pfeifer.
237 Manual pages and adaptation for ncurses by Eric
238 S. Raymond.
239 .SH SEE ALSO
240 \fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed
241 descriptions of the entry points.
242 .PP
243 This describes \fBncurses\fR
244 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).