~ubuntu-branches/debian/sid/ncurses/sid-200908151543

« back to all changes in this revision

Viewing changes to man/form_field_new.3x

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Baumann
  • Date: 2008-12-14 21:06:00 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20081214210600-2rdjwvpplgvh3zeb
Tags: 5.7+20081213-1
MergingĀ upstreamĀ versionĀ 5.7+20081213.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
'\" t
2
2
.\"***************************************************************************
3
 
.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
 
3
.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc.              *
4
4
.\"                                                                          *
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
.\"***************************************************************************
29
29
.\"
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 ""
32
32
.SH NAME
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.
51
 
 
 
51
.PP
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
56
56
not copied.
57
 
 
 
57
.PP
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.
60
 
 
 
60
.PP
61
61
The function \fBfree_field\fR de-allocates storage associated with a field.
62
62
.SH RETURN VALUE
63
63
The function, \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return
64
64
\fBNULL\fR on error.
65
 
 
 
65
They set errno according to their success:
 
66
.TP 5
 
67
.B E_OK
 
68
The routine succeeded.
 
69
.TP 5
 
70
.B E_BAD_ARGUMENT
 
71
Routine detected an incorrect or out-of-range argument.
 
72
.TP 5
 
73
.B E_SYSTEM_ERROR
 
74
System error occurred, e.g., malloc failure.
 
75
.PP
66
76
The function \fBfree_field\fR returns one of the following:
67
77
.TP 5
68
 
\fBE_OK\fR
 
78
.B E_OK
69
79
The routine succeeded.
70
80
.TP 5
71
 
\fBE_SYSTEM_ERROR\fR
72
 
System error occurred (see \fBerrno\fR).
73
 
.TP 5
74
 
\fBE_BAD_ARGUMENT\fR
 
81
.B E_BAD_ARGUMENT
75
82
Routine detected an incorrect or out-of-range argument.
 
83
.TP 5
 
84
.B E_CONNECTED
 
85
field is connected.
76
86
.SH SEE ALSO
77
87
\fBcurses\fR(3X), \fBform\fR(3X).
78
88
.SH NOTES
81
91
.SH PORTABILITY
82
92
These routines emulate the System V forms library.  They were not supported on
83
93
Version 7 or BSD versions.
84
 
 
 
94
.PP
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.
88
98
.SH AUTHORS
89
99
Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
90
100
S. Raymond.