ncurses 6.4 - patch 20231016

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

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

 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright 2018-2022,2023 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 +27,81 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.'" $Id: form_field_new.3x,v 1.9 1998/11/29 01:06:44 Rick.Ohnemus Exp $
-.TH form_field_new 3X ""
+.\" $Id: form_field_new.3x,v 1.37 2023/10/07 21:19:07 tom Exp $
+.TH form_field_new 3X 2023-10-07 "ncurses 6.4" "Library calls"

 .SH NAME
 .SH NAME

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

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <form.h>\fR
-.br
-FIELD *new_field(int height, int width,
-                 int toprow, int leftcol,
-                 int offscreen, int nbuffers);
-.br
-FIELD *dup_field(FIELD *field, int toprow, int leftcol);
-.br
-FIELD *link_field(FIELD *field, int toprow, int leftcol);
-.br
-int free_field(FIELD *field);
-.br
+.nf
+\fB#include <form.h>
+.PP
+\fBFIELD *new_field(int \fIheight\fP, int \fIwidth\fP,
+                 \fBint \fItoprow\fB, int \fIleftcol\fB,\fR
+                 \fBint \fIoffscreen\fB, int \fInbuffers\fB);\fR
+\fBFIELD *dup_field(FIELD *\fIfield\fB, int \fItoprow\fB, int \fIleftcol\fB);\fR
+\fBFIELD *link_field(FIELD *\fIfield\fB, int \fItoprow\fB, int \fIleftcol\fB);\fR
+\fBint free_field(FIELD *\fIfield\fB);\fR
+.fi

 .SH DESCRIPTION
 .SH DESCRIPTION

-The function \fBnew_field\fR allocates a new field and initializes it from the
+The function \fBnew_field\fP 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.
 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\fP 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.

-
-The function \fBlink_field\fR acts like \fBdup_field\fR, but the new field
-shares buffers with its parent.  Attribute data is separate.
-
-The function \fBfree_field\fR de-allocates storage associated with a field.
+.PP
+The function \fBlink_field\fP acts like \fBdup_field\fP, but the new field
+shares buffers with its parent.
+Attribute data is separate.
+.PP
+The function \fBfree_field\fP de-allocates storage associated with a field.

 .SH RETURN VALUE
 .SH RETURN VALUE

-The function, \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return
-\fBNULL\fR on error.
-
-The function \fBfree_field\fR returns one of the following:
+The functions \fBnew_field\fP, \fBdup_field\fP, \fBlink_field\fP return
+\fBNULL\fP on error.
+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\fP 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.

-.SH SEE ALSO
-\fBcurses\fR(3X), \fBform\fR(3X).
+.TP 5
+.B E_CONNECTED
+field is connected.

 .SH NOTES
 .SH NOTES

-The header file \fB<form.h>\fR automatically includes the header file
-\fB<curses.h>\fR.
+The header file \fB<form.h>\fP automatically includes the header file
+\fB<curses.h>\fP.

 .SH PORTABILITY
 .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\fP 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.
+.SH SEE ALSO
+\fB\%curses\fP(3X),
+\fB\%form\fP(3X)