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\&.
|
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 .LP
37 \fBnew_field()\fR creates a new field with \fIr\fR rows and \fIc\fR columns,
38 starting at \fIfrow\fR, \fIfcol\fR, in the subwindow of a form. \fInrow\fR is
39 the number of off-screen rows and \fInbuf\fR is the number of additional
40 working buffers. This routine returns a pointer to the new field.
41 .sp
42 .LP
43 \fBdup_field()\fR duplicates \fIfield\fR at the specified location. All field
44 attributes are duplicated, including the current contents of the field buffers.
45 .sp
46 .LP
47 \fBlink_field()\fR also duplicates \fIfield\fR at the specified location.
48 However, unlike \fBdup_field()\fR, the new field shares the field buffers with
49 the original field. After creation, the attributes of the new field can be
50 changed without affecting the original field.
51 .sp
52 .LP
53 \fBfree_field()\fR frees the storage allocated for \fIfield\fR.
54 .SH RETURN VALUES
55 .LP
56 Routines that return pointers return \fINULL\fR on error. \fBfree_field()\fR
57 returns one of the following:
58 .sp
59 .ne 2
60 .na
61 \fBE_OK\fR
62 .ad
63 .RS 18n
64 The function returned successfully.
65 .RE
66
67 .sp
68 .ne 2
69 .na
70 \fBE_CONNECTED\fR
71 .ad
72 .RS 18n
73 The field is already connected to a form.
74 .RE
75
76 .sp
77 .ne 2
78 .na
79 \fBE_SYSTEM_ERROR\fR
80 .ad
81 .RS 18n
82 System error.
83 .RE
84
85 .sp
86 .ne 2
87 .na
88 \fBE_BAD_ARGUMENT\fR
89 .ad
90 .RS 18n
91 An argument is incorrect.
92 .RE
93
94 .SH ATTRIBUTES
95 .LP
96 See \fBattributes\fR(5) for descriptions of the following attributes:
97 .sp
98
99 .sp
100 .TS
101 box;
102 c | c
103 l | l .
104 ATTRIBUTE TYPE ATTRIBUTE VALUE
105 _
106 MT-Level Unsafe
107 .TE
108
109 .SH SEE ALSO
110 .LP
111 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
112 .SH NOTES
113 .LP
114 The header \fB<form.h>\fR automatically includes the headers \fB<eti.h>\fR and
115 \fB<curses.h>\fR\&.
|