X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_page.3x.html;h=d9f369122fe3bbc3f090b530f4fcc290c5ff6c0b;hb=122d3739b3c11c83decc625d53f26fff6e825710;hp=54372ff4628622f8474d77fadddd300b0ddc5ca3;hpb=b0b1980be11bba618d84beb8b30ac94e2c820602;p=ncurses.git diff --git a/doc/html/man/form_page.3x.html b/doc/html/man/form_page.3x.html index 54372ff4..d9f36912 100644 --- a/doc/html/man/form_page.3x.html +++ b/doc/html/man/form_page.3x.html @@ -1,8 +1,7 @@ - - + -form_page 3x - - + + +form_page 3x 2023-10-07 ncurses 6.4 Library calls + + -

form_page 3x

-
+

form_page 3x 2023-10-07 ncurses 6.4 Library calls

-
-form_page(3x)                                             form_page(3x)
+form_page(3x)                    Library calls                   form_page(3x)
 
 
 
 
-
-

NAME

+

NAME

        form_page - set and get form page number
 
 
-
-

SYNOPSIS

+

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);
 
+       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.
+
+
+

RETURN VALUE

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

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.
 
+       The unfocus_current_field function is an ncurses extension.
 
-
-

PORTABILITY

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

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.
+
+

SEE ALSO

+       curses(3x), form(3x)
 
 
 
-                                                          form_page(3x)
+ncurses 6.4                       2023-10-07                     form_page(3x)
-
-Man(1) output converted with man2html +
+ +