* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_driver.3x,v 1.24 2015/08/02 18:21:11 tom Exp @
+ * @Id: form_driver.3x,v 1.25 2015/12/05 21:06:26 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
</PRE>
<H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>form_driver</STRONG> - command-processing loop of the form system
+ <STRONG>form_driver</STRONG>, <STRONG>form_driver_w</STRONG> - command-processing loop of
+ the form system
</PRE>
</PRE>
<H3><a name="h3-form_driver">form_driver</a></H3><PRE>
Once a form has been posted (displayed), you should funnel
- input events to it through <STRONG>form_driver</STRONG>. This routine has
+ input events to it through <STRONG>form_driver</STRONG>. This routine has
three major input cases:
- <STRONG>o</STRONG> The input is a form navigation request. Navigation
+ <STRONG>o</STRONG> The input is a form navigation request. Navigation
request codes are constants defined in <STRONG><form.h></STRONG>, which
- are distinct from the key- and character codes
+ are distinct from the key- and character codes
returned by <STRONG><A HREF="wgetch.3x.html">wgetch(3x)</A></STRONG>.
<STRONG>o</STRONG> The input is a printable character. Printable charac-
- ters (which must be positive, less than 256) are
+ ters (which must be positive, less than 256) are
checked according to the program's locale settings.
<STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with
</PRE>
<H3><a name="h3-form_driver_w">form_driver_w</a></H3><PRE>
- This extension simplifies the use of the forms library
- using wide characters. The input is either a key code (a
+ 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 <STRONG><A HREF="get_wch.3x.html">get_wch(3x)</A></STRONG>. The
- type must be passed as well, to enable the library to
- determine whether the parameter is a wide character or a
+ type must be passed as well, to enable the library to
+ determine whether the parameter is a wide character or a
request.
REQ_LAST_FIELD Move to the last field.
REQ_LAST_PAGE Move to the last field.
REQ_LEFT_CHAR Move left in the field.
- REQ_LEFT_FIELD Move left to a field.
+ 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_UP_FIELD Move up to a field.
REQ_VALIDATION Validate field.
- 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,
+ 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.
</PRE>
<H3><a name="h3-Mouse-handling">Mouse handling</a></H3><PRE>
- If the second argument is the KEY_MOUSE special key, the
+ 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-
+ 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_LAST_FIELD is generated for a triple-click.
- If you click at an field inside the display area of the
+ If you click at an field inside the display area of the
form:
<STRONG>o</STRONG> the form cursor is positioned to that field.
- <STRONG>o</STRONG> If you double-click a field, the form cursor is
- positioned to that field and <STRONG>E_UNKNOWN_COMMAND</STRONG> is
+ <STRONG>o</STRONG> If you double-click a field, the form cursor is
+ positioned to that field and <STRONG>E_UNKNOWN_COMMAND</STRONG> 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-
+ 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.
- <STRONG>o</STRONG> If a translation into a request was done,
+ <STRONG>o</STRONG> If a translation into a request was done,
<STRONG>form_driver</STRONG> 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
+ If you clicked outside the user window or the mouse event
+ could not be translated into a form request an
<STRONG>E_REQUEST_DENIED</STRONG> is returned.
</PRE>
<H3><a name="h3-Application-defined-commands">Application-defined commands</a></H3><PRE>
If the second argument is neither printable nor one of the
- above pre-defined form requests, the driver assumes it is
+ above pre-defined form requests, the driver assumes it is
an application-specific command and returns <STRONG>E_UNKNOWN_COM-</STRONG>
<STRONG>MAND</STRONG>. Application-defined commands should be defined rel-
- ative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre-
+ ative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre-
defined requests.
<STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_BAD_ARGUMENT</STRONG>
- Routine detected an incorrect or out-of-range argu-
+ Routine detected an incorrect or out-of-range argu-
ment.
<STRONG>E_BAD_STATE</STRONG>
</PRE>
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- 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.
</PRE>
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
projects / ncurses.git / blobdiff