.\"***************************************************************************.\" 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 $.TH form_driver 3X "".SH NAME\fBform_driver\fR - command-processing loop of the form system.SH SYNOPSIS\fB#include <form.h>\fR.brint form_driver(FORM *form, int c);.br.SH DESCRIPTIONOnce a form has been posted (displayed), you should funnel input events to itthrough \fBform_driver\fR.  This routine has two major input cases; eitherthe input is a form navigation request or it's a printable ASCII character.The form driver requests are as follows:.TP 5REQ_NEXT_PAGEMove to the next page..TP 5REQ_PREV_PAGEMove to the previous page..TP 5REQ_FIRST_PAGEMove to the first page..TP 5REQ_LAST_PAGEMove to the last field..TP 5REQ_NEXT_FIELDMove to the next field..TP 5REQ_PREV_FIELDMove to the previous field..TP 5REQ_FIRST_FIELDMove to the first field..TP 5REQ_LAST_FIELDMove to the last field..TP 5REQ_SNEXT_FIELDMove to the sorted next field..TP 5REQ_SPREV_FIELDMove to the sorted previous field..TP 5REQ_SFIRST_FIELDMove to the sorted first field..TP 5REQ_SLAST_FIELDMove to the sorted last field..TP 5REQ_LEFT_FIELDMove left to a field..TP 5REQ_RIGHT_FIELDMove right to a field..TP 5REQ_UP_FIELDMove up to a field..TP 5REQ_DOWN_FIELDMove down to a field..TP 5REQ_NEXT_CHARMove to the next char..TP 5REQ_PREV_CHARMove to the previous char..TP 5REQ_NEXT_LINEMove to the next line..TP 5REQ_PREV_LINEMove to the previous line..TP 5REQ_NEXT_WORDMove to the next word..TP 5REQ_PREV_WORDMove to the previous word..TP 5REQ_BEG_FIELDMove to the beginning of the field..TP 5REQ_END_FIELDMove to the end of the field..TP 5REQ_BEG_LINEMove to the beginning of the line..TP 5REQ_END_LINEMove to the end of the line..TP 5REQ_LEFT_CHARMove left in the field..TP 5REQ_RIGHT_CHARMove right in the field..TP 5REQ_UP_CHARMove up in the field..TP 5REQ_DOWN_CHARMove down in the field..TP 5REQ_NEW_LINEInsert or overlay a new line..TP 5REQ_INS_CHARInsert a blank at the cursor..TP 5REQ_INS_LINEInsert a blank line at the cursor..TP 5REQ_DEL_CHARDelete character at the cursor..TP 5REQ_DEL_PREVDelete character before the cursor..TP 5REQ_DEL_LINEDelete line at the cursor..TP 5REQ_DEL_WORDDelete blank-delimited word at the cursor..TP 5REQ_CLR_EOLClear to end of line from cursor..TP 5REQ_CLR_EOFClear to end of field from cursor..TP 5REQ_CLR_FIELDClear the entire field..TP 5REQ_OVL_MODEEnter overlay mode..TP 5REQ_INS_MODEEnter insert mode..TP 5REQ_SCR_FLINEScroll the field forward a line..TP 5REQ_SCR_BLINEScroll the field backward a line..TP 5REQ_SCR_FPAGEScroll the field forward a page..TP 5REQ_SCR_BPAGEScroll the field backward a page..TP 5REQ_SCR_FHPAGEScroll the field forward half a page..TP 5REQ_SCR_BHPAGEScroll the field backward half a page..TP 5REQ_SCR_FCHARScroll the field forward a character..TP 5REQ_SCR_BCHARScroll the field backward a character..TP 5REQ_SCR_HFLINEHorizontal scroll the field forward a line..TP 5REQ_SCR_HBLINEHorizontal scroll the field backward a line..TP 5REQ_SCR_HFHALFHorizontal scroll the field forward half a line..TP 5REQ_SCR_HBHALFHorizontal scroll the field backward half a line..TPREQ_VALIDATIONValidate field..TPREQ_NEXT_CHOICEDisplay next field choice..TPREQ_PREV_CHOICEDisplay previous field choice..PPIf the second argument is a printable ASCII character, the driver places itin the current position in the current field.  If it is one of the formsrequests listed above, that request is executed..PPIf the second argument is neither printable ASCII nor one of the abovepre-defined form requests, the driver assumes it is an application-specificcommand and returns \fBE_UNKNOWN_COMMAND\fR.  Application-defined commandsshould be defined relative to \fBMAX_COMMAND\fR, the maximum value of thesepre-defined requests..SH RETURN VALUE\fBform_driver\fR return one of the following error codes:.TP 5\fBE_OK\fRThe routine succeeded..TP 5\fBE_SYSTEM_ERROR\fRSystem error occurred (see \fBerrno\fR)..TP 5\fBE_BAD_ARGUMENT\fRRoutine detected an incorrect or out-of-range argument..TP 5\fBE_BAD_STATE\fRRoutine was called from an initialization or termination function..TP 5\fBE_NOT_POSTED\fRThe form has not been posted..TP 5\fBE_UNKNOWN_COMMAND\fRThe form driver code saw an unknown request code..TP 5\fBE_INVALID_FIELD\fRContents of field is invalid..TP 5\fBE_REQUEST_DENIED\fRThe form driver could not process the request..SH SEE ALSO\fBcurses\fR(3X), \fBform\fR(3X)..SH NOTESThe header file \fB<form.h>\fR automatically includes the header files\fB<curses.h>\fR..SH PORTABILITYThese routines emulate the System V forms library.  They were not supported onVersion 7 or BSD versions..SH AUTHORSJuergen Pfeifer.  Manual pages and adaptation for new curses by EricS. Raymond..\"#.\"# The following sets edit modes for GNU EMACS.\"# Local Variables:.\"# mode:nroff.\"# fill-column:79.\"# End: