ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / form_driver.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,2015 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.25 2015/12/05 21:06:26 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>,  <STRONG>form_driver_w</STRONG>  -  command-processing loop of
51        the form system
52
53
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57        <STRONG>int</STRONG> <STRONG>form_driver(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>c</EM><STRONG>);</STRONG>
58        <STRONG>int</STRONG> <STRONG>form_driver_w(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>c</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG>
59
60
61 </PRE>
62 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63
64 </PRE>
65 <H3><a name="h3-form_driver">form_driver</a></H3><PRE>
66        Once a form has been posted (displayed), you should funnel
67        input  events to it through <STRONG>form_driver</STRONG>.  This routine has
68        three major input cases:
69
70        <STRONG>o</STRONG>   The input is a form  navigation  request.   Navigation
71            request codes are constants defined in <STRONG>&lt;form.h&gt;</STRONG>, which
72            are  distinct  from  the  key-  and  character   codes
73            returned by <STRONG><A HREF="wgetch.3x.html">wgetch(3x)</A></STRONG>.
74
75        <STRONG>o</STRONG>   The input is a printable character.  Printable charac-
76            ters (which must  be  positive,  less  than  256)  are
77            checked according to the program's locale settings.
78
79        <STRONG>o</STRONG>   The input is the KEY_MOUSE special key associated with
80            an mouse event.
81
82
83 </PRE>
84 <H3><a name="h3-form_driver_w">form_driver_w</a></H3><PRE>
85        This extension simplifies the use  of  the  forms  library
86        using  wide characters.  The input is either a key code (a
87        request) or a wide character returned by <STRONG><A HREF="get_wch.3x.html">get_wch(3x)</A></STRONG>.  The
88        type  must  be  passed  as  well, to enable the library to
89        determine whether the parameter is a wide character  or  a
90        request.
91
92
93 </PRE>
94 <H3><a name="h3-Form-driver-requests">Form-driver requests</a></H3><PRE>
95        The form driver requests are as follows:
96
97        <EM>Name</EM>               <EM>Description</EM>
98        -------------------------------------------------------------------------
99        REQ_BEG_FIELD      Move to the beginning of the field.
100        REQ_BEG_LINE       Move to the beginning of the line.
101        REQ_CLR_EOF        Clear to end of field from cursor.
102        REQ_CLR_EOL        Clear to end of line from cursor.
103        REQ_CLR_FIELD      Clear the entire field.
104        REQ_DEL_CHAR       Delete character at the cursor.
105        REQ_DEL_LINE       Delete line at the cursor.
106        REQ_DEL_PREV       Delete character before the cursor.
107        REQ_DEL_WORD       Delete blank-delimited word at the cursor.
108        REQ_DOWN_CHAR      Move down in the field.
109        REQ_DOWN_FIELD     Move down to a field.
110        REQ_END_FIELD      Move to the end of the field.
111        REQ_END_LINE       Move to the end of the line.
112        REQ_FIRST_FIELD    Move to the first field.
113        REQ_FIRST_PAGE     Move to the first page.
114        REQ_INS_CHAR       Insert a blank at the cursor.
115        REQ_INS_LINE       Insert a blank line at the cursor.
116        REQ_INS_MODE       Enter insert mode.
117        REQ_LAST_FIELD     Move to the last field.
118        REQ_LAST_PAGE      Move to the last field.
119        REQ_LEFT_CHAR      Move left in the field.
120
121        REQ_LEFT_FIELD     Move left to a field.
122        REQ_NEW_LINE       Insert or overlay a new line.
123        REQ_NEXT_CHAR      Move to the next char.
124        REQ_NEXT_CHOICE    Display next field choice.
125        REQ_NEXT_FIELD     Move to the next field.
126        REQ_NEXT_LINE      Move to the next line.
127        REQ_NEXT_PAGE      Move to the next page.
128        REQ_NEXT_PAGE      Move to the next page.
129        REQ_NEXT_WORD      Move to the next word.
130        REQ_OVL_MODE       Enter overlay mode.
131        REQ_PREV_CHAR      Move to the previous char.
132        REQ_PREV_CHOICE    Display previous field choice.
133        REQ_PREV_FIELD     Move to the previous field.
134        REQ_PREV_LINE      Move to the previous line.
135        REQ_PREV_PAGE      Move to the previous page.
136        REQ_PREV_WORD      Move to the previous word.
137        REQ_RIGHT_CHAR     Move right in the field.
138        REQ_RIGHT_FIELD    Move right to a field.
139        REQ_SCR_BCHAR      Scroll the field backward a character.
140        REQ_SCR_BHPAGE     Scroll the field backward half a page.
141        REQ_SCR_BLINE      Scroll the field backward a line.
142        REQ_SCR_BPAGE      Scroll the field backward a page.
143        REQ_SCR_FCHAR      Scroll the field forward a character.
144        REQ_SCR_FHPAGE     Scroll the field forward half a page.
145        REQ_SCR_FLINE      Scroll the field forward a line.
146        REQ_SCR_FPAGE      Scroll the field forward a page.
147        REQ_SCR_HBHALF     Horizontal scroll the field backward half a line.
148        REQ_SCR_HBLINE     Horizontal scroll the field backward a line.
149        REQ_SCR_HFHALF     Horizontal scroll the field forward half a line.
150        REQ_SCR_HFLINE     Horizontal scroll the field forward a line.
151        REQ_SFIRST_FIELD   Move to the sorted first field.
152        REQ_SLAST_FIELD    Move to the sorted last field.
153        REQ_SNEXT_FIELD    Move to the sorted next field.
154        REQ_SPREV_FIELD    Move to the sorted previous field.
155        REQ_UP_CHAR        Move up in the field.
156        REQ_UP_FIELD       Move up to a field.
157        REQ_VALIDATION     Validate field.
158
159        If  the  second  argument  is  a  printable character, the
160        driver places it in the current position  in  the  current
161        field.   If  it is one of the forms requests listed above,
162        that request is executed.
163
164
165 </PRE>
166 <H3><a name="h3-Mouse-handling">Mouse handling</a></H3><PRE>
167        If the second argument is the KEY_MOUSE special  key,  the
168        associated mouse event is translated into one of the above
169        pre-defined requests.  Currently only clicks in  the  user
170        window  (e.g., inside the form display area or the decora-
171        tion window) are handled.
172
173        If you click above the display region of the form:
174
175           a REQ_PREV_FIELD is generated for a single click,
176
177           a REQ_PREV_PAGE is generated for a double-click and
178
179           a REQ_FIRST_FIELD is generated for a triple-click.
180
181        If you click below the display region of the form:
182
183           a REQ_NEXT_FIELD is generated for a single click,
184
185           a REQ_NEXT_PAGE is generated for a double-click and
186
187           a REQ_LAST_FIELD is generated for a triple-click.
188
189        If you click at an field inside the display  area  of  the
190        form:
191
192           <STRONG>o</STRONG>   the form cursor is positioned to that field.
193
194           <STRONG>o</STRONG>   If  you  double-click  a  field, the form cursor is
195               positioned to that field and  <STRONG>E_UNKNOWN_COMMAND</STRONG>  is
196               returned.  This return value makes sense, because a
197               double click usually means that  an  field-specific
198               action  should be returned.  It is exactly the pur-
199               pose of this return value to signal that an  appli-
200               cation specific command should be executed.
201
202           <STRONG>o</STRONG>   If   a   translation   into  a  request  was  done,
203               <STRONG>form_driver</STRONG> returns the result of this request.
204
205        If you clicked outside the user window or the mouse  event
206        could   not   be   translated   into  a  form  request  an
207        <STRONG>E_REQUEST_DENIED</STRONG> is returned.
208
209
210 </PRE>
211 <H3><a name="h3-Application-defined-commands">Application-defined commands</a></H3><PRE>
212        If the second argument is neither printable nor one of the
213        above  pre-defined form requests, the driver assumes it is
214        an application-specific command and returns <STRONG>E_UNKNOWN_COM-</STRONG>
215        <STRONG>MAND</STRONG>.  Application-defined commands should be defined rel-
216        ative to <STRONG>MAX_COMMAND</STRONG>, the  maximum  value  of  these  pre-
217        defined requests.
218
219
220 </PRE>
221 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
222        <STRONG>form_driver</STRONG> returns one of the following error codes:
223
224        <STRONG>E_OK</STRONG> The routine succeeded.
225
226        <STRONG>E_BAD_ARGUMENT</STRONG>
227             Routine  detected  an incorrect or out-of-range argu-
228             ment.
229
230        <STRONG>E_BAD_STATE</STRONG>
231             Routine was called from an initialization or termina-
232             tion function.
233
234        <STRONG>E_NOT_POSTED</STRONG>
235             The form has not been posted.
236
237        <STRONG>E_INVALID_FIELD</STRONG>
238             Contents of field is invalid.
239
240        <STRONG>E_REQUEST_DENIED</STRONG>
241             The form driver could not process the request.
242
243        <STRONG>E_SYSTEM_ERROR</STRONG>
244             System error occurred (see <STRONG>errno</STRONG>).
245
246        <STRONG>E_UNKNOWN_COMMAND</STRONG>
247             The form driver code saw an unknown request code.
248
249
250 </PRE>
251 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
252        <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>.
253
254
255 </PRE>
256 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
257        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
258        files <STRONG>&lt;curses.h&gt;</STRONG>.
259
260
261 </PRE>
262 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
263        These routines emulate the System V forms  library.   They
264        were not supported on Version 7 or BSD versions.
265
266
267 </PRE>
268 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
269        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
270        curses by Eric S. Raymond.
271
272
273
274                                                         <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
275 </PRE>
276 <div class="nav">
277 <ul>
278 <li><a href="#h2-NAME">NAME</a></li>
279 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
280 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
281 <ul>
282 <li><a href="#h3-form_driver">form_driver</a></li>
283 <li><a href="#h3-form_driver_w">form_driver_w</a></li>
284 <li><a href="#h3-Form-driver-requests">Form-driver requests</a></li>
285 <li><a href="#h3-Mouse-handling">Mouse handling</a></li>
286 <li><a href="#h3-Application-defined-commands">Application-defined commands</a></li>
287 </ul>
288 </li>
289 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
290 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
291 <li><a href="#h2-NOTES">NOTES</a></li>
292 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
293 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
294 </ul>
295 </div>
296 </BODY>
297 </HTML>