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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 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   * @Id: form_new_page.3x,v 1.34 2024/03/16 15:35:01 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>form_new_page 3x 2024-03-16 ncurses 6.4 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">form_new_page 3x 2024-03-16 ncurses 6.4 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>                Library calls               <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>set_new_page</STRONG>, <STRONG>new_page</STRONG> - form pagination functions
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  55
  56        <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>
  57        <STRONG>bool</STRONG> <STRONG>new_page(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        The function <STRONG>set_new_page</STRONG> sets or resets a flag marking the given field
  62        as the beginning of a new page on its form.
  63
  64        The function <STRONG>new_page</STRONG> is a predicate which tests if a given field marks
  65        a page beginning on its form.
  66
  67
  68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  69        The function <STRONG>new_page</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
  70
  71        The function <STRONG>set_new_page</STRONG> returns one of the following:
  72
  73        <STRONG>E_OK</STRONG> The routine succeeded.
  74
  75        <STRONG>E_CONNECTED</STRONG>
  76             The given field is already connected to a form.
  77
  78
  79 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  80        These  routines  emulate  the  System  V  forms library.  They were not
  81        supported on Version 7 or BSD versions.
  82
  83
  84 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  85        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
  86        Raymond.
  87
  88
  89 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  90        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>  and  related  pages  whose names begin "form_" for detailed
  91        descriptions of the entry points.
  92
  93
  94
  95 ncurses 6.4                       2024-03-16                 <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
  96 </PRE>
  97 <div class="nav">
  98 <ul>
  99 <li><a href="#h2-NAME">NAME</a></li>
 100 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 101 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 102 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 103 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 104 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 105 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 106 </ul>
 107 </div>
 108 </BODY>
 109 </HTML>