doc/html/man/form_new_page.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2020,2021 Thomas E. Dickey                                *
   5   * Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   6   *                                                                          *
   7   * Permission is hereby granted, free of charge, to any person obtaining a  *
   8   * copy of this software and associated documentation files (the            *
   9   * "Software"), to deal in the Software without restriction, including      *
  10   * without limitation the rights to use, copy, modify, merge, publish,      *
  11   * distribute, distribute with modifications, sublicense, and/or sell       *
  12   * copies of the Software, and to permit persons to whom the Software is    *
  13   * furnished to do so, subject to the following conditions:                 *
  14   *                                                                          *
  15   * The above copyright notice and this permission notice shall be included  *
  16   * in all copies or substantial portions of the Software.                   *
  17   *                                                                          *
  18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  25   *                                                                          *
  26   * Except as contained in this notice, the name(s) of the above copyright   *
  27   * holders shall not be used in advertising or otherwise to promote the     *
  28   * sale, use or other dealings in this Software without prior written       *
  29   * authorization.                                                           *
  30   ****************************************************************************
  31   * @Id: form_new_page.3x,v 1.19 2021/12/25 21:49:32 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>form_new_page 3x</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">form_new_page 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>                                            <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_new_page</STRONG>, <STRONG>new_page</STRONG> - form pagination functions
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>set_new_page(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>new</EM><STRONG>_</STRONG><EM>page</EM><STRONG>_</STRONG><EM>flag</EM><STRONG>);</STRONG>
  58        <STRONG>bool</STRONG> <STRONG>new_page(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
  59
  60
  61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  62        The function <STRONG>set_new_page</STRONG> sets or resets a flag marking the given field
  63        as the beginning of a new page on its form.
  64
  65        The function <STRONG>new_page</STRONG> is a predicate which tests if a given field marks
  66        a page beginning on its form.
  67
  68
  69 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  70        The function <STRONG>new_page</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
  71
  72        The function <STRONG>set_new_page</STRONG> returns one of the following:
  73
  74        <STRONG>E_OK</STRONG> The routine succeeded.
  75
  76        <STRONG>E_CONNECTED</STRONG>
  77             The given field is already connected to a form.
  78
  79
  80 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  81        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>  and  related  pages  whose names begin "form_" for detailed
  82        descriptions of the entry points.
  83
  84
  85 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  86        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
  87        <STRONG>&lt;curses.h&gt;</STRONG>.
  88
  89
  90 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  91        These  routines  emulate  the  System  V  forms library.  They were not
  92        supported on Version 7 or BSD versions.
  93
  94
  95 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  96        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
  97        Raymond.
  98
  99
 100
 101                                                              <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
 102 </PRE>
 103 <div class="nav">
 104 <ul>
 105 <li><a href="#h2-NAME">NAME</a></li>
 106 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 107 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 108 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 109 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 110 <li><a href="#h2-NOTES">NOTES</a></li>
 111 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 112 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 113 </ul>
 114 </div>
 115 </BODY>
 116 </HTML>