X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_driver.3x.html;h=08159b160fc391080b0715374b53e8274e606bbc;hp=74c3c0b7d11b30920ef096ad3d3e3959743c38e2;hb=30393be892025f03322b7907a04cc05cc08e8760;hpb=1dd25cc0259e0683290fe889707b04979b5fda0a diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html index 74c3c0b7..08159b16 100644 --- a/doc/html/man/form_driver.3x.html +++ b/doc/html/man/form_driver.3x.html @@ -1,6 +1,6 @@
- +-form_driver(3x) form_driver(3x) +form_driver(3x) form_driver(3x)
- form_driver, form_driver_w - command-processing loop of - the form system + form_driver, form_driver_w - command-processing loop of the form system
@@ -59,29 +58,26 @@
- Once a form has been posted (displayed), you should funnel - input events to it through form_driver. This routine has - three major input cases: + Once a form has been posted (displayed), you should funnel input events + to it through form_driver. This routine has three major input cases: - 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 - returned by wgetch(3x). + 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 returned by wgetch(3x). - o The input is a printable character. Printable charac- - ters (which must be positive, less than 256) are - checked according to the program's locale settings. + o The input is a printable character. Printable characters (which + must be positive, less than 256) are checked according to the pro- + gram's locale settings. - o The input is the KEY_MOUSE special key associated with - an mouse event. + o The input is the KEY_MOUSE special key associated with an mouse + event.
- 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 + This extension simplifies the use of the forms library using wide char- + acters. 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 request. @@ -89,7 +85,7 @@ The form driver requests are as follows: Name Description - ------------------------------------------------------------------------- + --------------------------------------------------------------------- REQ_BEG_FIELD Move to the beginning of the field. REQ_BEG_LINE Move to the beginning of the line. REQ_CLR_EOF Clear to end of field from cursor. @@ -111,11 +107,11 @@ 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_NEW_LINE Insert or overlay a new line. REQ_NEXT_CHAR Move to the next char. REQ_NEXT_CHOICE Display next field choice. + REQ_NEXT_FIELD Move to the next field. REQ_NEXT_LINE Move to the next line. REQ_NEXT_PAGE Move to the next page. @@ -150,51 +146,43 @@ 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, - that request is executed. + 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.
- The form library makes updates to the window associated - with form fields rather than directly to the field buf- - fers. + The form library makes updates to the window associated with form + fields rather than directly to the field buffers. - The form driver provides low-level control over updates to - the form fields. The form driver also provides for vali- - dating modified fields to ensure that the contents meet - whatever constraints an application may attach using - set_field_type. + 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 meet whatever constraints an application + may attach using set_field_type. - You can validate a field without making any changes to it - using REQ_VALIDATION. The form driver also validates a - field in these cases: + You can validate a field without making any changes to it using + REQ_VALIDATION. The form driver also validates a field in these cases: - o a call to set_current_field attempts to move to a dif- - ferent field. + o a call to set_current_field attempts to move to a different field. - o a call to set_current_page attempts to move to a dif- - ferent page of the form. + o a call to set_current_page attempts to move to a different page of + the form. o a request attempts to move to a different field. - o a request attempts to move to a different page of the - form. + o a request attempts to move to a different page of the form. In each case, the move fails if the field is invalid. - If the modified field is valid, the form driver copies the - modified data from the window associated with the field to - the field buffer. + If the modified field is valid, the form driver copies the modified + data from the window associated with the field to the field buffer.
- 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- - tion window) are handled. + 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. If you click above the display region of the form: @@ -212,34 +200,30 @@ a REQ_LAST_FIELD is generated for a triple-click. - If you click at an field inside the display area of the - form: + 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 - 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- - cation specific command should be executed. + 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 purpose + of this return value to signal that an application specific com- + mand should be executed. - o If a translation into a request was done, - form_driver returns the result of this request. + 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 - E_REQUEST_DENIED is returned. + 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 - 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- - defined requests. + 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 E_UNKNOWN_COMMAND. Application-defined commands + should be defined relative to MAX_COMMAND, the maximum value of these + pre-defined requests.
@@ -248,12 +232,10 @@ E_OK The routine succeeded. E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. + Routine detected an incorrect or out-of-range argument. E_BAD_STATE - Routine was called from an initialization or termina- - tion function. + Routine was called from an initialization or termination function. E_NOT_POSTED The form has not been posted. @@ -261,6 +243,9 @@ E_INVALID_FIELD Contents of field is invalid. + E_NOT_CONNECTED + No fields are connected to the form. + E_REQUEST_DENIED The form driver could not process the request. @@ -272,28 +257,27 @@
- curses(3x), form(3x), form_field_buffer(3x), - form_field_validation(3x), form_fieldtype(3x), form_vari- - ables(3x), curs_getch(3x). + curses(3x), form(3x), form_field_buffer(3x), form_field_validation(3x), + form_fieldtype(3x), form_variables(3x), getch(3x).
- The header file <form.h> automatically includes the header - files <curses.h>. + The header file <form.h> automatically includes the header files + <curses.h>.
- These routines emulate the System V forms library. They - were not supported on Version 7 or BSD versions. + These routines emulate the System V forms library. They were not sup- + ported on Version 7 or BSD versions.
- 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. - form_driver(3x) + form_driver(3x)