X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform.3x.html;h=557222cf35b7368b10273cb7a45c5554b40eb189;hp=320d2816b3b7fdf322d28afbeaae518fb1ee72c8;hb=aabb3a65ee5d88949abe529b5131adedb9cfab84;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;ds=sidebyside diff --git a/doc/html/man/form.3x.html b/doc/html/man/form.3x.html index 320d2816..557222cf 100644 --- a/doc/html/man/form.3x.html +++ b/doc/html/man/form.3x.html @@ -1,8 +1,7 @@ - +
+ +- -form(3x) form(3x) +form(3x) form(3x)-
+NAME
form - curses extension for programming forms-SYNOPSIS
+SYNOPSIS
#include <form.h>-DESCRIPTION
+DESCRIPTION
The form library provides terminal-independent facilities for composing form screens on character-cell terminals. The library includes: field routines, which create and @@ -65,23 +65,32 @@ into forms, display forms on the screen, and handle inter- action with the user. - The form library uses the curses libraries, and a curses - initialization routine such as initscr must be called - before using any of these functions. To use the form - library, link with the options -lform -lcurses. + The form library uses the curses libraries. To use the + form library, link with the options -lform -lcurses. + Your program should set up the locale, e.g., - Current Default Values for Field Attributes - The form library maintains a default value for field - attributes. You can get or set this default by calling - the appropriate set_ or retrieval routine with a NULL + setlocale(LC_ALL, ""); + + so that input/output processing will work. + + A curses initialization routine such as initscr must be + called before using any of these functions. + + ++Current Default Values for Field Attributes
+ The form library maintains a default value for field + attributes. You can get or set this default by calling + the appropriate set_ or retrieval routine with a NULL field pointer. Changing this default with a set_ function - affects future field creations, but does not change the + affects future field creations, but does not change the rendering of fields already created. - Routine Name Index - The following table lists each form routine and the name ++Routine Name Index
+ The following table lists each form routine and the name of the manual page on which it is described. curses Routine Name Manual Page Name @@ -90,7 +99,7 @@ data_ahead form_data(3x) data_behind form_data(3x) dup_field form_field_new(3x) - dynamic_fieldinfo form_field_info(3x) + dynamic_field_info form_field_info(3x) field_arg form_field_validation(3x) field_back form_field_attributes(3x) field_buffer form_field_buffer(3x) @@ -107,12 +116,12 @@ field_status form_field_buffer(3x) field_term form_hook(3x) field_type form_field_validation(3x) + field_userptr form_field_userptr(3x) form_driver form_driver(3x) form_fields form_field(3x) form_init form_hook(3x) form_opts form_opts(3x) - form_opts_off form_opts(3x) form_opts_on form_opts(3x) form_page form_page(3x) @@ -123,11 +132,13 @@ form_userptr form_userptr(3x) form_win form_win(3x) free_field form_field_new(3x) + free_fieldtype form_fieldtype(3x) free_form form_new(3x) link_field form_field_new(3x) link_fieldtype form_fieldtype(3x) move_field form_field(3x) new_field form_field_new(3x) + new_fieldtype form_fieldtype(3x) new_form form_new(3x) new_page form_new_page(3x) pos_form_cursor form_cursor(3x) @@ -161,38 +172,24 @@-RETURN VALUE
- Routines that return pointers return NULL on error. Rou- - tines that return an integer return one of the following - error codes: +RETURN VALUE
+ Routines that return pointers return NULL on error, and + set errno to the corresponding error-code returned by + functions returning an integer. Routines that return an + integer return one of the following error codes: E_OK The routine succeeded. - E_CONNECTED - The field is already connected to a form. - - E_SYSTEM_ERROR - System error occurred (see errno). - E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argu- ment. - E_POSTED - The form is already posted. - E_BAD_STATE Routine was called from an initialization or termina- tion function. - E_NO_ROOM - Form is too large for its window. - - E_NOT_POSTED - The form has not been posted. - - E_UNKNOWN_COMMAND - The form driver code saw an unknown request code. + E_CONNECTED + The field is already connected to a form. E_INVALID_FIELD Contents of a field are not valid. @@ -200,46 +197,75 @@ E_NOT_CONNECTED No fields are connected to the form. + E_NOT_POSTED + The form has not been posted. + + E_NO_ROOM + Form is too large for its window. + + E_POSTED + The form is already posted. + E_REQUEST_DENIED The form driver could not process the request. + E_SYSTEM_ERROR + System error occurred (see errno). --SEE ALSO
- curses(3x) and related pages whose names begin "form_" for - detailed descriptions of the entry points. + E_UNKNOWN_COMMAND + The form driver code saw an unknown request code.-NOTES
+NOTES
The header file <form.h> automatically includes the header files <curses.h> and <eti.h>. - In your library list, libform.a should be before libn- + In your library list, libform.a should be before libn- curses.a; that is, you want to say `-lform -lncurses', not - the other way around (which would give you a link error - using GNU ld(1) and many other linkers). + the other way around (which would give you a link error + using most linkers).-PORTABILITY
- These routines emulate the System V forms library. They +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 ncurses +AUTHORS
+ Juergen Pfeifer. Manual pages and adaptation for ncurses by Eric S. Raymond. ++SEE ALSO
+ curses(3x) and related pages whose names begin "form_" for + detailed descriptions of the entry points. + + This describes ncurses version 5.9 (patch 20150523). + + - form(3x) + form(3x)-
- -Man(1) output converted with -man2html - +