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 FORM_FIELD_NEW 3CURSES "Dec 31, 1996" 8 .SH NAME 9 form_field_new, new_field, dup_field, link_field, free_field \- create and 10 destroy forms fields 11 .SH SYNOPSIS 12 .LP 13 .nf 14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ] 15 #include <form.h> 16 17 \fBFIELD *\fR\fBnew_field\fR(\fBint\fR \fIr\fR, \fBint\fR \fIc\fR, \fBint\fR \fIfrow\fR, \fBint\fR \fIfcol\fR, \fBint\fR \fInrow\fR, \fBint\fR \fIncol\fR); 18 .fi 19 20 .LP 21 .nf 22 \fBFIELD *\fR\fBdup_field\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIfrow\fR, \fBint\fR \fIfcol\fR); 23 .fi 24 25 .LP 26 .nf 27 \fBFIELD *\fR\fBlink_field\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIfrow\fR, \fBint\fR \fIfcol\fR); 28 .fi 29 30 .LP 31 .nf 32 \fBint\fR \fBfree_field\fR(\fBFIELD *\fR\fIfield\fR); 33 .fi 34 35 .SH DESCRIPTION 36 .sp 37 .LP 38 \fBnew_field()\fR creates a new field with \fIr\fR rows and \fIc\fR columns, 39 starting at \fIfrow\fR, \fIfcol\fR, in the subwindow of a form. \fInrow\fR is 40 the number of off-screen rows and \fInbuf\fR is the number of additional 41 working buffers. This routine returns a pointer to the new field. 42 .sp 43 .LP 44 \fBdup_field()\fR duplicates \fIfield\fR at the specified location. All field 45 attributes are duplicated, including the current contents of the field buffers. 46 .sp 47 .LP 48 \fBlink_field()\fR also duplicates \fIfield\fR at the specified location. 49 However, unlike \fBdup_field()\fR, the new field shares the field buffers with 50 the original field. After creation, the attributes of the new field can be 51 changed without affecting the original field. 52 .sp 53 .LP 54 \fBfree_field()\fR frees the storage allocated for \fIfield\fR. 55 .SH RETURN VALUES 56 .sp 57 .LP 58 Routines that return pointers return \fINULL\fR on error. \fBfree_field()\fR 59 returns one of the following: 60 .sp 61 .ne 2 62 .na 63 \fBE_OK\fR 64 .ad 65 .RS 18n 66 Thefunction returned successfully. 67 .RE 68 69 .sp 70 .ne 2 71 .na 72 \fBE_CONNECTED\fR 73 .ad 74 .RS 18n 75 The field is already connected to a form. 76 .RE 77 78 .sp 79 .ne 2 80 .na 81 \fBE_SYSTEM_ERROR\fR 82 .ad 83 .RS 18n 84 System error. 85 .RE 86 87 .sp 88 .ne 2 89 .na 90 \fBE_BAD_ARGUMENT\fR 91 .ad 92 .RS 18n 93 An argument is incorrect. 94 .RE 95 96 .SH ATTRIBUTES 97 .sp 98 .LP 99 See \fBattributes\fR(5) for descriptions of the following attributes: 100 .sp 101 102 .sp 103 .TS 104 box; 105 c | c 106 l | l . 107 ATTRIBUTE TYPE ATTRIBUTE VALUE 108 _ 109 MT-Level Unsafe 110 .TE 111 112 .SH SEE ALSO 113 .sp 114 .LP 115 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5) 116 .SH NOTES 117 .sp 118 .LP 119 The header \fB<form.h>\fR automatically includes the headers \fB<eti.h>\fR and 120 \fB<curses.h>\fR\&.