Once a form has been posted (displayed), you should funnel input events
- to it through form_driver. This routine has three major input cases:
+ to it through form_driver. This routine has three major input cases:
- o The input is a form navigation request. Navigation request codes
- are constants defined in <form.h>, which are distinct from the key-
- and character codes returned by wgetch(3x).
+ o The input is a form navigation request. Navigation request codes
+ are constants defined in <form.h>, which are distinct from the key-
+ and character codes returned by wgetch(3X).
- o The input is a printable character. Printable characters (which
- must be positive, less than 256) are checked according to the pro-
- gram's locale settings.
+ o The input is a printable character. Printable characters (which
+ must be positive, less than 256) are checked according to the
+ program's locale settings.
- o The input is the KEY_MOUSE special key associated with an mouse
+ o The input is the KEY_MOUSE special key associated with an mouse
event.
- This extension simplifies the use of the forms library using wide char-
- acters. The input is either a key code (a request) or a wide character
- returned by get_wch(3x). The type must be passed as well, to enable
- the library to determine whether the parameter is a wide character or a
- request.
+ This extension simplifies the use of the forms library using wide
+ characters. The input is either a key code (a request) or a wide
+ character returned by get_wch(3X). The type must be passed as well, to
+ enable the library to determine whether the parameter is a wide
+ character or a request.
The form driver requests are as follows:
- NameDescription
+ NameDescription
---------------------------------------------------------------------
REQ_BEG_FIELD Move to the beginning of the field.
REQ_BEG_LINE Move to the beginning of the line.
@@ -110,8 +112,8 @@
REQ_LEFT_FIELD Move left to a field.
REQ_NEW_LINE Insert or overlay a new line.
REQ_NEXT_CHAR Move to the next char.
- REQ_NEXT_CHOICE Display next field choice.
+ REQ_NEXT_CHOICE Display next field choice.
REQ_NEXT_FIELD Move to the next field.
REQ_NEXT_LINE Move to the next line.
REQ_NEXT_PAGE Move to the next page.
@@ -158,19 +160,19 @@
The form driver provides low-level control over updates to the form
fields. The form driver also provides for validating modified fields
to ensure that the contents meet whatever constraints an application
- may attach using set_field_type.
+ may attach using set_field_type.
You can validate a field without making any changes to it using
- REQ_VALIDATION. The form driver also validates a field in these cases:
+ REQ_VALIDATION. The form driver also validates a field in these cases:
- o a call to set_current_field attempts to move to a different field.
+ o a call to set_current_field attempts to move to a different field.
- o a call to set_current_page attempts to move to a different page of
+ o a call to set_current_page attempts to move to a different page of
the form.
- o a request attempts to move to a different field.
+ o a request attempts to move to a different field.
- o a request attempts to move to a different page of the form.
+ o a request attempts to move to a different page of the form.
In each case, the move fails if the field is invalid.
@@ -202,70 +204,73 @@
If you click at an field inside the display area of the form:
- o the form cursor is positioned to that field.
+ o the form cursor is positioned to that field.
- o If you double-click a field, the form cursor is positioned to
- that field and E_UNKNOWN_COMMAND is returned. This return value
+ o If you double-click a field, the form cursor is positioned to
+ that field and E_UNKNOWN_COMMAND is returned. This return value
makes sense, because a double click usually means that an field-
specific action should be returned. It is exactly the purpose
- of this return value to signal that an application specific com-
- mand should be executed.
+ of this return value to signal that an application specific
+ command should be executed.
- o If a translation into a request was done, form_driver returns
+ o If a translation into a request was done, form_driver returns
the result of this request.
If you clicked outside the user window or the mouse event could not be
- translated into a form request an E_REQUEST_DENIED is returned.
+ translated into a form request an E_REQUEST_DENIED is returned.
If the second argument is neither printable nor one of the above pre-
defined form requests, the driver assumes it is an application-specific
- command and returns E_UNKNOWN_COMMAND. Application-defined commands
- should be defined relative to MAX_COMMAND, the maximum value of these
+ command and returns E_UNKNOWN_COMMAND. Application-defined commands
+ should be defined relative to MAX_COMMAND, the maximum value of these
pre-defined requests.
- form_driver returns one of the following error codes:
+ form_driver returns one of the following error codes:
- E_OK The routine succeeded.
+ E_OK The routine succeeded.
- E_BAD_ARGUMENT
+ E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
- E_BAD_STATE
+ E_BAD_STATE
Routine was called from an initialization or termination function.
- E_NOT_POSTED
+ E_NOT_POSTED
The form has not been posted.
- E_INVALID_FIELD
+ E_INVALID_FIELD
Contents of field is invalid.
- E_REQUEST_DENIED
+ E_NOT_CONNECTED
+ No fields are connected to the form.
+
+ 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)).
- E_UNKNOWN_COMMAND
+ E_UNKNOWN_COMMAND
The form driver code saw an unknown request code.
- The header file <form.h> automatically includes the header files
- <curses.h>.
+ The header file <form.h> automatically includes the header files
+ <curses.h>.
- These routines emulate the System V forms library. They were not sup-
- ported on Version 7 or BSD versions.
+ These routines emulate the System V forms library. They were not
+ supported on Version 7 or BSD versions.