X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fform_driver.3x.html;h=f0d036f37db707fb12f0db659719f46f9881ab07;hb=refs%2Ftags%2Fv5.4;hp=36a27aa81bc531a45453985b2f6eeaf47cc7ce20;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html index 36a27aa8..f0d036f3 100644 --- a/doc/html/man/form_driver.3x.html +++ b/doc/html/man/form_driver.3x.html @@ -1,23 +1,65 @@ + + + +form_driver 3x + + + +

form_driver 3x

 
+form_driver(3x)                                   form_driver(3x)
+
+
+

NAME

-       form_driver - command-processing loop of the form system
+       form_driver - command-processing loop of the form system

SYNOPSIS

-       #include <form.h>
+       #include <form.h>
        int form_driver(FORM *form, int c);

DESCRIPTION

        Once a form has been posted (displayed), you should funnel
-       input events to it through form_driver.  This routine  has
+       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:
@@ -115,7 +157,6 @@
             Move down in the field.
 
 
-
        REQ_NEW_LINE
             Insert or overlay a new line.
 
@@ -171,6 +212,7 @@
        REQ_SCR_BHPAGE
             Scroll the field backward half a page.
 
+
        REQ_SCR_FCHAR
             Scroll the field forward a character.
 
@@ -207,50 +249,50 @@
        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
+       E_UNKNOWN_COMMAND.  Application-defined commands should be
+       defined relative to  MAX_COMMAND,  the  maximum  value  of
        these pre-defined requests.

RETURN VALUE

-       form_driver return one of the following error codes:
+       form_driver return one of the following error codes:
 
-       E_OK The routine succeeded.
+       E_OK The routine succeeded.
 
-       E_SYSTEM_ERROR
-            System error occurred (see errno).
+       E_SYSTEM_ERROR
+            System error occurred (see errno).
 
-       E_BAD_ARGUMENT
+       E_BAD_ARGUMENT
             Routine  detected  an incorrect or out-of-range argu-
             ment.
 
-       E_BAD_STATE
-            Routine  was  called  from   an   initialization   or
-            termination function.
+       E_BAD_STATE
+            Routine was called from an initialization or termina-
+            tion function.
 
-       E_NOT_POSTED
+       E_NOT_POSTED
             The form has not been posted.
 
-       E_UNKNOWN_COMMAND
+       E_UNKNOWN_COMMAND
             The form driver code saw an unknown request code.
 
-       E_INVALID_FIELD
+       E_INVALID_FIELD
             Contents of field is invalid.
 
-       E_REQUEST_DENIED
+       E_REQUEST_DENIED
             The form driver could not process the request.

NOTES

-       The header file <form.h> automatically includes the header
-       files <curses.h>.
+       The header file <form.h> automatically includes the header
+       files <curses.h>.