usr/src/man/man3curses/form_new_page.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH FORM_NEW_PAGE 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_new_page, set_new_page, new_page \- forms pagination
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  14 #include <form.h>
  15
  16 \fBint\fR \fBset_new_page\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIbool\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBnew_page\fR(\fBFIELD *\fR\fIfield\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 \fBset_new_page()\fR marks \fIfield\fR as the beginning of a new page on the
  28 form.
  29 .sp
  30 .LP
  31 \fBnew_page()\fR returns a boolean value indicating whether or not \fIfield\fR
  32 begins a new page of the form.
  33 .SH RETURN VALUES
  34 .sp
  35 .LP
  36 \fBnew_page\fR returns \fBTRUE\fR or \fBFALSE\fR.
  37 .sp
  38 .LP
  39 \fBset_new_page()\fR returns one of the following:
  40 .sp
  41 .ne 2
  42 .na
  43 \fBE_OK\fR
  44 .ad
  45 .RS 18n
  46 The function returned successfully.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fBE_CONNECTED\fR
  53 .ad
  54 .RS 18n
  55 The field is already connected to a form.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fBE_SYSTEM_ERROR\fR
  62 .ad
  63 .RS 18n
  64 System error.
  65 .RE
  66
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 MT-Level        Unsafe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
  87 .SH NOTES
  88 .sp
  89 .LP
  90 The header \fB<form.h>\fR automatically includes the headers \fB<eti.h>\fR and
  91 \fB<curses.h>\fR\&.