X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_new.3x;h=1a240d0a7fc3acb400798b4503b21232090eece8;hp=00156e1366da154a5788155ad2aa5b16a60fb258;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=b11cef1e315b58820ea0cde239ebf2f741ef8948 diff --git a/man/form_field_new.3x b/man/form_field_new.3x index 00156e13..1a240d0a 100644 --- a/man/form_field_new.3x +++ b/man/form_field_new.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2015 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 * @@ -27,7 +28,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_new.3x,v 1.19 2015/12/05 23:42:45 tom Exp $ +.\" $Id: form_field_new.3x,v 1.24 2020/10/24 09:09:18 tom Exp $ .TH form_field_new 3X "" .SH NAME \fBnew_field\fR, @@ -36,36 +37,39 @@ \fBfree_field\fR \- create and destroy form fields .SH SYNOPSIS \fB#include \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 -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 -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 -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. .PP -The function \fBdup_field\fR duplicates a field at a new location. Most +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, -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. .PP 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, \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. -They set errno according to their success: +They set \fBerrno\fP according to their success: .TP 5 .B E_OK The routine succeeded. @@ -92,12 +96,13 @@ field is connected. The header file \fB\fR automatically includes the header file \fB\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. .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 not very explicit about what gets copied and what does not. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.