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

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 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.11 2015/12/05 23:42:45 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 http://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>form_new_page 3x</TITLE>
  38 <link rev=made href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">form_new_page 3x</H1>
  43 <PRE>
  44 <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>
  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        int set_new_page(FIELD *field, bool new_page_flag);
  56        bool new_page(const FIELD *field);
  57
  58
  59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  60        The  function  <STRONG>set_new_page</STRONG>  sets or resets a flag marking
  61        the given field as the beginning of  a  new  page  on  its
  62        form.
  63
  64        The  function  <STRONG>new_page</STRONG>  is  a  predicate which tests if a
  65        given field marks 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> return one of the following:
  72
  73        <STRONG>E_OK</STRONG> The routine succeeded.
  74
  75        <STRONG>E_SYSTEM_ERROR</STRONG>
  76             System error occurred (see <STRONG>errno</STRONG>).
  77
  78        <STRONG>E_CONNECTED</STRONG>
  79             The given field is already connected to a form.
  80
  81
  82 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  83        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
  84        detailed descriptions of the entry points.
  85
  86
  87 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  88        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
  89        file <STRONG>&lt;curses.h&gt;</STRONG>.
  90
  91
  92 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  93        These routines emulate the System V forms  library.   They
  94        were not supported on Version 7 or BSD versions.
  95
  96
  97 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  98        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
  99        curses by Eric S. Raymond.
 100
 101
 102
 103                                                       <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
 104 </PRE>
 105 <div class="nav">
 106 <ul>
 107 <li><a href="#h2-NAME">NAME</a></li>
 108 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 109 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 110 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 111 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 112 <li><a href="#h2-NOTES">NOTES</a></li>
 113 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 114 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 115 </ul>
 116 </div>
 117 </BODY>
 118 </HTML>