2
2
.\"***************************************************************************
3
.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. *
3
.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. *
5
5
.\" Permission is hereby granted, free of charge, to any person obtaining a *
6
6
.\" copy of this software and associated documentation files (the *
27
27
.\" authorization. *
28
28
.\"***************************************************************************
30
.\" $Id: form_field_new.3x,v 1.12 2003/05/10 20:33:49 jmc Exp $
30
.\" $Id: form_field_new.3x,v 1.16 2007/06/02 20:40:07 tom Exp $
31
31
.TH form_field_new 3X ""
33
33
\fBform_field_new\fR - create and destroy form fields
48
48
The function \fBnew_field\fR allocates a new field and initializes it from the
49
49
parameters given: height, width, row of upper-left corner, column of upper-left
50
50
corner, number off-screen rows, and number of additional working buffers.
52
52
The function \fBdup_field\fR duplicates a field at a new location. Most
53
53
attributes (including current contents, size, validation type, buffer count,
54
54
growth threshold, justification, foreground, background, pad character,
55
55
options, and user pointer) are copied. Field status and the field page bit are
58
58
The function \fBlink_field\fR acts like \fBdup_field\fR, but the new field
59
59
shares buffers with its parent. Attribute data is separate.
61
61
The function \fBfree_field\fR de-allocates storage associated with a field.
63
63
The function, \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return
64
64
\fBNULL\fR on error.
65
They set errno according to their success:
68
The routine succeeded.
71
Routine detected an incorrect or out-of-range argument.
74
System error occurred, e.g., malloc failure.
66
76
The function \fBfree_field\fR returns one of the following:
69
79
The routine succeeded.
72
System error occurred (see \fBerrno\fR).
75
82
Routine detected an incorrect or out-of-range argument.
77
87
\fBcurses\fR(3X), \fBform\fR(3X).
82
92
These routines emulate the System V forms library. They were not supported on
83
93
Version 7 or BSD versions.
85
95
It may be unwise to count on the set of attributes copied by
86
\fBdup_field\fR(3X) being portable; the System V forms library documents are
87
not very explicit about what gets copied and what doesn't.
96
\fBdup_field\fR being portable; the System V forms library documents are
97
not very explicit about what gets copied and what does not.
89
99
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric