]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/form_driver.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 5.7 - patch 20110108
[ncurses.git] / doc / html / man / form_driver.3x.html
diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html
index 36a27aa81bc531a45453985b2f6eeaf47cc7ce20..ab9a263787d99994ce32ec3f271bf5e77fc0bf20 100644 (file)
--- a/doc/html/man/form_driver.3x.html
+++ b/doc/html/man/form_driver.3x.html
@@ -1,26 +1,80 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!-- 
+  ****************************************************************************
+  * 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            *
+  * "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.22 2010/12/04 18:38:55 tom Exp @
+-->
 <HTML>
 <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>
 <BODY>
+<H1>form_driver 3x</H1>
+<HR>
 <PRE>
 <!-- Manpage converted by man2html 3.0.1 -->
 <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>NAME</H2><PRE>
 
 </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>
 
 
 </PRE>
 <H2>SYNOPSIS</H2><PRE>
-       <B>#include</B> <B>&lt;form.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
        int form_driver(FORM *form, int c);
 
 
 </PRE>
 <H2>DESCRIPTION</H2><PRE>
        Once a form has been posted (displayed), you should funnel
        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
-       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:
+       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
+           request codes are constants defined in <STRONG>&lt;form.h&gt;</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_NEXT_PAGE
             Move to the next page.
@@ -115,7 +169,6 @@
             Move down in the field.
 
 
             Move down in the field.
 
 
-
        REQ_NEW_LINE
             Insert or overlay a new line.
 
        REQ_NEW_LINE
             Insert or overlay a new line.
 
@@ -171,6 +224,7 @@
        REQ_SCR_BHPAGE
             Scroll the field backward half a page.
 
        REQ_SCR_BHPAGE
             Scroll the field backward half a page.
 
+
        REQ_SCR_FCHAR
             Scroll the field forward a character.
 
        REQ_SCR_FCHAR
             Scroll the field forward a character.
 
@@ -199,58 +253,102 @@
        REQ_PREV_CHOICE
             Display previous field choice.
 
        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.
 
        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
-       <B>E_UNKNOWN_COMMAND</B>.  Application-defined commands should be
-       defined relative to  <B>MAX_COMMAND</B>,  the  maximum  value  of
-       these pre-defined requests.
+   <STRONG>MOUSE</STRONG> <STRONG>HANDLING</STRONG>
+       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.
+
+   <STRONG>APPLICATION-DEFINED</STRONG> <STRONG>COMMANDS</STRONG>
+       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.
 
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
 
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
-       <B>form_driver</B> return one of the following error codes:
+       <STRONG>form_driver</STRONG> returns 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>).
-
-       <B>E_BAD_ARGUMENT</B>
+       <STRONG>E_BAD_ARGUMENT</STRONG>
             Routine  detected  an incorrect or out-of-range argu-
             ment.
 
             Routine  detected  an incorrect or out-of-range argu-
             ment.
 
-       <B>E_BAD_STATE</B>
-            Routine  was  called  from   an   initialization   or
-            termination function.
+       <STRONG>E_BAD_STATE</STRONG>
+            Routine was called from an initialization or termina-
+            tion function.
 
 
-       <B>E_NOT_POSTED</B>
+       <STRONG>E_NOT_POSTED</STRONG>
             The form has not been posted.
 
             The form has not been posted.
 
-       <B>E_UNKNOWN_COMMAND</B>
-            The form driver code saw an unknown request code.
-
-       <B>E_INVALID_FIELD</B>
+       <STRONG>E_INVALID_FIELD</STRONG>
             Contents of field is invalid.
 
             Contents of field is invalid.
 
-       <B>E_REQUEST_DENIED</B>
+       <STRONG>E_REQUEST_DENIED</STRONG>
             The form driver could not process the request.
 
             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>
 <H2>SEE ALSO</H2><PRE>
 
 </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>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>, <STRONG><A HREF="getch.3x.html">getch(3x)</A></STRONG>.
 
 
 </PRE>
 <H2>NOTES</H2><PRE>
 
 
 </PRE>
 <H2>NOTES</H2><PRE>
-       The header file <B>&lt;form.h&gt;</B> automatically includes the header
-       files <B>&lt;curses.h&gt;</B>.
+       The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
+       files <STRONG>&lt;curses.h&gt;</STRONG>.
 
 
 </PRE>
 
 
 </PRE>
@@ -266,29 +364,7 @@
 
 
 
 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+                                                        <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
 </PRE>
 <HR>
 <ADDRESS>
 </PRE>
 <HR>
 <ADDRESS>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/