doc/html/man/form_page.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2006,2010 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_page.3x,v 1.12 2010/12/04 18:40: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_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_page 3x</H1>
  43 <PRE>
  44 <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>                                             <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>form_page</STRONG> - set and get form page number
  52
  53
  54 </PRE>
  55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  57        int set_current_field(FORM *form, FIELD *field);
  58        FIELD *current_field(const FORM *);
  59        int set_form_page(FORM *form, int n);
  60        int form_page(const FORM *form);
  61        int field_index(const FIELD *field);
  62
  63
  64 </PRE>
  65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  66        The  function  <STRONG>set_current</STRONG> <STRONG>field</STRONG> sets the current field of
  67        the given form; <STRONG>current_field</STRONG> returns the current field of
  68        the given form.
  69
  70        The  function  <STRONG>set_form_page</STRONG>  sets  the form's page number
  71        (goes to page <EM>n</EM> of the form).
  72
  73        The function <STRONG>form_page</STRONG> returns  the  form's  current  page
  74        number.
  75
  76        The function <STRONG>field_index</STRONG> returns the index of the field in
  77        the field array of the form it is connected to. It returns
  78        <STRONG>ERR</STRONG>  if  the  argument is the null pointer or the field is
  79        not connected.
  80
  81
  82 </PRE>
  83 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  84        Except for <STRONG>form_page</STRONG>, each routine returns one of the fol-
  85        lowing:
  86
  87        <STRONG>E_OK</STRONG> The routine succeeded.
  88
  89        <STRONG>E_BAD_ARGUMENT</STRONG>
  90             Routine  detected  an incorrect or out-of-range argu-
  91             ment.
  92
  93        <STRONG>E_BAD_STATE</STRONG>
  94             Routine was called from an initialization or termina-
  95             tion function.
  96
  97        <STRONG>E_INVALID_FIELD</STRONG>
  98             Contents of a field are not valid.
  99
 100        <STRONG>E_REQUEST_DENIED</STRONG>
 101             The form driver could not process the request.
 102
 103        <STRONG>E_SYSTEM_ERROR</STRONG>
 104             System error occurred (see <STRONG>errno</STRONG>).
 105
 106
 107 </PRE>
 108 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 109        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 110
 111
 112 </PRE>
 113 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 114        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
 115        file <STRONG>&lt;curses.h&gt;</STRONG>.
 116
 117
 118 </PRE>
 119 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 120        These routines emulate the System V forms  library.   They
 121        were not supported on Version 7 or BSD versions.
 122
 123
 124 </PRE>
 125 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 126        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
 127        curses by Eric S. Raymond.
 128
 129
 130
 131                                                           <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
 132 </PRE>
 133 <div class="nav">
 134 <ul>
 135 <li><a href="#h2-NAME">NAME</a></li>
 136 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 137 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 138 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 139 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 140 <li><a href="#h2-NOTES">NOTES</a></li>
 141 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 142 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 143 </ul>
 144 </div>
 145 </BODY>
 146 </HTML>