man/form_new_page.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
   4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   5 .\"                                                                          *
   6 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   7 .\" copy of this software and associated documentation files (the            *
   8 .\" "Software"), to deal in the Software without restriction, including      *
   9 .\" without limitation the rights to use, copy, modify, merge, publish,      *
  10 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  11 .\" copies of the Software, and to permit persons to whom the Software is    *
  12 .\" furnished to do so, subject to the following conditions:                 *
  13 .\"                                                                          *
  14 .\" The above copyright notice and this permission notice shall be included  *
  15 .\" in all copies or substantial portions of the Software.                   *
  16 .\"                                                                          *
  17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24 .\"                                                                          *
  25 .\" Except as contained in this notice, the name(s) of the above copyright   *
  26 .\" holders shall not be used in advertising or otherwise to promote the     *
  27 .\" sale, use or other dealings in this Software without prior written       *
  28 .\" authorization.                                                           *
  29 .\"***************************************************************************
  30 .\"
  31 .\" $Id: form_new_page.3x,v 1.17 2020/10/18 00:04:36 tom Exp $
  32 .TH form_new_page 3X ""
  33 .ie \n(.g .ds `` \(lq
  34 .el       .ds `` ``
  35 .ie \n(.g .ds '' \(rq
  36 .el       .ds '' ''
  37 .SH NAME
  38 \fBset_new_page\fR,
  39 \fBnew_page\fR \- form pagination functions
  40 .SH SYNOPSIS
  41 \fB#include <form.h>\fR
  42 .sp
  43 \fBint set_new_page(FIELD *\fP\fIfield\fP\fB, bool \fP\fInew_page_flag\fP\fB);\fP
  44 .br
  45 \fBbool new_page(const FIELD *\fP\fIfield\fP\fB);\fP
  46 .br
  47 .SH DESCRIPTION
  48 The function \fBset_new_page\fR sets or resets a flag marking the given field
  49 as the beginning of a new page on its form.
  50 .PP
  51 The function \fBnew_page\fR is a predicate which tests if a given field marks
  52 a page beginning on its form.
  53 .SH RETURN VALUE
  54 The function \fBnew_page\fR returns \fBTRUE\fR or \fBFALSE\fR.
  55 .PP
  56 The function \fBset_new_page\fR returns one of the following:
  57 .TP 5
  58 .B E_OK
  59 The routine succeeded.
  60 .TP 5
  61 .B E_CONNECTED
  62 The given field is already connected to a form.
  63 .SH SEE ALSO
  64 \fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed
  65 descriptions of the entry points.
  66 .SH NOTES
  67 The header file \fB<form.h>\fR automatically includes the header file
  68 \fB<curses.h>\fR.
  69 .SH PORTABILITY
  70 These routines emulate the System V forms library.
  71 They were not supported on
  72 Version 7 or BSD versions.
  73 .SH AUTHORS
  74 Juergen Pfeifer.
  75 Manual pages and adaptation for new curses by Eric S. Raymond.