1form_page(3X)                                                    form_page(3X)
2
3
4

NAME

6       form_page - set and get form page number
7

SYNOPSIS

9       #include <form.h>
10       int set_current_field(FORM *form, FIELD *field);
11       FIELD *current_field(const FORM *);
12       int unfocus_current_field(FORM *form);
13       int set_form_page(FORM *form, int n);
14       int form_page(const FORM *form);
15       int field_index(const FIELD *field);
16

DESCRIPTION

18       The  function  set_current_field  sets  the  current field of the given
19       form; current_field returns the current field of the given form.
20
21       The function unfocus_current_field removes the focus from  the  current
22       field  of  the  form.  In such state, inquiries via current_field shall
23       return a NULL pointer.
24
25       The function set_form_page sets the form's page number (goes to page  n
26       of the form).
27
28       The function form_page returns the form's current page number.
29
30       The  function  field_index  returns the index of the field in the field
31       array of the form it is connected to.  It returns ERR if  the  argument
32       is the null pointer or the field is not connected.
33

RETURN VALUE

35       Except for form_page, each routine returns one of the following:
36
37       E_OK The routine succeeded.
38
39       E_BAD_ARGUMENT
40            Routine detected an incorrect or out-of-range argument.
41
42       E_BAD_STATE
43            Routine was called from an initialization or termination function.
44
45       E_INVALID_FIELD
46            Contents of a field are not valid.
47
48       E_REQUEST_DENIED
49            The form driver could not process the request.
50
51       E_SYSTEM_ERROR
52            System error occurred (see errno).
53

SEE ALSO

55       curses(3X), form(3X).
56

NOTES

58       The  header  file  <form.h>  automatically  includes  the  header  file
59       <curses.h>.
60

PORTABILITY

62       These routines emulate the System V forms library.  They were not  sup‐
63       ported on Version 7 or BSD versions.
64
65       The unfocus_current_field function is an ncurses extension.
66

AUTHORS

68       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
69       Raymond.
70
71
72
73                                                                 form_page(3X)
Impressum