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

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   5   * Copyright 1998-2010,2016 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_page.3x,v 1.19 2020/10/18 00:02:44 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_page 3x</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">form_page 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>                                                    <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>form_page</STRONG> - set and get form page number
  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_current_field(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
  58        <STRONG>FIELD</STRONG> <STRONG>*current_field(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
  59
  60        <STRONG>int</STRONG> <STRONG>unfocus_current_field(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
  61
  62        <STRONG>int</STRONG> <STRONG>set_form_page(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
  63        <STRONG>int</STRONG> <STRONG>form_page(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
  64
  65        <STRONG>int</STRONG> <STRONG>field_index(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
  66
  67
  68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        The  function  <STRONG>set_current_field</STRONG>  sets  the  current field of the given
  70        form; <STRONG>current_field</STRONG> returns the current field of the given form.
  71
  72        The function <STRONG>unfocus_current_field</STRONG> removes the focus from  the  current
  73        field  of  the  form.  In such state, inquiries via <STRONG>current_field</STRONG> shall
  74        return a NULL pointer.
  75
  76        The function <STRONG>set_form_page</STRONG> sets the form's page number (goes to page  <EM>n</EM>
  77        of the form).
  78
  79        The function <STRONG>form_page</STRONG> returns the form's current page number.
  80
  81        The  function  <STRONG>field_index</STRONG>  returns the index of the field in the field
  82        array of the form it is connected to.  It returns <STRONG>ERR</STRONG> if  the  argument
  83        is the null pointer or the field is not connected.
  84
  85
  86 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  87        Except for <STRONG>form_page</STRONG>, each routine returns one of the following:
  88
  89        <STRONG>E_OK</STRONG> The routine succeeded.
  90
  91        <STRONG>E_BAD_ARGUMENT</STRONG>
  92             Routine detected an incorrect or out-of-range argument.
  93
  94        <STRONG>E_BAD_STATE</STRONG>
  95             Routine was called from an initialization or termination 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(3)</STRONG>).
 105
 106
 107 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 108        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 109
 110
 111 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 112        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
 113        <STRONG>&lt;curses.h&gt;</STRONG>.
 114
 115
 116 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 117        These routines emulate the System V forms library.  They were not  sup-
 118        ported on Version 7 or BSD versions.
 119
 120        The <STRONG>unfocus_current_field</STRONG> function is an ncurses extension.
 121
 122
 123 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 124        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 125        Raymond.
 126
 127
 128
 129                                                                  <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
 130 </PRE>
 131 <div class="nav">
 132 <ul>
 133 <li><a href="#h2-NAME">NAME</a></li>
 134 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 135 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 136 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 137 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 138 <li><a href="#h2-NOTES">NOTES</a></li>
 139 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 140 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 141 </ul>
 142 </div>
 143 </BODY>
 144 </HTML>