]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/form_field_new.3x
ncurses 6.3 - patch 20220910
[ncurses.git] / man / form_field_new.3x
index 1a240d0a7fc3acb400798b4503b21232090eece8..05d6d03c7bbf16a695023ee7d31e6d3209b51544 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************
-.\" Copyright 2018,2020 Thomas E. Dickey                                     *
+.\" Copyright 2018-2021,2022 Thomas E. Dickey                                *
 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_field_new.3x,v 1.24 2020/10/24 09:09:18 tom Exp $
+.\" $Id: form_field_new.3x,v 1.27 2022/02/12 20:03:40 tom Exp $
 .TH form_field_new 3X ""
 .SH NAME
 .TH form_field_new 3X ""
 .SH NAME
-\fBnew_field\fR,
-\fBdup_field\fR,
-\fBlink_field\fR,
-\fBfree_field\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
+\fB#include <form.h>\fP
 .sp
 .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
+\fBFIELD *new_field(int \fIheight\fB, int \fIwidth\fB,\fR
+                 \fBint \fItoprow\fB, int \fIleftcol\fB,\fR
+                 \fBint \fIoffscreen\fB, int \fInbuffers\fB);\fR
 .br
 .br
-\fBFIELD *dup_field(FIELD *\fP\fIfield\fP\fB, int \fP\fItoprow\fP\fB, int \fP\fIleftcol\fP\fB);\fP
+\fBFIELD *dup_field(FIELD *\fIfield\fB, int \fItoprow\fB, int \fIleftcol\fB);\fR
 .br
 .br
-\fBFIELD *link_field(FIELD *\fP\fIfield\fP\fB, int \fP\fItoprow\fP\fB, int \fP\fIleftcol\fP\fB);\fP
+\fBFIELD *link_field(FIELD *\fIfield\fB, int \fItoprow\fB, int \fIleftcol\fB);\fR
 .br
 .br
-\fBint free_field(FIELD *\fP\fIfield\fP\fB);\fP
+\fBint free_field(FIELD *\fIfield\fB);\fR
 .br
 .SH DESCRIPTION
 .br
 .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.
 .PP
 parameters given: height, width, row of upper-left corner, column of upper-left
 corner, number off-screen rows, and number of additional working buffers.
 .PP
-The function \fBdup_field\fR duplicates a field at a new location.
+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,
 Most
 attributes (including current contents, size, validation type, buffer count,
 growth threshold, justification, foreground, background, pad character,
@@ -61,14 +61,14 @@ options, and user pointer) are copied.
 Field status and the field page bit are
 not copied.
 .PP
 Field status and the field page bit are
 not copied.
 .PP
-The function \fBlink_field\fR acts like \fBdup_field\fR, but the new field
+The function \fBlink_field\fP acts like \fBdup_field\fP, but the new field
 shares buffers with its parent.
 Attribute data is separate.
 .PP
 shares buffers with its parent.
 Attribute data is separate.
 .PP
-The function \fBfree_field\fR de-allocates storage associated with a field.
+The function \fBfree_field\fP de-allocates storage associated with a field.
 .SH RETURN VALUE
 .SH RETURN VALUE
-The functions \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return
-\fBNULL\fR on error.
+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
 .B E_OK
 They set \fBerrno\fP according to their success:
 .TP 5
 .B E_OK
@@ -80,7 +80,7 @@ Routine detected an incorrect or out-of-range argument.
 .B E_SYSTEM_ERROR
 System error occurred, e.g., malloc failure.
 .PP
 .B E_SYSTEM_ERROR
 System error occurred, e.g., malloc failure.
 .PP
-The function \fBfree_field\fR returns one of the following:
+The function \fBfree_field\fP returns one of the following:
 .TP 5
 .B E_OK
 The routine succeeded.
 .TP 5
 .B E_OK
 The routine succeeded.
@@ -91,17 +91,17 @@ Routine detected an incorrect or out-of-range argument.
 .B E_CONNECTED
 field is connected.
 .SH SEE ALSO
 .B E_CONNECTED
 field is connected.
 .SH SEE ALSO
-\fBcurses\fR(3X), \fBform\fR(3X).
+\fBcurses\fP(3X), \fBform\fP(3X).
 .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
 These routines emulate the System V forms library.
 They were not supported on
 Version 7 or BSD versions.
 .PP
 It may be unwise to count on the set of attributes copied by
 .SH PORTABILITY
 These routines emulate the System V forms library.
 They were not supported on
 Version 7 or BSD versions.
 .PP
 It may be unwise to count on the set of attributes copied by
-\fBdup_field\fR being portable; the System V forms library documents are
+\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
 Juergen Pfeifer.
 not very explicit about what gets copied and what does not.
 .SH AUTHORS
 Juergen Pfeifer.