Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / refs/heads/android-16 / . / man / form_page.3x
blob: fa538c620143a7a27146fc66b5b5dd00119a6a0f [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1.\"***************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]2.\" Copyright 2018-2023,2024 Thomas E. Dickey *
3.\" Copyright 1998-2010,2016 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]4.\" *
5.\" Permission is hereby granted, free of charge, to any person obtaining a *
6.\" copy of this software and associated documentation files (the *
7.\" "Software"), to deal in the Software without restriction, including *
8.\" without limitation the rights to use, copy, modify, merge, publish, *
9.\" distribute, distribute with modifications, sublicense, and/or sell *
10.\" copies of the Software, and to permit persons to whom the Software is *
11.\" furnished to do so, subject to the following conditions: *
12.\" *
13.\" The above copyright notice and this permission notice shall be included *
14.\" in all copies or substantial portions of the Software. *
15.\" *
16.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23.\" *
24.\" Except as contained in this notice, the name(s) of the above copyright *
25.\" holders shall not be used in advertising or otherwise to promote the *
26.\" sale, use or other dealings in this Software without prior written *
27.\" authorization. *
28.\"***************************************************************************
29.\"
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]30.\" $Id: form_page.3x,v 1.37 2024/03/16 15:35:01 tom Exp $
31.TH form_page 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32.SH NAME
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]33\fBform_page\fP \-
34set and get form page number
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]35.SH SYNOPSIS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]36.nf
37\fB#include <form.h>
38.PP
39\fBint set_current_field(FORM *\fIform\fP, FIELD *\fIfield\fP);
40\fBFIELD *current_field(const FORM *\fIform\fP);
41.PP
42\fBint unfocus_current_field(FORM *\fIform\fP);
43.PP
44\fBint set_form_page(FORM *\fIform\fP, int \fIn\fP);
45\fBint form_page(const FORM *\fIform\fP);
46.PP
47\fBint field_index(const FIELD *\fIfield\fP);
48.fi
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]49.SH DESCRIPTION
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]50The function \fBset_current_field\fP sets the current field of the given
51form; \fBcurrent_field\fP returns the current field of the given form.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52.PP
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]53The function \fBunfocus_current_field\fP removes the focus from the current
54field of the form.
55In such state, inquiries via \fBcurrent_field\fP shall return a NULL pointer.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]56.PP
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]57The function \fBset_form_page\fP sets the form's page number (goes to page
58\fIn\fP of the form).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]59.PP
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]60The function \fBform_page\fP returns the form's current page number.
61.PP
62The function \fBfield_index\fP returns the index of the field in the
63field array of the form it is connected to.
64It returns \fBERR\fP if
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]65the argument is the null pointer or the field is not connected.
66.SH RETURN VALUE
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]67Except for \fBform_page\fP, each routine returns one of the following:
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]68.TP 5
69.B E_OK
70The routine succeeded.
71.TP 5
72.B E_BAD_ARGUMENT
73Routine detected an incorrect or out-of-range argument.
74.TP 5
75.B E_BAD_STATE
76Routine was called from an initialization or termination function.
77.TP 5
78.B E_INVALID_FIELD
79Contents of a field are not valid.
80.TP 5
81.B E_REQUEST_DENIED
82The form driver could not process the request.
83.TP 5
84.B E_SYSTEM_ERROR
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]85System error occurred (see \fBerrno\fP(3)).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]86.SH PORTABILITY
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]87These routines emulate the System V forms library.
88They were not supported on
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]89Version 7 or BSD versions.
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]90.PP
91The \fBunfocus_current_field\fP function is an \fI\%ncurses\fP
92extension.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]93.SH AUTHORS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]94Juergen Pfeifer.
95Manual pages and adaptation for new curses by Eric S. Raymond.
96.SH SEE ALSO
97\fB\%curses\fP(3X),
98\fB\%form\fP(3X)