X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_driver.3x.html;h=a66307f1d2fb82d9a4c2d1b22d5dc39dc7b54ec0;hp=0d9efcfde7d2f0ccb252167860da85e500e69941;hb=71c0306f0824ef2b10c4c5813fb003db48f3012e;hpb=027ae42953e3186daed8f3882da73de48291b606
diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html
index 0d9efcfd..a66307f1 100644
--- a/doc/html/man/form_driver.3x.html
+++ b/doc/html/man/form_driver.3x.html
@@ -1,7 +1,7 @@
@@ -60,9 +60,21 @@
DESCRIPTION
Once a form has been posted (displayed), you should funnel
input events to it through form_driver. This routine has
- two major input cases; either the input is a form naviga-
- tion request or it's a printable ASCII character. The
- form driver requests are as follows:
+ 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.
+
+ - 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.
+
+ The form driver requests are as follows:
REQ_NEXT_PAGE
Move to the next page.
@@ -241,17 +253,62 @@
REQ_PREV_CHOICE
Display previous field choice.
- If the second argument is a printable ASCII character, the
+ If the second argument is a printable character, the
driver places it in the current position in the current
field. If it is one of the forms requests listed above,
that request is executed.
- If the second argument is neither printable ASCII 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 pre-defined requests.
+ 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-
+ 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_PAGE is generated for a double-click and
+
+ 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_PAGE is generated for a double-click and
+
+ 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.
+
+ - 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.
+
+ - 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-
+ MAND. Application-defined commands should be defined rel-
+ ative to MAX_COMMAND, the maximum value of these pre-
+ defined requests.
@@ -261,7 +318,7 @@
E_OK The routine succeeded.
E_BAD_ARGUMENT
- Routine detected an incorrect or out-of-range argu-
+ Routine detected an incorrect or out-of-range argu-
ment.
E_BAD_STATE
@@ -286,7 +343,7 @@
SEE ALSO
- curses(3x), form(3x).
+ curses(3x), form(3x), wgetch(3x).
@@ -297,13 +354,13 @@
PORTABILITY
- These routines emulate the System V forms library. They
+ 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
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.