ncurses 6.0 - patch 20170401
[ncurses.git] / doc / html / man / form_page.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2016 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.14 2016/10/29 22:27:24 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><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
65        the given form; <STRONG>current_field</STRONG> returns the current field of
66        the given form.
67
68        The  function <STRONG>unfocus_current_field</STRONG> removes the focus from
69        the current field of the form. In  such  state,  inquiries
70        via <STRONG>current_field</STRONG> shall return a NULL pointer.
71
72        The  function  <STRONG>set_form_page</STRONG>  sets  the form's page number
73        (goes to page <EM>n</EM> of the form).
74
75        The function <STRONG>form_page</STRONG> returns  the  form's  current  page
76        number.
77
78        The function <STRONG>field_index</STRONG> returns the index of the field in
79        the field array of the form it is connected to. It returns
80        <STRONG>ERR</STRONG>  if  the  argument is the null pointer or the field is
81        not connected.
82
83
84 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
85        Except for <STRONG>form_page</STRONG>, each routine returns one of the fol-
86        lowing:
87
88        <STRONG>E_OK</STRONG> The routine succeeded.
89
90        <STRONG>E_BAD_ARGUMENT</STRONG>
91             Routine  detected  an incorrect or out-of-range argu-
92             ment.
93
94        <STRONG>E_BAD_STATE</STRONG>
95             Routine was called from an initialization or termina-
96             tion function.
97
98        <STRONG>E_INVALID_FIELD</STRONG>
99             Contents of a field are not valid.
100
101        <STRONG>E_REQUEST_DENIED</STRONG>
102             The form driver could not process the request.
103
104        <STRONG>E_SYSTEM_ERROR</STRONG>
105             System error occurred (see <STRONG>errno</STRONG>).
106
107
108 </PRE><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><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
113        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
114        file <STRONG>&lt;curses.h&gt;</STRONG>.
115
116
117 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
118        These routines emulate the System V forms  library.   They
119        were not supported on Version 7 or BSD versions.
120
121        The  <STRONG>unfocus_current_field</STRONG>  function  is an ncurses exten-
122        sion.
123
124
125 </PRE><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>