man/form_new_page.3x

   1 '\" t
   2 .TH form_new_page 3X ""
   3 .SH NAME
   4 \fBform_new_page\fR - form pagination functions
   5 .SH SYNOPSIS
   6 \fB#include <form.h>\fR
   7 .br
   8 int set_new_page(FIELD *field, bool new_page_flag);
   9 .br
  10 bool new_page(const FIELD *field);
  11 .br
  12 .SH DESCRIPTION
  13 The function \fBset_new_page\fR sets or resets a flag marking the given field
  14 as the beginning of a new page on its form.
  15
  16 The function \fBnew_page\fR is a predicate which tests if a given field marks
  17 a page beginning on its form.
  18 .SH RETURN VALUE
  19 The function \fBnew_page\fR returns \fBTRUE\fR or \fBFALSE\fR.
  20
  21 The function \fBset_new_page\fR return one of the following:
  22 .TP 5
  23 \fBE_OK\fR
  24 The routine succeeded.
  25 .TP 5
  26 \fBE_SYSTEM_ERROR\fR
  27 System error occurred (see \fBerrno\fR).
  28 .TP 5
  29 \fBE_CONNECTED\fR
  30 The given field is already connected to a form.
  31 .SH SEE ALSO
  32 \fBcurses\fR(3X) and 3X pages whose names begin "form_" for detailed
  33 descriptions of the entry points.
  34 .SH NOTES
  35 The header file \fB<form.h>\fR automatically includes the header file
  36 \fB<curses.h>\fR.
  37 .SH PORTABILITY
  38 These routines emulate the System V forms library.  They were not supported on
  39 Version 7 or BSD versions.
  40 .SH AUTHORS
  41 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  42 S. Raymond.
  43 .\"#
  44 .\"# The following sets edit modes for GNU EMACS
  45 .\"# Local Variables:
  46 .\"# mode:nroff
  47 .\"# fill-column:79
  48 .\"# End: