ncurses 5.9 - patch 20150516
[ncurses.git] / doc / html / man / form_driver.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc.              *
4   *                                                                          *
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:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
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.                               *
23   *                                                                          *
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       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: form_driver.3x,v 1.22 2010/12/04 18:38:55 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
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">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">form_driver 3x</H1>
42 <PRE>
43 <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>                                         <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>form_driver</STRONG> - command-processing loop of the form system
51
52
53 </PRE>
54 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
56        int form_driver(FORM *form, int c);
57
58
59 </PRE>
60 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        Once a form has been posted (displayed), you should funnel
62        input events to it through <STRONG>form_driver</STRONG>.  This routine  has
63        three major input cases:
64
65        <STRONG>o</STRONG>   The  input  is  a form navigation request.  Navigation
66            request codes are constants defined in <STRONG>&lt;form.h&gt;</STRONG>, which
67            are   distinct  from  the  key-  and  character  codes
68            returned by <STRONG>wgetch</STRONG>.
69
70        <STRONG>o</STRONG>   The input is a printable character.  Printable charac-
71            ters  (which  must  be  positive,  less  than 256) are
72            checked according to the program's locale settings.
73
74        <STRONG>o</STRONG>   The input is the KEY_MOUSE special key associated with
75            an mouse event.
76
77        The form driver requests are as follows:
78
79        REQ_NEXT_PAGE
80             Move to the next page.
81
82        REQ_PREV_PAGE
83             Move to the previous page.
84
85        REQ_FIRST_PAGE
86             Move to the first page.
87
88        REQ_LAST_PAGE
89             Move to the last field.
90
91
92        REQ_NEXT_FIELD
93             Move to the next field.
94
95        REQ_PREV_FIELD
96             Move to the previous field.
97
98        REQ_FIRST_FIELD
99             Move to the first field.
100
101        REQ_LAST_FIELD
102             Move to the last field.
103
104        REQ_SNEXT_FIELD
105             Move to the sorted next field.
106
107        REQ_SPREV_FIELD
108             Move to the sorted previous field.
109
110        REQ_SFIRST_FIELD
111             Move to the sorted first field.
112
113        REQ_SLAST_FIELD
114             Move to the sorted last field.
115
116        REQ_LEFT_FIELD
117             Move left to a field.
118
119        REQ_RIGHT_FIELD
120             Move right to a field.
121
122        REQ_UP_FIELD
123             Move up to a field.
124
125        REQ_DOWN_FIELD
126             Move down to a field.
127
128
129        REQ_NEXT_CHAR
130             Move to the next char.
131
132        REQ_PREV_CHAR
133             Move to the previous char.
134
135        REQ_NEXT_LINE
136             Move to the next line.
137
138        REQ_PREV_LINE
139             Move to the previous line.
140
141        REQ_NEXT_WORD
142             Move to the next word.
143
144        REQ_PREV_WORD
145             Move to the previous word.
146
147        REQ_BEG_FIELD
148             Move to the beginning of the field.
149
150        REQ_END_FIELD
151             Move to the end of the field.
152
153        REQ_BEG_LINE
154             Move to the beginning of the line.
155
156        REQ_END_LINE
157             Move to the end of the line.
158
159        REQ_LEFT_CHAR
160             Move left in the field.
161
162        REQ_RIGHT_CHAR
163             Move right in the field.
164
165        REQ_UP_CHAR
166             Move up in the field.
167
168        REQ_DOWN_CHAR
169             Move down in the field.
170
171
172        REQ_NEW_LINE
173             Insert or overlay a new line.
174
175        REQ_INS_CHAR
176             Insert a blank at the cursor.
177
178        REQ_INS_LINE
179             Insert a blank line at the cursor.
180
181        REQ_DEL_CHAR
182             Delete character at the cursor.
183
184        REQ_DEL_PREV
185             Delete character before the cursor.
186
187        REQ_DEL_LINE
188             Delete line at the cursor.
189
190        REQ_DEL_WORD
191             Delete blank-delimited word at the cursor.
192
193        REQ_CLR_EOL
194             Clear to end of line from cursor.
195
196        REQ_CLR_EOF
197             Clear to end of field from cursor.
198
199        REQ_CLR_FIELD
200             Clear the entire field.
201
202        REQ_OVL_MODE
203             Enter overlay mode.
204
205        REQ_INS_MODE
206             Enter insert mode.
207
208
209        REQ_SCR_FLINE
210             Scroll the field forward a line.
211
212        REQ_SCR_BLINE
213             Scroll the field backward a line.
214
215        REQ_SCR_FPAGE
216             Scroll the field forward a page.
217
218        REQ_SCR_BPAGE
219             Scroll the field backward a page.
220
221        REQ_SCR_FHPAGE
222             Scroll the field forward half a page.
223
224        REQ_SCR_BHPAGE
225             Scroll the field backward half a page.
226
227
228        REQ_SCR_FCHAR
229             Scroll the field forward a character.
230
231        REQ_SCR_BCHAR
232             Scroll the field backward a character.
233
234        REQ_SCR_HFLINE
235             Horizontal scroll the field forward a line.
236
237        REQ_SCR_HBLINE
238             Horizontal scroll the field backward a line.
239
240        REQ_SCR_HFHALF
241             Horizontal scroll the field forward half a line.
242
243        REQ_SCR_HBHALF
244             Horizontal scroll the field backward half a line.
245
246
247        REQ_VALIDATION
248             Validate field.
249
250        REQ_NEXT_CHOICE
251             Display next field choice.
252
253        REQ_PREV_CHOICE
254             Display previous field choice.
255
256        If  the  second  argument  is  a  printable character, the
257        driver places it in the current position  in  the  current
258        field.   If  it is one of the forms requests listed above,
259        that request is executed.
260
261
262 </PRE>
263 <H3><a name="h3-MOUSE-HANDLING">MOUSE HANDLING</a></H3><PRE>
264        If the second argument is the KEY_MOUSE special  key,  the
265        associated mouse event is translated into one of the above
266        pre-defined requests.  Currently only clicks in  the  user
267        window  (e.g., inside the form display area or the decora-
268        tion window) are handled.
269
270        If you click above the display region of the form:
271
272           a REQ_PREV_FIELD is generated for a single click,
273
274           a REQ_PREV_PAGE is generated for a double-click and
275
276           a REQ_FIRST_FIELD is generated for a triple-click.
277
278        If you click below the display region of the form:
279
280           a REQ_NEXT_FIELD is generated for a single click,
281
282           a REQ_NEXT_PAGE is generated for a double-click and
283
284           a REQ_LAST_FIELD is generated for a triple-click.
285
286        If you click at an field inside the display  area  of  the
287        form:
288
289           <STRONG>o</STRONG>   the form cursor is positioned to that field.
290
291           <STRONG>o</STRONG>   If  you  double-click  a  field, the form cursor is
292               positioned to that field and  <STRONG>E_UNKNOWN_COMMAND</STRONG>  is
293               returned.  This return value makes sense, because a
294               double click usually means that  an  field-specific
295               action  should be returned.  It is exactly the pur-
296               pose of this return value to signal that an  appli-
297               cation specific command should be executed.
298
299           <STRONG>o</STRONG>   If   a   translation   into  a  request  was  done,
300               <STRONG>form_driver</STRONG> returns the result of this request.
301
302        If you clicked outside the user window or the mouse  event
303        could   not   be   translated   into  a  form  request  an
304        <STRONG>E_REQUEST_DENIED</STRONG> is returned.
305
306
307 </PRE>
308 <H3><a name="h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></H3><PRE>
309        If the second argument is neither printable nor one of the
310        above  pre-defined form requests, the driver assumes it is
311        an application-specific command and returns <STRONG>E_UNKNOWN_COM-</STRONG>
312        <STRONG>MAND</STRONG>.  Application-defined commands should be defined rel-
313        ative to <STRONG>MAX_COMMAND</STRONG>, the  maximum  value  of  these  pre-
314        defined requests.
315
316
317 </PRE>
318 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
319        <STRONG>form_driver</STRONG> returns one of the following error codes:
320
321        <STRONG>E_OK</STRONG> The routine succeeded.
322
323        <STRONG>E_BAD_ARGUMENT</STRONG>
324             Routine  detected  an incorrect or out-of-range argu-
325             ment.
326
327        <STRONG>E_BAD_STATE</STRONG>
328             Routine was called from an initialization or termina-
329             tion function.
330
331        <STRONG>E_NOT_POSTED</STRONG>
332             The form has not been posted.
333
334        <STRONG>E_INVALID_FIELD</STRONG>
335             Contents of field is invalid.
336
337        <STRONG>E_REQUEST_DENIED</STRONG>
338             The form driver could not process the request.
339
340        <STRONG>E_SYSTEM_ERROR</STRONG>
341             System error occurred (see <STRONG>errno</STRONG>).
342
343        <STRONG>E_UNKNOWN_COMMAND</STRONG>
344             The form driver code saw an unknown request code.
345
346
347 </PRE>
348 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
349        <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>.
350
351
352 </PRE>
353 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
354        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
355        files <STRONG>&lt;curses.h&gt;</STRONG>.
356
357
358 </PRE>
359 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
360        These routines emulate the System V forms  library.   They
361        were not supported on Version 7 or BSD versions.
362
363
364 </PRE>
365 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
366        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
367        curses by Eric S. Raymond.
368
369
370
371                                                         <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
372 </PRE>
373 <div class="nav">
374 <ul>
375 <li><a href="#h2-NAME">NAME</a></li>
376 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
377 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
378 <ul>
379 <li><a href="#h3-MOUSE-HANDLING">MOUSE HANDLING</a></li>
380 <li><a href="#h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></li>
381 </ul>
382 </li>
383 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
384 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
385 <li><a href="#h2-NOTES">NOTES</a></li>
386 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
387 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
388 </ul>
389 </div>
390 </BODY>
391 </HTML>