1forms(3CURSES) Curses Library Functions forms(3CURSES)
2
6 forms - character based forms package
7
9 #include <form.h>
10
13 The form library is built using the curses library, and any program
14 using forms routines must call one of the curses initialization rou‐
15 tines such as initscr. A program using these routines must be compiled
16 with -lform and -lcurses on the cc command line.
17 The forms package gives the applications programmer a terminal-indepen‐
20 dent method of creating and customizing forms for user-interaction. The
21 forms package includes: field routines, which are used to create and
22 customize fields, link fields and assign field types; fieldtype rou‐
23 tines, which are used to create new field types for validating fields;
24 and form routines, which are used to create and customize forms, assign
25 pre/post processing functions, and display and interact with forms.
26 Current Default Values for Field Attributes
28 The forms package establishes initial current default values for field
29 attributes. During field initialization, each field attribute is
30 assigned the current default value for that attribute. An application
31 can change or retrieve a current default attribute value by calling the
32 appropriate set or retrieve routine with a NULL field pointer. If an
33 application changes a current default field attribute value, subsequent
34 fields created using new_field() will have the new default attribute
35 value. (The attributes of previously created fields are not changed if
36 a current default attribute value is changed.)
37 Routine Name Index
39 The following table lists each forms routine and the name of the manual
40 page on which it is described.
41 forms Routine Name Manual Page Name
43 current_field [22mform_page(3X)
46 data_ahead [22mform_data(3X)
49 data_behind [22mform_data(3X)
52 dup_field [22mform_field_new(3X)
55 dynamic_field_info [22mform_field_info(3X)
58 field_arg [22mform_field_validation(3X)
61 field_back [22mform_field_attributes(3X)
64 field_buffer [22mform_field_buffer(3X)
67 field_count [22mform_field(3X)
70 field_fore [22mform_field_attributes(3X)
73 field_index [22mform_page(3X)
76 field_info [22mform_field_info(3X)
79 field_init [22mform_hook(3X)
82 field_just [22mform_field_just(3X)
85 field_opts [22mform_field_opts(3X)
88 field_opts_off [22mform_field_opts(3X)
91 field_opts_on [22mform_field_opts(3X)
94 field_pad [22mform_field_attributes(3X)
97 field_status [22mform_field_buffer(3X)
100 field_term [22mform_hook(3X)
103 field_type [22mform_field_validation(3X)
106 field_userptr [22mform_field_userptr(3X)
109 form_driver [22mform_driver(3X)
112 form_fields [22mform_field(3X)
115 form_init [22mform_hook(3X)
118 form_opts [22mform_opts(3X)
121 form_opts_off [22mform_opts(3X)
124 form_opts_on [22mform_opts(3X)
127 form_page [22mform_page(3X)
130 form_sub [22mform_win(3X)
133 form_term [22mform_hook(3X)
136 form_userptr [22mform_userptr(3X)
139 form_win [22mform_win(3X)
142 free_field [22mform_field_new(3X)
145 free_fieldtype [22mform_fieldtype(3X)
148 free_form [22mform_new(3X)
151 link_field [22mform_field_new(3X)
154 link_fieldtype [22mform_fieldtype(3X)
157 move_field [22mform_field(3X)
160 new_field [22mform_field_new(3X)
163 new_fieldtype [22mform_fieldtype(3X)
166 new_form [22mform_new(3X)
169 new_page [22mform_new_page(3X)
172 pos_form_cursor [22mform_cursor(3X)
175 post_form [22mform_post(3X)
178 scale_form [22mform_win(3X)
181 set_current_field [22mform_page(3X)
184 set_field_back [22mform_field_attributes(3X)
187 set_field_buffer [22mform_field_buffer(3X)
190 set_field_fore [22mform_field_attributes(3X)
193 set_field_init [22mform_hook(3X)
196 set_field_just [22mform_field_just(3X)
199 set_field_opts [22mform_field_opts(3X)
202 set_field_pad [22mform_field_attributes(3X)
205 set_field_status [22mform_field_buffer(3X)
208 set_field_term [22mform_hook(3X)
211 set_field_type [22mform_field_validation(3X)
214 set_field_userptr [22mform_field_userptr(3X)
217 set_fieldtype_arg [22mform_fieldtype(3X)
220 set_fieldtype_choice [22mform_fieldtype(3X)
223 set_form_fields [22mform_field(3X)
226 set_form_init [22mform_hook(3X)
229 set_form_opts [22mform_opts(3X)
232 set_form_page [22mform_page(3X)
235 set_form_sub [22mform_win(3X)
238 set_form_term [22mform_hook(3X)
241 set_form_userptr [22mform_userptr(3X)
244 set_form_win [22mform_win(3X)
247 set_max_field [22mform_field_buffer(3X)
250 set_new_page [22mform_new_page(3X)
253 unpost_form [22mform_post(3X)
256
259 Routines that return a pointer always return NULL on error. Routines
260 that return an integer return one of the following:
261 E_OK The function returned successfully.
263 E_CONNECTED The field is already connected to a form.
266 E_SYSTEM_ERROR System error.
269 E_BAD_ARGUMENT An argument is incorrect.
272 E_CURRENT The field is the current field.
275 E_POSTED The form is posted.
278 E_NOT_POSTED The form is not posted.
281 E_INVALID_FIELD The field contents are invalid.
284 E_NOT_CONNECTED The field is not connected to a form.
287 E_NO_ROOM The form does not fit in the subwindow.
290 E_BAD_STATE The routine was called from an initialization or
293 termination function.
294 E_REQUEST_DENIED The form driver request failed.
297 E_UNKNOWN_COMMAND An unknown request was passed to the form driver.
300
303 See attributes(5) for descriptions of the following attributes:
304 ┌─────────────────────────────┬─────────────────────────────┐
309 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
310 ├─────────────────────────────┼─────────────────────────────┤
311 │MT-Level │Unsafe │
312 └─────────────────────────────┴─────────────────────────────┘
313
315 curses(3CURSES), attributes(5)
316
318 The header <form.h> automatically includes the headers <eti.h> and
319 <curses.h>.
320SunOS 5.11 31 Dec 1996 forms(3CURSES)