451c967ae6f1ef263f52564f02717f7b167fcd6b
[ncurses.git] / doc / html / man / form_page.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2016,2018 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.15 2018/07/28 21:34:06 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_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><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>form_page</STRONG> - set and get form page number
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_current_field(FORM *form, FIELD *field);
56        FIELD *current_field(const FORM *);
57        int unfocus_current_field(FORM *form);
58        int set_form_page(FORM *form, int n);
59        int form_page(const FORM *form);
60        int field_index(const FIELD *field);
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        The  function  <STRONG>set_current_field</STRONG>  sets  the  current field of the given
65        form; <STRONG>current_field</STRONG> returns the current field of the given form.
66
67        The function <STRONG>unfocus_current_field</STRONG> removes the focus from  the  current
68        field  of  the  form.  In such state, inquiries via <STRONG>current_field</STRONG> shall
69        return a NULL pointer.
70
71        The function <STRONG>set_form_page</STRONG> sets the form's page number (goes to page  <EM>n</EM>
72        of the form).
73
74        The function <STRONG>form_page</STRONG> returns the form's current page number.
75
76        The  function  <STRONG>field_index</STRONG>  returns the index of the field in the field
77        array of the form it is connected to.  It returns <STRONG>ERR</STRONG> if  the  argument
78        is the null pointer or the field is not connected.
79
80
81 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
82        Except for <STRONG>form_page</STRONG>, each routine returns one of the following:
83
84        <STRONG>E_OK</STRONG> The routine succeeded.
85
86        <STRONG>E_BAD_ARGUMENT</STRONG>
87             Routine detected an incorrect or out-of-range argument.
88
89        <STRONG>E_BAD_STATE</STRONG>
90             Routine was called from an initialization or termination function.
91
92        <STRONG>E_INVALID_FIELD</STRONG>
93             Contents of a field are not valid.
94
95        <STRONG>E_REQUEST_DENIED</STRONG>
96             The form driver could not process the request.
97
98        <STRONG>E_SYSTEM_ERROR</STRONG>
99             System error occurred (see <STRONG>errno</STRONG>).
100
101
102 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
103        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
104
105
106 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
107        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
108        <STRONG>&lt;curses.h&gt;</STRONG>.
109
110
111 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
112        These routines emulate the System V forms library.  They were not  sup-
113        ported on Version 7 or BSD versions.
114
115        The <STRONG>unfocus_current_field</STRONG> function is an ncurses extension.
116
117
118 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
119        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
120        Raymond.
121
122
123
124                                                                  <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
125 </PRE>
126 <div class="nav">
127 <ul>
128 <li><a href="#h2-NAME">NAME</a></li>
129 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
130 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
131 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
132 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
133 <li><a href="#h2-NOTES">NOTES</a></li>
134 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
135 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
136 </ul>
137 </div>
138 </BODY>
139 </HTML>