97 lines
4.0 KiB
Plaintext
97 lines
4.0 KiB
Plaintext
'\" t
|
|
.\"***************************************************************************
|
|
.\" Copyright (c) 1998,2006 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.10 2006/11/04 18:52:32 tom Exp $
|
|
.TH form_page 3X ""
|
|
.SH NAME
|
|
\fBform_page\fR - set and get form page number
|
|
.SH SYNOPSIS
|
|
\fB#include <form.h>\fR
|
|
.br
|
|
int set_current_field(FORM *form, FIELD *field);
|
|
.br
|
|
FIELD *current_field(const FORM *);
|
|
.br
|
|
int set_form_page(FORM *form, int n);
|
|
.br
|
|
int form_page(const FORM *form);
|
|
.br
|
|
int field_index(const FIELD *field);
|
|
.br
|
|
.SH DESCRIPTION
|
|
The function \fBset_current field\fR sets the current field of the given
|
|
form; \fBcurrent_field\fR returns the current field of the given form.
|
|
.PP
|
|
The function \fBset_form_page\fR sets the form's page number (goes to page
|
|
\fIn\fR of the form).
|
|
.PP
|
|
The function \fBform_page\fR returns the form's current page number.
|
|
.PP
|
|
The function \fBfield_index\fR returns the index of the field in the
|
|
field array of the form it is connected to. It returns \fBERR\fR if
|
|
the argument is the null pointer or the field is not connected.
|
|
.SH RETURN VALUE
|
|
Except for \fBform_page\fR, 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\fR).
|
|
.
|
|
.SH SEE ALSO
|
|
\fBcurses\fR(3X), \fBform\fR(3X).
|
|
.SH NOTES
|
|
The header file \fB<form.h>\fR automatically includes the header file
|
|
\fB<curses.h>\fR.
|
|
.SH PORTABILITY
|
|
These routines emulate the System V forms library. They were not supported on
|
|
Version 7 or BSD versions.
|
|
.SH AUTHORS
|
|
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
|
|
S. Raymond.
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|