+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!--
+ ****************************************************************************
+ * Copyright (c) 1998,2002 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 *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote 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 @
+-->
<HTML>
+<HEAD>
+<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">
+</HEAD>
<BODY>
+<H1>form_driver 3x</H1>
+<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
</PRE>
<H2>NAME</H2><PRE>
- <B>form_driver</B> - command-processing loop of the form system
+ <STRONG>form_driver</STRONG> - command-processing loop of the form system
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><form.h></B>
+ <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
int form_driver(FORM *form, int c);
</PRE>
<H2>DESCRIPTION</H2><PRE>
Once a form has been posted (displayed), you should funnel
- input events to it through <B>form_driver</B>. This routine has
+ 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:
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
- <B>E_UNKNOWN_COMMAND</B>. Application-defined commands should be
- defined relative to <B>MAX_COMMAND</B>, the maximum value of
+ <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>
<H2>RETURN VALUE</H2><PRE>
- <B>form_driver</B> return one of the following error codes:
+ <STRONG>form_driver</STRONG> return one of the following error codes:
- <B>E_OK</B> The routine succeeded.
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno</B>).
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno</STRONG>).
- <B>E_BAD_ARGUMENT</B>
+ <STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argu-
ment.
- <B>E_BAD_STATE</B>
+ <STRONG>E_BAD_STATE</STRONG>
Routine was called from an initialization or
termination function.
- <B>E_NOT_POSTED</B>
+ <STRONG>E_NOT_POSTED</STRONG>
The form has not been posted.
- <B>E_UNKNOWN_COMMAND</B>
+ <STRONG>E_UNKNOWN_COMMAND</STRONG>
The form driver code saw an unknown request code.
- <B>E_INVALID_FIELD</B>
+ <STRONG>E_INVALID_FIELD</STRONG>
Contents of field is invalid.
- <B>E_REQUEST_DENIED</B>
+ <STRONG>E_REQUEST_DENIED</STRONG>
The form driver could not process the request.
</PRE>
<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
</PRE>
<H2>NOTES</H2><PRE>
- The header file <B><form.h></B> automatically includes the header
- files <B><curses.h></B>.
+ The header file <STRONG><form.h></STRONG> automatically includes the header
+ files <STRONG><curses.h></STRONG>.
</PRE>
projects / ncurses.git / blobdiff