| blob | 3f244d3c79de52f3f05bb7aff9cac04dca8e7cc7 |
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH FORMS 3CURSES "Dec 31, 1996"
8 .SH NAME
9 forms \- character based forms package
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB#include <form.h>\fR
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The \fBform\fR library is built using the \fBcurses\fR library, and any program
20 using \fBforms\fR routines must call one of the \fBcurses\fR initialization
21 routines such as \fBinitscr\fR. A program using these routines must be compiled
22 with \fB-lform\fR and \fB-lcurses\fR on the \fBcc\fR command line.
23 .sp
24 .LP
25 The \fBforms\fR package gives the applications programmer a
26 terminal-independent method of creating and customizing forms for
27 user-interaction. The \fBforms\fR package includes: field routines, which are
28 used to create and customize fields, link fields and assign field types;
29 fieldtype routines, which are used to create new field types for validating
30 fields; and form routines, which are used to create and customize forms, assign
31 pre/post processing functions, and display and interact with forms.
32 .SS "Current Default Values for Field Attributes"
33 .sp
34 .LP
35 The \fBforms\fR package establishes initial current default values for field
36 attributes. During field initialization, each field attribute is assigned the
37 current default value for that attribute. An application can change or retrieve
38 a current default attribute value by calling the appropriate set or retrieve
39 routine with a \fINULL\fR field pointer. If an application changes a current
40 default field attribute value, subsequent fields created using
41 \fBnew_field()\fR will have the new default attribute value. (The attributes of
42 previously created fields are not changed if a current default attribute value
43 is changed.)
44 .SS "Routine Name Index"
45 .sp
46 .LP
47 The following table lists each \fBforms\fR routine and the name of the manual
48 page on which it is described.
49 .sp
50 .ne 2
51 .na
52 \fBforms Routine Name\fR
53 .ad
54 .RS 25n
55 \fBManual Page Name\fR
56 .RE
58 .sp
59 .ne 2
60 .na
61 \fBcurrent_field\fR
62 .ad
63 .RS 25n
64 form_page(3X)
65 .RE
67 .sp
68 .ne 2
69 .na
70 \fBdata_ahead\fR
71 .ad
72 .RS 25n
73 form_data(3X)
74 .RE
76 .sp
77 .ne 2
78 .na
79 \fBdata_behind\fR
80 .ad
81 .RS 25n
82 form_data(3X)
83 .RE
85 .sp
86 .ne 2
87 .na
88 \fBdup_field\fR
89 .ad
90 .RS 25n
91 form_field_new(3X)
92 .RE
94 .sp
95 .ne 2
96 .na
97 \fBdynamic_field_info\fR
98 .ad
99 .RS 25n
100 form_field_info(3X)
101 .RE
103 .sp
104 .ne 2
105 .na
106 \fBfield_arg\fR
107 .ad
108 .RS 25n
109 form_field_validation(3X)
110 .RE
112 .sp
113 .ne 2
114 .na
115 \fBfield_back\fR
116 .ad
117 .RS 25n
118 form_field_attributes(3X)
119 .RE
121 .sp
122 .ne 2
123 .na
124 \fBfield_buffer\fR
125 .ad
126 .RS 25n
127 form_field_buffer(3X)
128 .RE
130 .sp
131 .ne 2
132 .na
133 \fBfield_count\fR
134 .ad
135 .RS 25n
136 form_field(3X)
137 .RE
139 .sp
140 .ne 2
141 .na
142 \fBfield_fore\fR
143 .ad
144 .RS 25n
145 form_field_attributes(3X)
146 .RE
148 .sp
149 .ne 2
150 .na
151 \fBfield_index\fR
152 .ad
153 .RS 25n
154 form_page(3X)
155 .RE
157 .sp
158 .ne 2
159 .na
160 \fBfield_info\fR
161 .ad
162 .RS 25n
163 form_field_info(3X)
164 .RE
166 .sp
167 .ne 2
168 .na
169 \fBfield_init\fR
170 .ad
171 .RS 25n
172 form_hook(3X)
173 .RE
175 .sp
176 .ne 2
177 .na
178 \fBfield_just\fR
179 .ad
180 .RS 25n
181 form_field_just(3X)
182 .RE
184 .sp
185 .ne 2
186 .na
187 \fBfield_opts\fR
188 .ad
189 .RS 25n
190 form_field_opts(3X)
191 .RE
193 .sp
194 .ne 2
195 .na
196 \fBfield_opts_off\fR
197 .ad
198 .RS 25n
199 form_field_opts(3X)
200 .RE
202 .sp
203 .ne 2
204 .na
205 \fBfield_opts_on\fR
206 .ad
207 .RS 25n
208 form_field_opts(3X)
209 .RE
211 .sp
212 .ne 2
213 .na
214 \fBfield_pad\fR
215 .ad
216 .RS 25n
217 form_field_attributes(3X)
218 .RE
220 .sp
221 .ne 2
222 .na
223 \fBfield_status\fR
224 .ad
225 .RS 25n
226 form_field_buffer(3X)
227 .RE
229 .sp
230 .ne 2
231 .na
232 \fBfield_term\fR
233 .ad
234 .RS 25n
235 form_hook(3X)
236 .RE
238 .sp
239 .ne 2
240 .na
241 \fBfield_type\fR
242 .ad
243 .RS 25n
244 form_field_validation(3X)
245 .RE
247 .sp
248 .ne 2
249 .na
250 \fBfield_userptr\fR
251 .ad
252 .RS 25n
253 form_field_userptr(3X)
254 .RE
256 .sp
257 .ne 2
258 .na
259 \fBform_driver\fR
260 .ad
261 .RS 25n
262 form_driver(3X)
263 .RE
265 .sp
266 .ne 2
267 .na
268 \fBform_fields\fR
269 .ad
270 .RS 25n
271 form_field(3X)
272 .RE
274 .sp
275 .ne 2
276 .na
277 \fBform_init\fR
278 .ad
279 .RS 25n
280 form_hook(3X)
281 .RE
283 .sp
284 .ne 2
285 .na
286 \fBform_opts\fR
287 .ad
288 .RS 25n
289 form_opts(3X)
290 .RE
292 .sp
293 .ne 2
294 .na
295 \fBform_opts_off\fR
296 .ad
297 .RS 25n
298 form_opts(3X)
299 .RE
301 .sp
302 .ne 2
303 .na
304 \fBform_opts_on\fR
305 .ad
306 .RS 25n
307 form_opts(3X)
308 .RE
310 .sp
311 .ne 2
312 .na
313 \fBform_page\fR
314 .ad
315 .RS 25n
316 form_page(3X)
317 .RE
319 .sp
320 .ne 2
321 .na
322 \fBform_sub\fR
323 .ad
324 .RS 25n
325 form_win(3X)
326 .RE
328 .sp
329 .ne 2
330 .na
331 \fBform_term\fR
332 .ad
333 .RS 25n
334 form_hook(3X)
335 .RE
337 .sp
338 .ne 2
339 .na
340 \fBform_userptr\fR
341 .ad
342 .RS 25n
343 form_userptr(3X)
344 .RE
346 .sp
347 .ne 2
348 .na
349 \fBform_win\fR
350 .ad
351 .RS 25n
352 form_win(3X)
353 .RE
355 .sp
356 .ne 2
357 .na
358 \fBfree_field\fR
359 .ad
360 .RS 25n
361 form_field_new(3X)
362 .RE
364 .sp
365 .ne 2
366 .na
367 \fBfree_fieldtype\fR
368 .ad
369 .RS 25n
370 form_fieldtype(3X)
371 .RE
373 .sp
374 .ne 2
375 .na
376 \fBfree_form\fR
377 .ad
378 .RS 25n
379 form_new(3X)
380 .RE
382 .sp
383 .ne 2
384 .na
385 \fBlink_field\fR
386 .ad
387 .RS 25n
388 form_field_new(3X)
389 .RE
391 .sp
392 .ne 2
393 .na
394 \fBlink_fieldtype\fR
395 .ad
396 .RS 25n
397 form_fieldtype(3X)
398 .RE
400 .sp
401 .ne 2
402 .na
403 \fBmove_field\fR
404 .ad
405 .RS 25n
406 form_field(3X)
407 .RE
409 .sp
410 .ne 2
411 .na
412 \fBnew_field\fR
413 .ad
414 .RS 25n
415 form_field_new(3X)
416 .RE
418 .sp
419 .ne 2
420 .na
421 \fBnew_fieldtype\fR
422 .ad
423 .RS 25n
424 form_fieldtype(3X)
425 .RE
427 .sp
428 .ne 2
429 .na
430 \fBnew_form\fR
431 .ad
432 .RS 25n
433 form_new(3X)
434 .RE
436 .sp
437 .ne 2
438 .na
439 \fBnew_page\fR
440 .ad
441 .RS 25n
442 form_new_page(3X)
443 .RE
445 .sp
446 .ne 2
447 .na
448 \fBpos_form_cursor\fR
449 .ad
450 .RS 25n
451 form_cursor(3X)
452 .RE
454 .sp
455 .ne 2
456 .na
457 \fBpost_form\fR
458 .ad
459 .RS 25n
460 form_post(3X)
461 .RE
463 .sp
464 .ne 2
465 .na
466 \fBscale_form\fR
467 .ad
468 .RS 25n
469 form_win(3X)
470 .RE
472 .sp
473 .ne 2
474 .na
475 \fBset_current_field\fR
476 .ad
477 .RS 25n
478 form_page(3X)
479 .RE
481 .sp
482 .ne 2
483 .na
484 \fBset_field_back\fR
485 .ad
486 .RS 25n
487 form_field_attributes(3X)
488 .RE
490 .sp
491 .ne 2
492 .na
493 \fBset_field_buffer\fR
494 .ad
495 .RS 25n
496 form_field_buffer(3X)
497 .RE
499 .sp
500 .ne 2
501 .na
502 \fBset_field_fore\fR
503 .ad
504 .RS 25n
505 form_field_attributes(3X)
506 .RE
508 .sp
509 .ne 2
510 .na
511 \fBset_field_init\fR
512 .ad
513 .RS 25n
514 form_hook(3X)
515 .RE
517 .sp
518 .ne 2
519 .na
520 \fB set_field_just\fR
521 .ad
522 .RS 25n
523 form_field_just(3X)
524 .RE
526 .sp
527 .ne 2
528 .na
529 \fBset_field_opts\fR
530 .ad
531 .RS 25n
532 form_field_opts(3X)
533 .RE
535 .sp
536 .ne 2
537 .na
538 \fBset_field_pad\fR
539 .ad
540 .RS 25n
541 form_field_attributes(3X)
542 .RE
544 .sp
545 .ne 2
546 .na
547 \fBset_field_status\fR
548 .ad
549 .RS 25n
550 form_field_buffer(3X)
551 .RE
553 .sp
554 .ne 2
555 .na
556 \fBset_field_term\fR
557 .ad
558 .RS 25n
559 form_hook(3X)
560 .RE
562 .sp
563 .ne 2
564 .na
565 \fBset_field_type\fR
566 .ad
567 .RS 25n
568 form_field_validation(3X)
569 .RE
571 .sp
572 .ne 2
573 .na
574 \fBset_field_userptr\fR
575 .ad
576 .RS 25n
577 form_field_userptr(3X)
578 .RE
580 .sp
581 .ne 2
582 .na
583 \fBset_fieldtype_arg\fR
584 .ad
585 .RS 25n
586 form_fieldtype(3X)
587 .RE
589 .sp
590 .ne 2
591 .na
592 \fBset_fieldtype_choice\fR
593 .ad
594 .RS 25n
595 form_fieldtype(3X)
596 .RE
598 .sp
599 .ne 2
600 .na
601 \fBset_form_fields\fR
602 .ad
603 .RS 25n
604 form_field(3X)
605 .RE
607 .sp
608 .ne 2
609 .na
610 \fBset_form_init\fR
611 .ad
612 .RS 25n
613 form_hook(3X)
614 .RE
616 .sp
617 .ne 2
618 .na
619 \fBset_form_opts\fR
620 .ad
621 .RS 25n
622 form_opts(3X)
623 .RE
625 .sp
626 .ne 2
627 .na
628 \fBset_form_page\fR
629 .ad
630 .RS 25n
631 form_page(3X)
632 .RE
634 .sp
635 .ne 2
636 .na
637 \fBset_form_sub\fR
638 .ad
639 .RS 25n
640 form_win(3X)
641 .RE
643 .sp
644 .ne 2
645 .na
646 \fBset_form_term\fR
647 .ad
648 .RS 25n
649 form_hook(3X)
650 .RE
652 .sp
653 .ne 2
654 .na
655 \fBset_form_userptr\fR
656 .ad
657 .RS 25n
658 form_userptr(3X)
659 .RE
661 .sp
662 .ne 2
663 .na
664 \fBset_form_win\fR
665 .ad
666 .RS 25n
667 form_win(3X)
668 .RE
670 .sp
671 .ne 2
672 .na
673 \fBset_max_field\fR
674 .ad
675 .RS 25n
676 form_field_buffer(3X)
677 .RE
679 .sp
680 .ne 2
681 .na
682 \fBset_new_page\fR
683 .ad
684 .RS 25n
685 form_new_page(3X)
686 .RE
688 .sp
689 .ne 2
690 .na
691 \fBunpost_form\fR
692 .ad
693 .RS 25n
694 form_post(3X)
695 .RE
697 .SH RETURN VALUES
698 .sp
699 .LP
700 Routines that return a pointer always return \fINULL\fR on error. Routines that
701 return an integer return one of the following:
702 .sp
703 .ne 2
704 .na
705 \fB\fBE_OK\fR\fR
706 .ad
707 .RS 21n
708 The function returned successfully.
709 .RE
711 .sp
712 .ne 2
713 .na
714 \fB\fBE_CONNECTED\fR\fR
715 .ad
716 .RS 21n
717 The field is already connected to a form.
718 .RE
720 .sp
721 .ne 2
722 .na
723 \fB\fBE_SYSTEM_ERROR\fR\fR
724 .ad
725 .RS 21n
726 System error.
727 .RE
729 .sp
730 .ne 2
731 .na
732 \fB\fBE_BAD_ARGUMENT\fR\fR
733 .ad
734 .RS 21n
735 An argument is incorrect.
736 .RE
738 .sp
739 .ne 2
740 .na
741 \fB\fBE_CURRENT\fR\fR
742 .ad
743 .RS 21n
744 The field is the current field.
745 .RE
747 .sp
748 .ne 2
749 .na
750 \fB\fBE_POSTED\fR\fR
751 .ad
752 .RS 21n
753 The form is posted.
754 .RE
756 .sp
757 .ne 2
758 .na
759 \fB\fBE_NOT_POSTED\fR\fR
760 .ad
761 .RS 21n
762 The form is not posted.
763 .RE
765 .sp
766 .ne 2
767 .na
768 \fB\fBE_INVALID_FIELD\fR\fR
769 .ad
770 .RS 21n
771 The field contents are invalid.
772 .RE
774 .sp
775 .ne 2
776 .na
777 \fB\fBE_NOT_CONNECTED\fR\fR
778 .ad
779 .RS 21n
780 The field is not connected to a form.
781 .RE
783 .sp
784 .ne 2
785 .na
786 \fB\fBE_NO_ROOM\fR\fR
787 .ad
788 .RS 21n
789 The form does not fit in the subwindow.
790 .RE
792 .sp
793 .ne 2
794 .na
795 \fB\fBE_BAD_STATE\fR\fR
796 .ad
797 .RS 21n
798 The routine was called from an initialization or termination function.
799 .RE
801 .sp
802 .ne 2
803 .na
804 \fB\fBE_REQUEST_DENIED\fR\fR
805 .ad
806 .RS 21n
807 The form driver request failed.
808 .RE
810 .sp
811 .ne 2
812 .na
813 \fB\fBE_UNKNOWN_COMMAND\fR\fR
814 .ad
815 .RS 21n
816 An unknown request was passed to the form driver.
817 .RE
819 .SH ATTRIBUTES
820 .sp
821 .LP
822 See \fBattributes\fR(5) for descriptions of the following attributes:
823 .sp
825 .sp
826 .TS
827 box;
828 c | c
829 l | l .
830 ATTRIBUTE TYPE ATTRIBUTE VALUE
831 _
832 MT-Level Unsafe
833 .TE
835 .SH SEE ALSO
836 .sp
837 .LP
838 \fBcurses\fR(3CURSES), \fBattributes\fR(5)
839 .SH NOTES
840 .sp
841 .LP
842 The header \fB<form.h>\fR automatically includes the headers \fB<eti.h>\fR and
843 \fB<curses.h>\fR\&.