ncurses 6.2 - patch 20201107
[ncurses.git] / man / form_driver.3x
index 75c0a7b754e7891104252bcb96ece32df0c429ba..9b564f94de2bff3891ed514f8f08cb5564f15865 100644 (file)
@@ -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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_driver.3x,v 1.27 2017/06/23 22:56:39 tom Exp $
+.\" $Id: form_driver.3x,v 1.34 2020/10/17 23:28:04 tom Exp $
 .TH form_driver 3X ""
 .de bP
 .TH form_driver 3X ""
 .de bP
-.IP \(bu 4
+.ie n  .IP \(bu 4
+.el    .IP \(bu 2
 ..
 .SH NAME
 \fBform_driver\fR,
 \fBform_driver_w\fR \- command-processing loop of the form system
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 ..
 .SH NAME
 \fBform_driver\fR,
 \fBform_driver_w\fR \- command-processing loop of the form system
 .SH SYNOPSIS
 \fB#include <form.h>\fR
-.br
+.sp
 \fBint form_driver(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB);\fP
 .br
 \fBint form_driver_w(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB, wchar_t \fP\fIwch\fP\fB);\fP
 \fBint form_driver(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB);\fP
 .br
 \fBint form_driver_w(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB, wchar_t \fP\fIwch\fP\fB);\fP
@@ -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<form.h>\fP,
 .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(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
 .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
 .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
 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.
 .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
 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
 .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
 .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
 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
 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_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
 .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.
 .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<form.h>\fR automatically includes the header files
 \fB<curses.h>\fR.
 .SH PORTABILITY
 The header file \fB<form.h>\fR automatically includes the header files
 \fB<curses.h>\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
 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.