2 ****************************************************************************
3 * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************
29 * @Id: form_driver.3x,v 1.22 2010/12/04 18:38:55 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>form_driver 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1>form_driver 3x</H1>
44 <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG> <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>form_driver</STRONG> - command-processing loop of the form system
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
57 int form_driver(FORM *form, int c);
61 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62 Once a form has been posted (displayed), you should funnel
63 input events to it through <STRONG>form_driver</STRONG>. This routine has
64 three major input cases:
66 <STRONG>o</STRONG> The input is a form navigation request. Navigation
67 request codes are constants defined in <STRONG><form.h></STRONG>, which
68 are distinct from the key- and character codes
69 returned by <STRONG>wgetch</STRONG>.
71 <STRONG>o</STRONG> The input is a printable character. Printable charac-
72 ters (which must be positive, less than 256) are
73 checked according to the program's locale settings.
75 <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with
78 The form driver requests are as follows:
81 Move to the next page.
84 Move to the previous page.
87 Move to the first page.
90 Move to the last field.
94 Move to the next field.
97 Move to the previous field.
100 Move to the first field.
103 Move to the last field.
106 Move to the sorted next field.
109 Move to the sorted previous field.
112 Move to the sorted first field.
115 Move to the sorted last field.
118 Move left to a field.
121 Move right to a field.
127 Move down to a field.
131 Move to the next char.
134 Move to the previous char.
137 Move to the next line.
140 Move to the previous line.
143 Move to the next word.
146 Move to the previous word.
149 Move to the beginning of the field.
152 Move to the end of the field.
155 Move to the beginning of the line.
158 Move to the end of the line.
161 Move left in the field.
164 Move right in the field.
167 Move up in the field.
170 Move down in the field.
174 Insert or overlay a new line.
177 Insert a blank at the cursor.
180 Insert a blank line at the cursor.
183 Delete character at the cursor.
186 Delete character before the cursor.
189 Delete line at the cursor.
192 Delete blank-delimited word at the cursor.
195 Clear to end of line from cursor.
198 Clear to end of field from cursor.
201 Clear the entire field.
211 Scroll the field forward a line.
214 Scroll the field backward a line.
217 Scroll the field forward a page.
220 Scroll the field backward a page.
223 Scroll the field forward half a page.
226 Scroll the field backward half a page.
230 Scroll the field forward a character.
233 Scroll the field backward a character.
236 Horizontal scroll the field forward a line.
239 Horizontal scroll the field backward a line.
242 Horizontal scroll the field forward half a line.
245 Horizontal scroll the field backward half a line.
252 Display next field choice.
255 Display previous field choice.
257 If the second argument is a printable character, the
258 driver places it in the current position in the current
259 field. If it is one of the forms requests listed above,
260 that request is executed.
264 <H3><a name="h3-MOUSE-HANDLING">MOUSE HANDLING</a></H3><PRE>
265 If the second argument is the KEY_MOUSE special key, the
266 associated mouse event is translated into one of the above
267 pre-defined requests. Currently only clicks in the user
268 window (e.g., inside the form display area or the decora-
269 tion window) are handled.
271 If you click above the display region of the form:
273 a REQ_PREV_FIELD is generated for a single click,
275 a REQ_PREV_PAGE is generated for a double-click and
277 a REQ_FIRST_FIELD is generated for a triple-click.
279 If you click below the display region of the form:
281 a REQ_NEXT_FIELD is generated for a single click,
283 a REQ_NEXT_PAGE is generated for a double-click and
285 a REQ_LAST_FIELD is generated for a triple-click.
287 If you click at an field inside the display area of the
290 <STRONG>o</STRONG> the form cursor is positioned to that field.
292 <STRONG>o</STRONG> If you double-click a field, the form cursor is
293 positioned to that field and <STRONG>E_UNKNOWN_COMMAND</STRONG> is
294 returned. This return value makes sense, because a
295 double click usually means that an field-specific
296 action should be returned. It is exactly the pur-
297 pose of this return value to signal that an appli-
298 cation specific command should be executed.
300 <STRONG>o</STRONG> If a translation into a request was done,
301 <STRONG>form_driver</STRONG> returns the result of this request.
303 If you clicked outside the user window or the mouse event
304 could not be translated into a form request an
305 <STRONG>E_REQUEST_DENIED</STRONG> is returned.
309 <H3><a name="h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></H3><PRE>
310 If the second argument is neither printable nor one of the
311 above pre-defined form requests, the driver assumes it is
312 an application-specific command and returns <STRONG>E_UNKNOWN_COM-</STRONG>
313 <STRONG>MAND</STRONG>. Application-defined commands should be defined rel-
314 ative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre-
319 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
320 <STRONG>form_driver</STRONG> returns one of the following error codes:
322 <STRONG>E_OK</STRONG> The routine succeeded.
324 <STRONG>E_BAD_ARGUMENT</STRONG>
325 Routine detected an incorrect or out-of-range argu-
328 <STRONG>E_BAD_STATE</STRONG>
329 Routine was called from an initialization or termina-
332 <STRONG>E_NOT_POSTED</STRONG>
333 The form has not been posted.
335 <STRONG>E_INVALID_FIELD</STRONG>
336 Contents of field is invalid.
338 <STRONG>E_REQUEST_DENIED</STRONG>
339 The form driver could not process the request.
341 <STRONG>E_SYSTEM_ERROR</STRONG>
342 System error occurred (see <STRONG>errno</STRONG>).
344 <STRONG>E_UNKNOWN_COMMAND</STRONG>
345 The form driver code saw an unknown request code.
349 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
350 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>.
354 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
355 The header file <STRONG><form.h></STRONG> automatically includes the header
356 files <STRONG><curses.h></STRONG>.
360 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
361 These routines emulate the System V forms library. They
362 were not supported on Version 7 or BSD versions.
366 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
367 Juergen Pfeifer. Manual pages and adaptation for new
368 curses by Eric S. Raymond.
372 <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
376 <li><a href="#h2-NAME">NAME</a></li>
377 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
378 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
380 <li><a href="#h3-MOUSE-HANDLING">MOUSE HANDLING</a></li>
381 <li><a href="#h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></li>
384 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
385 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
386 <li><a href="#h2-NOTES">NOTES</a></li>
387 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
388 <li><a href="#h2-AUTHORS">AUTHORS</a></li>