1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc. *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a *
5 .\" copy of this software and associated documentation files (the *
6 .\" "Software"), to deal in the Software without restriction, including *
7 .\" without limitation the rights to use, copy, modify, merge, publish, *
8 .\" distribute, distribute with modifications, sublicense, and/or sell *
9 .\" copies of the Software, and to permit persons to whom the Software is *
10 .\" furnished to do so, subject to the following conditions: *
12 .\" The above copyright notice and this permission notice shall be included *
13 .\" in all copies or substantial portions of the Software. *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 .\" Except as contained in this notice, the name(s) of the above copyright *
24 .\" holders shall not be used in advertising or otherwise to promote the *
25 .\" sale, use or other dealings in this Software without prior written *
27 .\"***************************************************************************
29 .\" $Id: form_driver.3x,v 1.24 2015/08/02 18:21:11 tom Exp $
35 \fBform_driver\fR \- command-processing loop of the form system
37 \fB#include <form.h>\fR
39 \fBint form_driver(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB);\fP
41 \fBint form_driver_w(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB, wchar_t \fP\fIwch\fP\fB);\fP
45 Once a form has been posted (displayed), you should funnel input events to it
46 through \fBform_driver\fR. This routine has three major input cases:
48 The input is a form navigation request.
49 Navigation request codes are constants defined in \fB<form.h>\fP,
50 which are distinct from the key- and character codes returned by \fBwgetch\fP(3X).
52 The input is a printable character.
53 Printable characters (which must be positive, less than 256) are
54 checked according to the program's locale settings.
56 The input is the KEY_MOUSE special key associated with an mouse event.
59 This extension simplifies the use of the forms library using wide characters.
60 The input is either a key code (a request) or a wide character
61 returned by \fBget_wch\fP(3X).
62 The type must be passed as well,
63 to enable the library to determine whether the parameter
64 is a wide character or a request.
65 .SS Form-driver requests
67 The form driver requests are as follows:
72 \fIName\fR \fIDescription\fR
73 REQ_BEG_FIELD Move to the beginning of the field.
74 REQ_BEG_LINE Move to the beginning of the line.
75 REQ_CLR_EOF Clear to end of field from cursor.
76 REQ_CLR_EOL Clear to end of line from cursor.
77 REQ_CLR_FIELD Clear the entire field.
78 REQ_DEL_CHAR Delete character at the cursor.
79 REQ_DEL_LINE Delete line at the cursor.
80 REQ_DEL_PREV Delete character before the cursor.
81 REQ_DEL_WORD Delete blank-delimited word at the cursor.
82 REQ_DOWN_CHAR Move down in the field.
83 REQ_DOWN_FIELD Move down to a field.
84 REQ_END_FIELD Move to the end of the field.
85 REQ_END_LINE Move to the end of the line.
86 REQ_FIRST_FIELD Move to the first field.
87 REQ_FIRST_PAGE Move to the first page.
88 REQ_INS_CHAR Insert a blank at the cursor.
89 REQ_INS_LINE Insert a blank line at the cursor.
90 REQ_INS_MODE Enter insert mode.
91 REQ_LAST_FIELD Move to the last field.
92 REQ_LAST_PAGE Move to the last field.
93 REQ_LEFT_CHAR Move left in the field.
94 REQ_LEFT_FIELD Move left to a field.
95 REQ_NEW_LINE Insert or overlay a new line.
96 REQ_NEXT_CHAR Move to the next char.
97 REQ_NEXT_CHOICE Display next field choice.
98 REQ_NEXT_FIELD Move to the next field.
99 REQ_NEXT_LINE Move to the next line.
100 REQ_NEXT_PAGE Move to the next page.
101 REQ_NEXT_PAGE Move to the next page.
102 REQ_NEXT_WORD Move to the next word.
103 REQ_OVL_MODE Enter overlay mode.
104 REQ_PREV_CHAR Move to the previous char.
105 REQ_PREV_CHOICE Display previous field choice.
106 REQ_PREV_FIELD Move to the previous field.
107 REQ_PREV_LINE Move to the previous line.
108 REQ_PREV_PAGE Move to the previous page.
109 REQ_PREV_WORD Move to the previous word.
110 REQ_RIGHT_CHAR Move right in the field.
111 REQ_RIGHT_FIELD Move right to a field.
112 REQ_SCR_BCHAR Scroll the field backward a character.
113 REQ_SCR_BHPAGE Scroll the field backward half a page.
114 REQ_SCR_BLINE Scroll the field backward a line.
115 REQ_SCR_BPAGE Scroll the field backward a page.
116 REQ_SCR_FCHAR Scroll the field forward a character.
117 REQ_SCR_FHPAGE Scroll the field forward half a page.
118 REQ_SCR_FLINE Scroll the field forward a line.
119 REQ_SCR_FPAGE Scroll the field forward a page.
120 REQ_SCR_HBHALF Horizontal scroll the field backward half a line.
121 REQ_SCR_HBLINE Horizontal scroll the field backward a line.
122 REQ_SCR_HFHALF Horizontal scroll the field forward half a line.
123 REQ_SCR_HFLINE Horizontal scroll the field forward a line.
124 REQ_SFIRST_FIELD Move to the sorted first field.
125 REQ_SLAST_FIELD Move to the sorted last field.
126 REQ_SNEXT_FIELD Move to the sorted next field.
127 REQ_SPREV_FIELD Move to the sorted previous field.
128 REQ_UP_CHAR Move up in the field.
129 REQ_UP_FIELD Move up to a field.
130 REQ_VALIDATION Validate field.
133 If the second argument is a printable character, the driver places it
134 in the current position in the current field. If it is one of the forms
135 requests listed above, that request is executed.
138 If the second argument is the KEY_MOUSE special key, the associated
139 mouse event is translated into one of the above pre-defined requests.
140 Currently only clicks in the user window (e.g., inside the form display
141 area or the decoration window) are handled.
143 If you click above the display region of the form:
146 a REQ_PREV_FIELD is generated for a single click,
148 a REQ_PREV_PAGE is generated for a double-click and
150 a REQ_FIRST_FIELD is generated for a triple-click.
153 If you click below the display region of the form:
156 a REQ_NEXT_FIELD is generated for a single click,
158 a REQ_NEXT_PAGE is generated for a double-click and
160 a REQ_LAST_FIELD is generated for a triple-click.
163 If you click at an field inside the display area of the form:
166 the form cursor is positioned to that field.
168 If you double-click a field,
169 the form cursor is positioned to that field
170 and \fBE_UNKNOWN_COMMAND\fR is returned.
171 This return value makes sense,
172 because a double click usually means that an field-specific action should
174 It is exactly the purpose of this return value to signal that an
175 application specific command should be executed.
178 into a request was done, \fBform_driver\fR returns the result of this request.
181 If you clicked outside the user window or the mouse event could not be translated
182 into a form request an \fBE_REQUEST_DENIED\fR is returned.
183 .SS Application-defined commands
185 If the second argument is neither printable nor one of the above
186 pre-defined form requests, the driver assumes it is an application-specific
187 command and returns \fBE_UNKNOWN_COMMAND\fR. Application-defined commands
188 should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
189 pre-defined requests.
191 \fBform_driver\fR returns one of the following error codes:
194 The routine succeeded.
197 Routine detected an incorrect or out-of-range argument.
200 Routine was called from an initialization or termination function.
203 The form has not been posted.
206 Contents of field is invalid.
209 The form driver could not process the request.
212 System error occurred (see \fBerrno\fR).
215 The form driver code saw an unknown request code.
220 \fBform_variables\fR(3X),
223 The header file \fB<form.h>\fR automatically includes the header files
226 These routines emulate the System V forms library. They were not supported on
227 Version 7 or BSD versions.
229 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric