ncurses 4.1
[ncurses.git] / man / form_page.3x
1 '\" t
2 .TH form_page 3X ""
3 .SH NAME
4 \fBform_page\fR - set and get form page number
5 .SH SYNOPSIS
6 \fB#include <form.h>\fR
7 .br
8 int set_current_field(FORM *form, FIELD *field);
9 .br
10 FIELD *current_field(const FORM *);
11 .br
12 int set_form_page(FORM *form, int n);
13 .br
14 int form_page(const FORM *form);
15 .br
16 int field_index(const FIELD *field);
17 .br
18 .SH DESCRIPTION
19 The function \fBset_current field\fR sets the current field of the given
20 form; \fBcurrent_field\fR returns the current field of the given form.
21 .PP
22 The function \fBset_form_page\fR sets the form's page number (goes to page
23 \fIn\fR of the form).
24 .PP
25 The function \fBform_page\fR returns the form's current page number.
26 .PP
27 The function \fBfield_index\fR returns the index of the field in the
28 field array of the form it is connected to. It returns \fBERR\fR if
29 the argument is the null pointer or the field is not connected.
30 .SH RETURN VALUE
31 Except for \fBform_page\fR, each routine returns one of the following:
32 .TP 5
33 \fBE_OK\fR
34 The routine succeeded.
35 .TP 5
36 \fBE_SYSTEM_ERROR\fR
37 System error occurred (see \fBerrno\fR).
38 .TP 5
39 \fBE_BAD_ARGUMENT\fR
40 Routine detected an incorrect or out-of-range argument.
41 .TP 5
42 \fBE_BAD_STATE\fR
43 Routine was called from an initialization or termination function.
44 .TP 5
45 \fBE_INVALID_FIELD\fR
46 Contents of a field are not valid.
47 .TP 5
48 \fBE_REQUEST_DENIED\fR
49 The form driver could not process the request.
50 .SH SEE ALSO
51 \fBcurses\fR(3X), \fBform\fR(3X).
52 .SH NOTES
53 The header file \fB<form.h>\fR automatically includes the header file
54 \fB<curses.h>\fR.
55 .SH PORTABILITY
56 These routines emulate the System V forms library.  They were not supported on
57 Version 7 or BSD versions.
58 .SH AUTHORS
59 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
60 S. Raymond.
61 .\"#
62 .\"# The following sets edit modes for GNU EMACS
63 .\"# Local Variables:
64 .\"# mode:nroff
65 .\"# fill-column:79
66 .\"# End: