.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: form_driver.3x,v 1.18 2010/07/31 14:49:44 tom Exp $
+.\" $Id: form_driver.3x,v 1.22 2010/12/04 18:38:55 tom Exp $
.TH form_driver 3X ""
+.de bP
+.IP \(bu 4
+..
.SH NAME
\fBform_driver\fR \- command-processing loop of the form system
.SH SYNOPSIS
.SH DESCRIPTION
Once a form has been posted (displayed), you should funnel input events to it
through \fBform_driver\fR. This routine has three major input cases:
-.TP 3
-\-
+.bP
The input is a form navigation request.
Navigation request codes are constants defined in \fB<form.h>\fP,
which are distinct from the key- and character codes returned by \fBwgetch\fP.
-.TP 3
-\-
+.bP
The input is a printable character.
Printable characters (which must be positive, less than 256) are
checked according to the program's locale settings.
-.TP 3
-\-
+.bP
The input is the KEY_MOUSE special key associated with an mouse event.
.PP
The form driver requests are as follows:
area or the decoration window) are handled.
.PP
If you click above the display region of the form:
-.RS
+.RS 3
.TP
a REQ_PREV_FIELD is generated for a single click,
.TP
.RE
.PP
If you click below the display region of the form:
-.RS
+.RS 3
.TP
a REQ_NEXT_FIELD is generated for a single click,
.TP
.RE
.PP
If you click at an field inside the display area of the form:
-.RS
-.TP 3
-\-
+.RS 3
+.bP
the form cursor is positioned to that field.
-.TP 3
-\-
+.bP
If you double-click a field,
the form cursor is positioned to that field
and \fBE_UNKNOWN_COMMAND\fR is returned.
be returned.
It is exactly the purpose of this return value to signal that an
application specific command should be executed.
-.TP 3
-\-
+.bP
If a translation
into a request was done, \fBform_driver\fR returns the result of this request.
.RE
.SH SEE ALSO
\fBcurses\fR(3X),
\fBform\fR(3X),
-\fBwgetch\fR(3X).
+\fBform_variables\fR(3X),
+\fBgetch\fR(3X).
.SH NOTES
The header file \fB<form.h>\fR automatically includes the header files
\fB<curses.h>\fR.
.SH AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
S. Raymond.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: