X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_page.3x.html;h=3c67fccc66740685e535af23739417bcd7ac5720;hp=874bda872de15e3a5f68eb138ed171e7554b747c;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/form_page.3x.html b/doc/html/man/form_page.3x.html index 874bda87..3c67fccc 100644 --- a/doc/html/man/form_page.3x.html +++ b/doc/html/man/form_page.3x.html @@ -1,136 +1,144 @@ + + +
+ + +- - --
- form_page - set and get form page number - - --
- #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); - - --
- The function set_current field sets the current field of - the given form; current_field returns the current field of - the given form. - - 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. - - --
- Except for form_page, each routine returns one of the fol- - lowing: - - E_OK The routine succeeded. - - E_SYSTEM_ERROR - System error occurred (see errno). - - E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. - - E_BAD_STATE - Routine was called from an initialization or termina- - tion function. - - E_INVALID_FIELD - Contents of a field are not valid. - - E_REQUEST_DENIED - The form driver could not process the request. - - --
- curses(3x), form(3x). - - - --
- The header file <form.h> automatically includes the header - file <curses.h>. - - --
- These routines emulate the System V forms library. They - were not supported on Version 7 or BSD versions. - - --
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. - - - - - - - +form_page(3x) form_page(3x) +
+ form_page - set and get form page number +
+ #include <form.h> + int set_current_field(FORM *form, FIELD *field); + FIELD *current_field(const FORM *form); + int unfocus_current_field(FORM *form); + int set_form_page(FORM *form, int n); + int form_page(const FORM *form); + int field_index(const FIELD *field); +
+ The function set_current_field sets the current field of the given + form; current_field returns the current field of the given form. + 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. +
+ 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 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 + The form driver could not process the request. + E_SYSTEM_ERROR + System error occurred (see errno(3)). +
+ curses(3x), form(3x). +
+ The header file <form.h> automatically includes the header file + <curses.h>. +
+ 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. +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. + form_page(3x)-