X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_driver.3x.html;h=26fcc948bfbc7a9bec5596835e799595294d0ffe;hp=72b2d9428bacda983c477d14fc1e016675b19da3;hb=b11cef1e315b58820ea0cde239ebf2f741ef8948;hpb=cfd9c6f8e5af24820fefbb789b7345d93b8ed837 diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html index 72b2d942..26fcc948 100644 --- a/doc/html/man/form_driver.3x.html +++ b/doc/html/man/form_driver.3x.html @@ -26,7 +26,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: form_driver.3x,v 1.24 2015/08/02 18:21:11 tom Exp @ + * @Id: form_driver.3x,v 1.25 2015/12/05 21:06:26 tom Exp @ --> @@ -47,7 +47,8 @@
- form_driver - command-processing loop of the form system + form_driver, form_driver_w - command-processing loop of + the form system@@ -63,16 +64,16 @@
Once a form has been posted (displayed), you should funnel - input events to it through form_driver. This routine has + input events to it through form_driver. This routine has three major input cases: - o The input is a form navigation request. Navigation + o The input is a form navigation request. Navigation request codes are constants defined in <form.h>, which - are distinct from the key- and character codes + are distinct from the key- and character codes returned by wgetch(3x). o The input is a printable character. Printable charac- - ters (which must be positive, less than 256) are + ters (which must be positive, less than 256) are checked according to the program's locale settings. o The input is the KEY_MOUSE special key associated with @@ -81,11 +82,11 @@
- This extension simplifies the use of the forms library - using wide characters. The input is either a key code (a + This extension simplifies the use of the forms library + using wide characters. The input is either a key code (a request) or a wide character returned by get_wch(3x). The - type must be passed as well, to enable the library to - determine whether the parameter is a wide character or a + type must be passed as well, to enable the library to + determine whether the parameter is a wide character or a request. @@ -116,8 +117,8 @@ REQ_LAST_FIELD Move to the last field. REQ_LAST_PAGE Move to the last field. REQ_LEFT_CHAR Move left in the field. - REQ_LEFT_FIELD Move left to a field. + REQ_LEFT_FIELD Move left to a field. REQ_NEW_LINE Insert or overlay a new line. REQ_NEXT_CHAR Move to the next char. REQ_NEXT_CHOICE Display next field choice. @@ -155,18 +156,18 @@ REQ_UP_FIELD Move up to a field. REQ_VALIDATION Validate field. - 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, + 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.
- If the second argument is the KEY_MOUSE special key, the + 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 decora- + pre-defined requests. Currently only clicks in the user + window (e.g., inside the form display area or the decora- tion window) are handled. If you click above the display region of the form: @@ -185,34 +186,34 @@ a REQ_LAST_FIELD is generated for a triple-click. - If you click at an field inside the display area of the + If you click at an field inside the display area of the form: o the form cursor is positioned to that field. - o If you double-click a field, the form cursor is - positioned to that field and E_UNKNOWN_COMMAND is + o If you double-click a field, the form cursor is + positioned to that field and E_UNKNOWN_COMMAND 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 pur- - pose of this return value to signal that an appli- + double click usually means that an field-specific + action should be returned. It is exactly the pur- + pose of this return value to signal that an appli- cation specific command should be executed. - o If a translation into a request was done, + o If a translation into a request was done, form_driver returns the result of this request. - If you clicked outside the user window or the mouse event - could not be translated into a form request an + If you clicked outside the user window or the mouse event + could not be translated into a form request an E_REQUEST_DENIED is returned.
If the second argument is neither printable nor one of the - above pre-defined form requests, the driver assumes it is + above pre-defined form requests, the driver assumes it is an application-specific command and returns E_UNKNOWN_COM- MAND. Application-defined commands should be defined rel- - ative to MAX_COMMAND, the maximum value of these pre- + ative to MAX_COMMAND, the maximum value of these pre- defined requests. @@ -223,7 +224,7 @@ E_OK The routine succeeded. E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- + Routine detected an incorrect or out-of-range argu- ment. E_BAD_STATE @@ -259,13 +260,13 @@
- These routines emulate the System V forms library. They + These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.
- Juergen Pfeifer. Manual pages and adaptation for new + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.