-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998,2002 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_driver.3x,v 1.9 2002/02/16 22:39:52 tom Exp @
+ * @Id: form_driver.3x,v 1.22 2010/12/04 18:38:55 tom Exp @
-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
<TITLE>form_driver 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<H1>form_driver 3x</H1>
<HR>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
<STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG> <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
</PRE>
+<H2>
<a name="h2-NAME">NAME</a></H2><PRE>
<STRONG>form_driver</STRONG> - command-processing loop of the form system
</PRE>
+<H2>
<a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
int form_driver(FORM *form, int c);
</PRE>
-<H2>
DESCRIPTION</H2><PRE>
+<H2>
<a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Once a form has been posted (displayed), you should funnel
input events to it through <STRONG>form_driver</STRONG>. 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:
+
+ <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
+ returned by <STRONG>wgetch</STRONG>.
+
+ <STRONG>o</STRONG> 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.
+
+ <STRONG>o</STRONG> 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.
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
- <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application-defined commands should be
- defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of
- these pre-defined requests.
+
+</PRE>
+<H3><a name="h3-MOUSE-HANDLING">MOUSE HANDLING</a></H3><PRE>
+ 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:
+
+ <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
+ 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.
+
+ <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
+ <STRONG>E_REQUEST_DENIED</STRONG> is returned.
</PRE>
-<H2>RETURN VALUE</H2><PRE>
- <STRONG>form_driver</STRONG> return one of the following error codes:
+<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
+ 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-
+ defined requests.
- <STRONG>E_OK</STRONG> The routine succeeded.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+</PRE>
+<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ <STRONG>form_driver</STRONG> returns one of the following error codes:
+
+ <STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argu-
<STRONG>E_NOT_POSTED</STRONG>
The form has not been posted.
- <STRONG>E_UNKNOWN_COMMAND</STRONG>
- The form driver code saw an unknown request code.
-
<STRONG>E_INVALID_FIELD</STRONG>
Contents of field is invalid.
<STRONG>E_REQUEST_DENIED</STRONG>
The form driver could not process the request.
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno</STRONG>).
+
+ <STRONG>E_UNKNOWN_COMMAND</STRONG>
+ The form driver code saw an unknown request code.
+
</PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
+<H2>
<a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>.
</PRE>
+<H2>
<a name="h2-NOTES">NOTES</a></H2><PRE>
The header file <STRONG><form.h></STRONG> automatically includes the header
files <STRONG><curses.h></STRONG>.
</PRE>
-<H2>
PORTABILITY</H2><PRE>
+<H2>
<a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
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
curses by Eric S. Raymond.
<STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-MOUSE-HANDLING">MOUSE HANDLING</a></li>
+<li><a href="#h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></li>
+</ul>
+</li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff