X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_driver.3x;h=4b0576f042e0948b2a0a7dc130fa345f99592f29;hp=6a6acc7b66c100028f4688dbb020ff42705ca917;hb=ca276baf720e3a44721b9e18955d3f546955c6c8;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/form_driver.3x b/man/form_driver.3x index 6a6acc7b..4b0576f0 100644 --- a/man/form_driver.3x +++ b/man/form_driver.3x @@ -1,4 +1,32 @@ -'\" t +.\"*************************************************************************** +.\" Copyright (c) 1998-2007,2008 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.16 2008/06/21 21:55:39 tom Exp $ .TH form_driver 3X "" .SH NAME \fBform_driver\fR - command-processing loop of the form system @@ -9,8 +37,21 @@ int form_driver(FORM *form, int c); .br .SH DESCRIPTION Once a form has been posted (displayed), you should funnel input events to it -through \fBform_driver\fR. This routine has two major input cases; either -the input is a form navigation request or it's a printable ASCII character. +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\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 the KEY_MOUSE special key associated with an mouse event. +.PP The form driver requests are as follows: .TP 5 REQ_NEXT_PAGE @@ -24,7 +65,7 @@ Move to the first page. .TP 5 REQ_LAST_PAGE Move to the last field. - +.sp .TP 5 REQ_NEXT_FIELD Move to the next field. @@ -61,7 +102,7 @@ Move up to a field. .TP 5 REQ_DOWN_FIELD Move down to a field. - +.sp .TP 5 REQ_NEXT_CHAR Move to the next char. @@ -104,7 +145,7 @@ Move up in the field. .TP 5 REQ_DOWN_CHAR Move down in the field. - +.sp .TP 5 REQ_NEW_LINE Insert or overlay a new line. @@ -141,7 +182,7 @@ Enter overlay mode. .TP 5 REQ_INS_MODE Enter insert mode. - +.sp .TP 5 REQ_SCR_FLINE Scroll the field forward a line. @@ -160,7 +201,7 @@ Scroll the field forward half a page. .TP 5 REQ_SCR_BHPAGE Scroll the field backward half a page. - +.sp .TP 5 REQ_SCR_FCHAR Scroll the field forward a character. @@ -179,7 +220,7 @@ Horizontal scroll the field forward half a line. .TP 5 REQ_SCR_HBHALF Horizontal scroll the field backward half a line. - +.sp .TP REQ_VALIDATION Validate field. @@ -190,43 +231,97 @@ Display next field choice. REQ_PREV_CHOICE Display previous field choice. .PP -If the second argument is a printable ASCII character, the driver places it +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 requests listed above, that request is executed. +.SS MOUSE HANDLING +.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 +area or the decoration window) are handled. +.PP +If you click above the display region of the form: +.RS +.TP +a REQ_PREV_FIELD is generated for a single click, +.TP +a REQ_PREV_PAGE is generated for a double-click and +.TP +a REQ_FIRST_FIELD is generated for a triple-click. +.RE +.PP +If you click below the display region of the form: +.RS +.TP +a REQ_NEXT_FIELD is generated for a single click, +.TP +a REQ_NEXT_PAGE is generated for a double-click and +.TP +a REQ_LAST_FIELD is generated for a triple-click. +.RE .PP -If the second argument is neither printable ASCII nor one of the above -pre-defined form requests, the drive assumes it is an application-specific +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 +- +If you double-click a field, +the form cursor is positioned to that field +and \fBE_UNKNOWN_COMMAND\fR is returned. +This return value makes sense, +because a double click usually means that an field-specific action should +be returned. +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 +.PP +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 +If the second argument is neither printable nor one of the above +pre-defined form requests, the driver assumes it is an application-specific command and returns \fBE_UNKNOWN_COMMAND\fR. Application-defined commands should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these pre-defined requests. .SH RETURN VALUE -\fBform_driver\fR return one of the following error codes: +\fBform_driver\fR returns one of the following error codes: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). -.TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_BAD_STATE\fR +.B E_BAD_STATE Routine was called from an initialization or termination function. .TP 5 -\fBE_NOT_POSTED\fR +.B E_NOT_POSTED The form has not been posted. .TP 5 -\fBE_UNKNOWN_COMMAND\fR -The form driver code saw an unknown request code. -.TP 5 -\fBE_INVALID_FIELD\fR +.B E_INVALID_FIELD Contents of field is invalid. .TP 5 -\fBE_REQUEST_DENIED\fR +.B E_REQUEST_DENIED The form driver could not process the request. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). +.TP 5 +.B E_UNKNOWN_COMMAND +The form driver code saw an unknown request code. +. .SH SEE ALSO -\fBcurses\fR(3X), \fBforms\fR(3x). +\fBcurses\fR(3X), +\fBform\fR(3X), +\fBwgetch\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header files \fB\fR.