lib/libncurses/man/form_new_page.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 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.11 2015/12/05 23:42:45 tom Exp $
  31 .TH form_new_page 3X ""
  32 .SH NAME
  33 \fBset_new_page\fR,
  34 \fBnew_page\fR \- form pagination functions
  35 .SH SYNOPSIS
  36 \fB#include <form.h>\fR
  37 .br
  38 int set_new_page(FIELD *field, bool new_page_flag);
  39 .br
  40 bool new_page(const FIELD *field);
  41 .br
  42 .SH DESCRIPTION
  43 The function \fBset_new_page\fR sets or resets a flag marking the given field
  44 as the beginning of a new page on its form.
  45 .PP
  46 The function \fBnew_page\fR is a predicate which tests if a given field marks
  47 a page beginning on its form.
  48 .SH RETURN VALUE
  49 The function \fBnew_page\fR returns \fBTRUE\fR or \fBFALSE\fR.
  50 .PP
  51 The function \fBset_new_page\fR return one of the following:
  52 .TP 5
  53 .B E_OK
  54 The routine succeeded.
  55 .TP 5
  56 .B E_SYSTEM_ERROR
  57 System error occurred (see \fBerrno\fR).
  58 .TP 5
  59 .B E_CONNECTED
  60 The given field is already connected to a form.
  61 .SH SEE ALSO
  62 \fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
  63 descriptions of the entry points.
  64 .SH NOTES
  65 The header file \fB<form.h>\fR automatically includes the header file
  66 \fB<curses.h>\fR.
  67 .SH PORTABILITY
  68 These routines emulate the System V forms library.  They were not supported on
  69 Version 7 or BSD versions.
  70 .SH AUTHORS
  71 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  72 S. Raymond.