Curses Library Functions                     formdriver(3CURSES)



NAME
     formdriver - command processor for the forms subsystem

SYNOPSIS
     cc [ flag... ] file... -lform  -lcurses  [ library... ]
     #include 

     int formdriver(FORM *form, int c);


DESCRIPTION
     The formdriver() function is the  workhorse  of  the  forms
     subsystem;   it  checks to determine whether the character c
     is a forms request or data. If it is  a  request,  the  form
     driver executes the request and reports the result. If it is
     data (a printable ASCI character), it enters the data  into
     the  current  position  in  the  current field. If it is not
     recognized, the form driver assumes it  is  an  application-
     defined  command  and returns EUNKNOWNCOMAND. Application
     defined commands should be defined relative to  MAXCOMAND,
     the maximum value of a request listed below.


     Form driver requests:

     REQNEXTPAGE       Move to the next page.


     REQPREVPAGE       Move to the previous page.


     REQFIRSTPAGE      Move to the first page.


     REQLASTPAGE       Move to the last page.


     REQNEXTFIELD      Move to the next field.


     REQPREVFIELD      Move to the previous field.


     REQFIRSTFIELD     Move to the first field.


     REQLASTFIELD      Move to the last field.


     REQSNEXTFIELD     Move to the sorted next field.





SunOS 5.11          Last change: 31 Dec 1996                    1






Curses Library Functions                     formdriver(3CURSES)



     REQSPREVFIELD     Move to the sorted prev field.


     REQSFIRSTFIELD    Move to the sorted first field.


     REQSLASTFIELD     Move to the sorted last field.


     REQLEFTFIELD      Move left to field.


     REQRIGHTFIELD     Move right to field.


     REQUPFIELD        Move up to field.


     REQDOWNFIELD      Move down to field.


     REQNEXTCHAR       Move to the next character in the field.


     REQPREVCHAR       Move to the previous  character  in  the
                         field.


     REQNEXTLINE       Move to the next line in the field.


     REQPREVLINE       Move to the previous line in the field.


     REQNEXTWORD       Move to the next word in the field.


     REQPREVWORD       Move to the previous word in the field.


     REQBEGFIELD       Move to the first char in the field.


     REQENDFIELD            Move after the  last  char  in  the
                         field.


     REQBEGLINE        Move to the beginning of the line.


     REQENDLINE        Move after the last char in the line.




SunOS 5.11          Last change: 31 Dec 1996                    2






Curses Library Functions                     formdriver(3CURSES)



     REQLEFTCHAR       Move left in the field.


     REQRIGHTCHAR      Move right in the field.


     REQUPCHAR         Move up in the field.


     REQDOWNCHAR       Move down in the field.


     REQNEWLINE        Insert/overlay a new line.


     REQINSCHAR        Insert the blank character at  the  cur-
                         sor.


     REQINSLINE        Insert a blank line at the cursor.


     REQDELCHAR        Delete the character at the cursor.


     REQDELPREV        Delete the character before the cursor.


     REQDELINE        Delete the line at the cursor.


     REQDELWORD        Delete the word at the cursor.


     REQCLREOL         Clear to the end of the line.


     REQCLREOF         Clear to the end of the field.


     REQCLRFIELD       Clear the entire field.


     REQOVLMODE        Enter overlay mode.


     REQINSMODE        Enter insert mode.


     REQSCRFLINE       Scroll the field forward a line.





SunOS 5.11          Last change: 31 Dec 1996                    3






Curses Library Functions                     formdriver(3CURSES)



     REQSCRBLINE       Scroll the field backward a line.


     REQSCRFPAGE       Scroll the field forward a page.


     REQSCRBPAGE            Scroll the field backward a page.


     REQSCRFHPAGE      Scroll the field forward half a page.


     REQSCRBHPAGE      Scroll the field backward half a page.


     REQSCRFCHAR       Horizontal scroll forward a character.


     REQSCRBCHAR            Horizontal scroll backward a  char-
                         acter


     REQSCRHFLINE      Horizontal scroll forward a line.


     REQSCRHBLINE      Horizontal scroll backward a line.


     REQSCRHFHALF      Horizontal scroll forward half a line.


     REQSCRHBHALF      Horizontal scroll backward half a line.


     REQVALIDATION      Validate field.


     REQPREVCHOICE     Display the previous field choice.


     REQNEXTCHOICE     Display the next field choice.


RETURN VALUES
     The formdriver() function returns one of the following:

     EOK                 The function returned successfully.


     ESYSTEMEROR       System error.





SunOS 5.11          Last change: 31 Dec 1996                    4






Curses Library Functions                     formdriver(3CURSES)



     EBADARGUMENT       An argument is incorrect.


     ENOTPOSTED         The form is not posted.


     EINVALIDFIELD      The field contents are invalid.


     EBADSTATE          The routine was called from an initial-
                          ization or termination function.


     EREQUESTDENIED     The form driver request failed.


     EUNKNOWNCOMAND    An unknown request was  passed  to  the
                          form driver.


ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     MT-Level                     Unsafe                      
    


SEE ALSO
     curses(3CURSES), forms(3CURSES), attributes(5)

NOTES
     The  header    automatically  includes  the  headers
      and .
















SunOS 5.11          Last change: 31 Dec 1996                    5