ncurses 5.7 - patch 20100731

[ncurses.git] / man / form_driver.3x

diff --git a/man/form_driver.3x b/man/form_driver.3x
index 4b0576f042e0948b2a0a7dc130fa345f99592f29..0e4567fb588f024291adf9382d00f7088ffa39db 100644 (file)
--- a/man/form_driver.3x
+++ b/man/form_driver.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2008,2010 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            *


@@ -26,10 +26,10 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_driver.3x,v 1.16 2008/06/21 21:55:39 tom Exp $
+.\" $Id: form_driver.3x,v 1.18 2010/07/31 14:49:44 tom Exp $

 .TH form_driver 3X ""
 .SH NAME
 .TH form_driver 3X ""
 .SH NAME

-\fBform_driver\fR - command-processing loop of the form system
+\fBform_driver\fR \- command-processing loop of the form system

 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br


@@ -39,17 +39,17 @@ int form_driver(FORM *form, int c);
 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
 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

--
+\-

 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
 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

--
+\-

 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
 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

--
+\-

 The input is the KEY_MOUSE special key associated with an mouse event.
 .PP
 The form driver requests are as follows:
 The input is the KEY_MOUSE special key associated with an mouse event.
 .PP
 The form driver requests are as follows:


@@ -238,7 +238,7 @@ requests listed above, that request is executed.
 .PP
 If the second argument is the KEY_MOUSE special key, the associated
 mouse event is translated into one of the above pre-defined requests.
 .PP
 If the second argument is the KEY_MOUSE special key, the associated
 mouse event is translated into one of the above pre-defined requests.

-Currently only clicks in the user window (e.g. inside the form display
+Currently only clicks in the user window (e.g., inside the form display

 area or the decoration window) are handled.
 .PP
 If you click above the display region of the form:
 area or the decoration window) are handled.
 .PP
 If you click above the display region of the form:


@@ -264,10 +264,10 @@ a REQ_LAST_FIELD is generated for a triple-click.
 If you click at an field inside the display area of the form:
 .RS
 .TP 3
 If you click at an field inside the display area of the form:
 .RS
 .TP 3

--
+\-

 the form cursor is positioned to that field.
 .TP 3
 the form cursor is positioned to that field.
 .TP 3

--
+\-

 If you double-click a field,
 the form cursor is positioned to that field
 and \fBE_UNKNOWN_COMMAND\fR is returned.
 If you double-click a field,
 the form cursor is positioned to that field
 and \fBE_UNKNOWN_COMMAND\fR is returned.


@@ -277,7 +277,7 @@ be returned.
 It is exactly the purpose of this return value to signal that an
 application specific command should be executed.
 .TP 3
 It is exactly the purpose of this return value to signal that an
 application specific command should be executed.
 .TP 3

--
+\-

 If a translation
 into a request was done, \fBform_driver\fR returns the result of this request.
 .RE
 If a translation
 into a request was done, \fBform_driver\fR returns the result of this request.
 .RE