man/form_new_page.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2022,2023 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.24 2023/07/01 15:46:10 tom Exp $
  32 .TH form_new_page 3X 2023-07-01 "ncurses 6.4" "Library calls"
  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\fP,
  39 \fBnew_page\fP \- form pagination functions
  40 .SH SYNOPSIS
  41 \fB#include <form.h>\fP
  42 .sp
  43 \fBint set_new_page(FIELD *\fIfield\fB, bool \fInew_page_flag\fB);\fR
  44 .br
  45 \fBbool new_page(const FIELD *\fIfield\fB);\fR
  46 .SH DESCRIPTION
  47 The function \fBset_new_page\fP sets or resets a flag marking the given field
  48 as the beginning of a new page on its form.
  49 .PP
  50 The function \fBnew_page\fP is a predicate which tests if a given field marks
  51 a page beginning on its form.
  52 .SH RETURN VALUE
  53 The function \fBnew_page\fP returns \fBTRUE\fP or \fBFALSE\fP.
  54 .PP
  55 The function \fBset_new_page\fP returns one of the following:
  56 .TP 5
  57 .B E_OK
  58 The routine succeeded.
  59 .TP 5
  60 .B E_CONNECTED
  61 The given field is already connected to a form.
  62 .SH SEE ALSO
  63 \fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed
  64 descriptions of the entry points.
  65 .SH NOTES
  66 The header file \fB<form.h>\fP automatically includes the header file
  67 \fB<curses.h>\fP.
  68 .SH PORTABILITY
  69 These routines emulate the System V forms library.
  70 They were not supported on
  71 Version 7 or BSD versions.
  72 .SH AUTHORS
  73 Juergen Pfeifer.
  74 Manual pages and adaptation for new curses by Eric S. Raymond.