man/form_new_page.3x

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