X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_page.3x.html;h=912eed45f904bc671ef4348944505e4fc75b635f;hp=30a17cf928d54d8845e1414d1698f48eb0d11b1b;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012 diff --git a/doc/html/man/form_page.3x.html b/doc/html/man/form_page.3x.html index 30a17cf9..912eed45 100644 --- a/doc/html/man/form_page.3x.html +++ b/doc/html/man/form_page.3x.html @@ -1,7 +1,8 @@ - - -form_page 3x - + +form_page 3X + -

form_page 3x

-
+

form_page 3X

-form_page(3x)                                             form_page(3x)
+form_page(3X)                                                    form_page(3X)
 
 
 
 
-
-

NAME

-       form_page - set and get form page number
+

NAME

+       form_page - set and get form page number
 
 
-
-

SYNOPSIS

-       #include <form.h>
-       int set_current_field(FORM *form, FIELD *field);
-       FIELD *current_field(const FORM *);
-       int set_form_page(FORM *form, int n);
-       int form_page(const FORM *form);
-       int field_index(const FIELD *field);
+

SYNOPSIS

+       #include <form.h>
 
+       int set_current_field(FORM *form, FIELD *field);
+       FIELD *current_field(const FORM *form);
 
-
-

DESCRIPTION

-       The  function  set_current field sets the current field of
-       the given form; current_field returns the current field of
-       the given form.
+       int unfocus_current_field(FORM *form);
 
-       The  function  set_form_page  sets  the form's page number
-       (goes to page n of the form).
+       int set_form_page(FORM *form, int n);
+       int form_page(const FORM *form);
 
-       The function form_page returns  the  form's  current  page
-       number.
+       int field_index(const FIELD *field);
 
-       The function field_index returns the index of the field in
-       the field array of the form it is connected to. It returns
-       ERR  if  the  argument is the null pointer or the field is
-       not connected.
 
+

DESCRIPTION

+       The  function  set_current_field  sets  the  current field of the given
+       form; current_field returns the current field of the given form.
 
-
-

RETURN VALUE

-       Except for form_page, each routine returns one of the fol-
-       lowing:
+       The function unfocus_current_field removes the focus from  the  current
+       field  of  the  form.  In such state, inquiries via current_field shall
+       return a NULL pointer.
+
+       The function set_form_page sets the form's page number (goes to page  n
+       of the form).
+
+       The function form_page returns the form's current page number.
+
+       The  function  field_index  returns the index of the field in the field
+       array of the form it is connected to.  It returns ERR if  the  argument
+       is the null pointer or the field is not connected.
 
-       E_OK The routine succeeded.
 
-       E_BAD_ARGUMENT
-            Routine  detected  an incorrect or out-of-range argu-
-            ment.
+

RETURN VALUE

+       Except for form_page, each routine returns one of the following:
 
-       E_BAD_STATE
-            Routine was called from an initialization or termina-
-            tion function.
+       E_OK The routine succeeded.
 
-       E_INVALID_FIELD
+       E_BAD_ARGUMENT
+            Routine detected an incorrect or out-of-range argument.
+
+       E_BAD_STATE
+            Routine was called from an initialization or termination function.
+
+       E_INVALID_FIELD
             Contents of a field are not valid.
 
-       E_REQUEST_DENIED
+       E_REQUEST_DENIED
             The form driver could not process the request.
 
-       E_SYSTEM_ERROR
-            System error occurred (see errno).
+       E_SYSTEM_ERROR
+            System error occurred (see errno(3)).
 
 
-
-

SEE ALSO

-       curses(3x), form(3x).
+

SEE ALSO

+       curses(3X), form(3X).
 
 
-
-

NOTES

-       The header file <form.h> automatically includes the header
-       file <curses.h>.
+

NOTES

+       The  header  file  <form.h>  automatically  includes  the  header  file
+       <curses.h>.
 
 
-
-

PORTABILITY

-       These routines emulate the System V forms  library.   They
-       were not supported on Version 7 or BSD versions.
+

PORTABILITY

+       These routines emulate the System  V  forms  library.   They  were  not
+       supported on Version 7 or BSD versions.
 
+       The unfocus_current_field function is an ncurses extension.
 
-
-

AUTHORS

-       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
-       curses by Eric S. Raymond.
+
+

AUTHORS

+       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
+       Raymond.
 
 
 
-                                                          form_page(3x)
+                                                                 form_page(3X)