X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform.3x.html;h=c95854dd706c5848a2940d74f269880503198e55;hp=a7b1513fb025d0f6c924b9824880d2f45df5204a;hb=acc28c6418f43cbf15187f2f1fd9a562d5d96535;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8
diff --git a/doc/html/man/form.3x.html b/doc/html/man/form.3x.html
index a7b1513f..c95854dd 100644
--- a/doc/html/man/form.3x.html
+++ b/doc/html/man/form.3x.html
@@ -1,8 +1,8 @@
-
+
@@ -65,33 +65,37 @@
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.,
+
+ 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
+ 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
+ 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
-------------------------------------------------
current_field form_page(3x)
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)
@@ -108,11 +112,11 @@
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)
@@ -124,11 +128,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)
@@ -163,37 +169,23 @@
RETURN VALUE
- Routines that return pointers return NULL on error. Rou-
- tines that return an integer return one of the following
- error codes:
+ 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.
@@ -201,9 +193,24 @@
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).
+
+ E_UNKNOWN_COMMAND
+ The form driver code saw an unknown request code.
+
SEE ALSO
@@ -219,7 +226,7 @@
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).
+ using most linkers).
@@ -234,6 +241,11 @@
by Eric S. Raymond.
+
+SEE ALSO
+ This describes ncurses version 5.9 (patch 20140809).
+
+
form(3x)