X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_driver.3x;h=64a1e487b61e881f7c2fe838965ea3e446b49746;hb=d61c3c6a831d18ef0ed6f797ac97d60fffc2f158;hp=75c0a7b754e7891104252bcb96ece32df0c429ba;hpb=3e7e5f8b5c4e8e499f682a1c414c576c16d47532;p=ncurses.git
diff --git a/man/form_driver.3x b/man/form_driver.3x
index 75c0a7b7..64a1e487 100644
--- a/man/form_driver.3x
+++ b/man/form_driver.3x
@@ -1,5 +1,6 @@
.\"***************************************************************************
-.\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. *
+.\" Copyright 2018-2019,2020 Thomas E. Dickey *
+.\" Copyright 1998-2016,2017 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 *
@@ -26,10 +27,11 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: form_driver.3x,v 1.27 2017/06/23 22:56:39 tom Exp $
+.\" $Id: form_driver.3x,v 1.33 2020/02/02 23:34:34 tom Exp $
.TH form_driver 3X ""
.de bP
-.IP \(bu 4
+.ie n .IP \(bu 4
+.el .IP \(bu 2
..
.SH NAME
\fBform_driver\fR,
@@ -48,7 +50,8 @@ through \fBform_driver\fR. This routine has three major input cases:
.bP
The input is a form navigation request.
Navigation request codes are constants defined in \fB
\fP,
-which are distinct from the key- and character codes returned by \fBwgetch\fP(3X).
+which are distinct from the key- and character codes returned
+by \fBwgetch\fP(3X).
.bP
The input is a printable character.
Printable characters (which must be positive, less than 256) are
@@ -132,14 +135,16 @@ REQ_VALIDATION Validate field.
.TE
.PP
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
+in the current position in the current field.
+If it is one of the forms
requests listed above, that request is executed.
.SS Field validation
-The form library makes updates to the window associated with form fields rather than
-directly to the field buffers.
+The form library makes updates to the window associated
+with form fields rather than directly to the field buffers.
.PP
The form driver provides low-level control over updates to the form fields.
-The form driver also provides for validating modified fields to ensure that the contents
+The form driver also provides for validating modified fields
+to ensure that the contents
meet whatever constraints an application may attach using \fBset_field_type\fP.
.PP
.PP
@@ -149,7 +154,8 @@ The form driver also validates a field in these cases:
.bP
a call to \fBset_current_field\fP attempts to move to a different field.
.bP
-a call to \fBset_current_page\fP attempts to move to a different page of the form.
+a call to \fBset_current_page\fP attempts to move
+to a different page of the form.
.bP
a request attempts to move to a different field.
.bP
@@ -205,7 +211,8 @@ If a translation
into a request was done, \fBform_driver\fR returns the result of this request.
.RE
.PP
-If you clicked outside the user window or the mouse event could not be translated
+If you clicked outside the user window
+or the mouse event could not be translated
into a form request an \fBE_REQUEST_DENIED\fR is returned.
.SS Application-defined commands
.PP
@@ -232,11 +239,14 @@ The form has not been posted.
.B E_INVALID_FIELD
Contents of field is invalid.
.TP 5
+.B E_NOT_CONNECTED
+No fields are connected to the form.
+.TP 5
.B E_REQUEST_DENIED
The form driver could not process the request.
.TP 5
.B E_SYSTEM_ERROR
-System error occurred (see \fBerrno\fR).
+System error occurred (see \fBerrno\fR(3)).
.TP 5
.B E_UNKNOWN_COMMAND
The form driver code saw an unknown request code.
@@ -253,8 +263,9 @@ The form driver code saw an unknown request code.
The header file \fB\fR automatically includes the header files
\fB\fR.
.SH PORTABILITY
-These routines emulate the System V forms library. They were not supported on
+These routines emulate the System V forms library.
+They were not supported on
Version 7 or BSD versions.
.SH AUTHORS
-Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
-S. Raymond.
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.