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