ncurses 6.2 - patch 20201219

[ncurses.git] / man / form_field_new.3x

diff --git a/man/form_field_new.3x b/man/form_field_new.3x
index b798b5bb3e95bc8d83548bb46d616c9cdde07ee1..1a240d0a7fc3acb400798b4503b21232090eece8 100644 (file)
--- a/man/form_field_new.3x
+++ b/man/form_field_new.3x
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright 2018,2020 Thomas E. Dickey                                     *
+.\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,70 +28,81 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.'" $Id: form_field_new.3x,v 1.9 1998/11/29 01:06:44 Rick.Ohnemus Exp $
+.\" $Id: form_field_new.3x,v 1.24 2020/10/24 09:09:18 tom Exp $

 .TH form_field_new 3X ""
 .SH NAME
 .TH form_field_new 3X ""
 .SH NAME

-\fBform_field_new\fR - create and destroy form fields
+\fBnew_field\fR,
+\fBdup_field\fR,
+\fBlink_field\fR,
+\fBfree_field\fR \- create and destroy form fields

 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .SH SYNOPSIS
 \fB#include <form.h>\fR

+.sp
+\fBFIELD *new_field(int \fP\fIheight\fP\fB, int \fP\fIwidth\fP\fB,\fP
+                 \fBint \fP\fItoprow\fP\fB, int \fP\fIleftcol\fP\fB,\fP
+                 \fBint \fP\fIoffscreen\fP\fB, int \fP\fInbuffers\fP\fB);\fP

 .br
 .br

-FIELD *new_field(int height, int width,
-                 int toprow, int leftcol,
-                 int offscreen, int nbuffers);
+\fBFIELD *dup_field(FIELD *\fP\fIfield\fP\fB, int \fP\fItoprow\fP\fB, int \fP\fIleftcol\fP\fB);\fP

 .br
 .br

-FIELD *dup_field(FIELD *field, int toprow, int leftcol);
+\fBFIELD *link_field(FIELD *\fP\fIfield\fP\fB, int \fP\fItoprow\fP\fB, int \fP\fIleftcol\fP\fB);\fP

 .br
 .br

-FIELD *link_field(FIELD *field, int toprow, int leftcol);
-.br
-int free_field(FIELD *field);
+\fBint free_field(FIELD *\fP\fIfield\fP\fB);\fP

 .br
 .SH DESCRIPTION
 The function \fBnew_field\fR allocates a new field and initializes it from the
 parameters given: height, width, row of upper-left corner, column of upper-left
 corner, number off-screen rows, and number of additional working buffers.
 .br
 .SH DESCRIPTION
 The function \fBnew_field\fR allocates a new field and initializes it from the
 parameters given: height, width, row of upper-left corner, column of upper-left
 corner, number off-screen rows, and number of additional working buffers.

-
-The function \fBdup_field\fR duplicates a field at a new location.  Most
+.PP
+The function \fBdup_field\fR duplicates a field at a new location.
+Most

 attributes (including current contents, size, validation type, buffer count,
 growth threshold, justification, foreground, background, pad character,
 attributes (including current contents, size, validation type, buffer count,
 growth threshold, justification, foreground, background, pad character,

-options, and user pointer) are copied.  Field status and the field page bit are
+options, and user pointer) are copied.
+Field status and the field page bit are

 not copied.
 not copied.

-
+.PP

 The function \fBlink_field\fR acts like \fBdup_field\fR, but the new field
 The function \fBlink_field\fR acts like \fBdup_field\fR, but the new field

-shares buffers with its parent.  Attribute data is separate.
-
+shares buffers with its parent.
+Attribute data is separate.
+.PP

 The function \fBfree_field\fR de-allocates storage associated with a field.
 .SH RETURN VALUE
 The function \fBfree_field\fR de-allocates storage associated with a field.
 .SH RETURN VALUE

-The function, \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return
+The functions \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return

 \fBNULL\fR on error.
 \fBNULL\fR on error.

-
-The function \fBfree_field\fR returns one of the following:
+They set \fBerrno\fP according to their success:

 .TP 5
 .TP 5

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5

-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
+.B E_BAD_ARGUMENT
+Routine detected an incorrect or out-of-range argument.
+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred, e.g., malloc failure.
+.PP
+The function \fBfree_field\fR returns one of the following:
+.TP 5
+.B E_OK
+The routine succeeded.

 .TP 5
 .TP 5

-\fBE_BAD_ARGUMENT\fR
+.B E_BAD_ARGUMENT

 Routine detected an incorrect or out-of-range argument.
 Routine detected an incorrect or out-of-range argument.

+.TP 5
+.B E_CONNECTED
+field is connected.

 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .SH PORTABILITY
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .SH PORTABILITY

-These routines emulate the System V forms library.  They were not supported on
+These routines emulate the System V forms library.
+They were not supported on

 Version 7 or BSD versions.
 Version 7 or BSD versions.

-
+.PP

 It may be unwise to count on the set of attributes copied by
 It may be unwise to count on the set of attributes copied by

-\fBdup_field\fR(3X) being portable; the System V forms library documents are
-not very explicit on what gets copied and was not.
+\fBdup_field\fR being portable; the System V forms library documents are
+not very explicit about what gets copied and what does not.

 .SH AUTHORS
 .SH AUTHORS

-Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
-S. Raymond.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.