mirror of
https://github.com/ThomasDickey/ncurses-snapshots.git
synced 2026-01-26 11:04:35 +00:00
101 lines
4.2 KiB
Plaintext
101 lines
4.2 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright 2018-2023,2024 Thomas E. Dickey *
|
|
.\" Copyright 1998-2010,2016 Free Software Foundation, Inc. *
|
|
.\" *
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|
.\" copy of this software and associated documentation files (the *
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
.\" *
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
.\" in all copies or substantial portions of the Software. *
|
|
.\" *
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
.\" *
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
.\" authorization. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" $Id: form_page.3x,v 1.39 2024/12/28 21:26:21 tom Exp $
|
|
.TH form_page 3X 2024-12-28 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
|
|
.SH NAME
|
|
\fBform_page\fP \-
|
|
set and get form page number
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fB#include <form.h>
|
|
.PP
|
|
\fBint set_current_field(FORM *\fIform\fP, FIELD *\fIfield\fP);
|
|
\fBFIELD *current_field(const FORM *\fIform\fP);
|
|
.PP
|
|
\fBint unfocus_current_field(FORM *\fIform\fP);
|
|
.PP
|
|
\fBint set_form_page(FORM *\fIform\fP, int \fIn\fP);
|
|
\fBint form_page(const FORM *\fIform\fP);
|
|
.PP
|
|
\fBint field_index(const FIELD *\fIfield\fP);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
The function \fBset_current_field\fP sets the current field of the given
|
|
form; \fBcurrent_field\fP returns the current field of the given form.
|
|
.PP
|
|
The function \fBunfocus_current_field\fP removes the focus from the current
|
|
field of the form.
|
|
In such state, inquiries via \fBcurrent_field\fP shall return a
|
|
.I NULL
|
|
pointer.
|
|
.PP
|
|
The function \fBset_form_page\fP sets the form's page number (goes to page
|
|
\fIn\fP of the form).
|
|
.PP
|
|
The function \fBform_page\fP returns the form's current page number.
|
|
.PP
|
|
The function \fBfield_index\fP returns the index of the field in the
|
|
field array of the form it is connected to.
|
|
It returns \fBERR\fP if
|
|
the argument is the null pointer or the field is not connected.
|
|
.SH RETURN VALUE
|
|
Except for \fBform_page\fP, each routine returns one of the following:
|
|
.TP 5
|
|
.B E_OK
|
|
The routine succeeded.
|
|
.TP 5
|
|
.B E_BAD_ARGUMENT
|
|
Routine detected an incorrect or out-of-range argument.
|
|
.TP 5
|
|
.B E_BAD_STATE
|
|
Routine was called from an initialization or termination function.
|
|
.TP 5
|
|
.B E_INVALID_FIELD
|
|
Contents of a field are not valid.
|
|
.TP 5
|
|
.B E_REQUEST_DENIED
|
|
The form driver could not process the request.
|
|
.TP 5
|
|
.B E_SYSTEM_ERROR
|
|
System error occurred (see \fBerrno\fP(3)).
|
|
.SH PORTABILITY
|
|
These routines emulate the System V forms library.
|
|
They were not supported on
|
|
Version 7 or BSD versions.
|
|
.PP
|
|
The \fBunfocus_current_field\fP function is an \fI\%ncurses\fP
|
|
extension.
|
|
.SH AUTHORS
|
|
Juergen Pfeifer.
|
|
Manual pages and adaptation for new curses by Eric S. Raymond.
|
|
.SH SEE ALSO
|
|
\fB\%curses\fP(3X),
|
|
\fB\%form\fP(3X)
|