+
#include <form.h>
int form_driver(FORM *form, int c);
-DESCRIPTION
+
Once a form has been posted (displayed), you should funnel
input events to it through form_driver. This routine has
three major input cases:
- - 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.
+ 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.
- - The input is a printable character. Printable charac-
- ters (which must be positive, less than 256) are
- checked according to the program's locale settings.
+ o The input is a printable character. Printable charac-
+ ters (which must be positive, less than 256) are
+ checked according to the program's locale settings.
- - The input is the KEY_MOUSE special key associated with
- an mouse event.
+ o The input is the KEY_MOUSE special key associated with
+ an mouse event.
The form driver requests are as follows:
@@ -258,51 +258,54 @@
field. If it is one of the forms requests listed above,
that request is executed.
- MOUSE HANDLING
+
+
+
If the second argument is the KEY_MOUSE special key, the
associated mouse event is translated into one of the above
pre-defined requests. Currently only clicks in the user
- window (e.g. inside the form display area or the decora-
+ window (e.g., inside the form display area or the decora-
tion window) are handled.
If you click above the display region of the form:
- a REQ_PREV_FIELD is generated for a single click,
+ a REQ_PREV_FIELD is generated for a single click,
- a REQ_PREV_PAGE is generated for a double-click and
+ a REQ_PREV_PAGE is generated for a double-click and
- a REQ_FIRST_FIELD is generated for a triple-click.
+ a REQ_FIRST_FIELD is generated for a triple-click.
If you click below the display region of the form:
- a REQ_NEXT_FIELD is generated for a single click,
+ a REQ_NEXT_FIELD is generated for a single click,
- a REQ_NEXT_PAGE is generated for a double-click and
+ a REQ_NEXT_PAGE is generated for a double-click and
- a REQ_LAST_FIELD is generated for a triple-click.
+ a REQ_LAST_FIELD is generated for a triple-click.
If you click at an field inside the display area of the
form:
- - the form cursor is positioned to that field.
+ o the form cursor is positioned to that field.
- - 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 sig-
- nal that an application specific command should
- be executed.
+ 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 pur-
+ pose of this return value to signal that an appli-
+ cation specific command should be executed.
- - If a translation into a request was done,
- form_driver returns the result of this request.
+ 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.
- APPLICATION-DEFINED COMMANDS
+
+
+
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_COM-
@@ -312,7 +315,7 @@
-RETURN VALUE
+
form_driver returns one of the following error codes:
E_OK The routine succeeded.
@@ -342,24 +345,24 @@
-SEE ALSO
- curses(3x), form(3x), wgetch(3x).
+
+ curses(3x), form(3x), form_variables(3x), curs_getch(3x).
-NOTES
+
The header file <form.h> automatically includes the header
files <curses.h>.
-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.
@@ -367,10 +370,22 @@
form_driver(3x)
-
-
-Man(1) output converted with
-man2html
-
+