ncurses 6.2 - patch 20210619
[ncurses.git] / 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 <B><A HREF="form_page.3X.html">form_page(3X)</A></B>                                                    <B><A HREF="form_page.3X.html">form_page(3X)</A></B>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <B>form_page</B> - set and get form page number
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;form.h&gt;</B>
56
57        <B>int</B> <B>set_current_field(FORM</B> <B>*</B><I>form</I><B>,</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
58        <B>FIELD</B> <B>*current_field(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
59
60        <B>int</B> <B>unfocus_current_field(FORM</B> <B>*</B><I>form</I><B>);</B>
61
62        <B>int</B> <B>set_form_page(FORM</B> <B>*</B><I>form</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
63        <B>int</B> <B>form_page(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
64
65        <B>int</B> <B>field_index(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
66
67
68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69        The  function  <B>set_current_field</B>  sets  the  current field of the given
70        form; <B>current_field</B> returns the current field of the given form.
71
72        The function <B>unfocus_current_field</B> removes the focus from  the  current
73        field  of  the  form.  In such state, inquiries via <B>current_field</B> shall
74        return a NULL pointer.
75
76        The function <B>set_form_page</B> sets the form's page number (goes to page  <I>n</I>
77        of the form).
78
79        The function <B>form_page</B> returns the form's current page number.
80
81        The  function  <B>field_index</B>  returns the index of the field in the field
82        array of the form it is connected to.  It returns <B>ERR</B> 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 <B>form_page</B>, each routine returns one of the following:
88
89        <B>E_OK</B> The routine succeeded.
90
91        <B>E_BAD_ARGUMENT</B>
92             Routine detected an incorrect or out-of-range argument.
93
94        <B>E_BAD_STATE</B>
95             Routine was called from an initialization or termination function.
96
97        <B>E_INVALID_FIELD</B>
98             Contents of a field are not valid.
99
100        <B>E_REQUEST_DENIED</B>
101             The form driver could not process the request.
102
103        <B>E_SYSTEM_ERROR</B>
104             System error occurred (see <B>errno(3)</B>).
105
106
107 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
108        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="form.3X.html">form(3X)</A></B>.
109
110
111 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
112        The  header  file  <B>&lt;form.h&gt;</B>  automatically  includes  the  header  file
113        <B>&lt;curses.h&gt;</B>.
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
118        supported on Version 7 or BSD versions.
119
120        The <B>unfocus_current_field</B> 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                                                                  <B><A HREF="form_page.3X.html">form_page(3X)</A></B>
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>