ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / form_driver.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: form_driver.3x,v 1.33 2020/02/02 23:34:34 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_driver 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_driver 3x</H1>
43 <PRE>
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>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>form_driver</STRONG>, <STRONG>form_driver_w</STRONG> - command-processing loop of the form system
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
55        <STRONG>int</STRONG> <STRONG>form_driver(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>c</EM><STRONG>);</STRONG>
56        <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>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60
61 </PRE><H3><a name="h3-form_driver">form_driver</a></H3><PRE>
62        Once a form has been posted (displayed), you should funnel input events
63        to it through <STRONG>form_driver</STRONG>.  This routine has three major input cases:
64
65        <STRONG>o</STRONG>   The input is a form navigation request.  Navigation  request  codes
66            are constants defined in <STRONG>&lt;form.h&gt;</STRONG>, which are distinct from the key-
67            and character codes returned by <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>.
68
69        <STRONG>o</STRONG>   The input is a printable character.   Printable  characters  (which
70            must  be positive, less than 256) are checked according to the pro-
71            gram's locale settings.
72
73        <STRONG>o</STRONG>   The input is the KEY_MOUSE special key  associated  with  an  mouse
74            event.
75
76
77 </PRE><H3><a name="h3-form_driver_w">form_driver_w</a></H3><PRE>
78        This extension simplifies the use of the forms library using wide char-
79        acters.  The input is either a key code (a request) or a wide character
80        returned  by  <STRONG><A HREF="curs_get_wch.3x.html">get_wch(3x)</A></STRONG>.   The type must be passed as well, to enable
81        the library to determine whether the parameter is a wide character or a
82        request.
83
84
85 </PRE><H3><a name="h3-Form-driver-requests">Form-driver requests</a></H3><PRE>
86        The form driver requests are as follows:
87
88        <EM>Name</EM>               <EM>Description</EM>
89        ---------------------------------------------------------------------
90        REQ_BEG_FIELD      Move to the beginning of the field.
91        REQ_BEG_LINE       Move to the beginning of the line.
92        REQ_CLR_EOF        Clear to end of field from cursor.
93        REQ_CLR_EOL        Clear to end of line from cursor.
94        REQ_CLR_FIELD      Clear the entire field.
95        REQ_DEL_CHAR       Delete character at the cursor.
96        REQ_DEL_LINE       Delete line at the cursor.
97        REQ_DEL_PREV       Delete character before the cursor.
98        REQ_DEL_WORD       Delete blank-delimited word at the cursor.
99        REQ_DOWN_CHAR      Move down in the field.
100        REQ_DOWN_FIELD     Move down to a field.
101        REQ_END_FIELD      Move to the end of the field.
102        REQ_END_LINE       Move to the end of the line.
103        REQ_FIRST_FIELD    Move to the first field.
104        REQ_FIRST_PAGE     Move to the first page.
105        REQ_INS_CHAR       Insert a blank at the cursor.
106        REQ_INS_LINE       Insert a blank line at the cursor.
107        REQ_INS_MODE       Enter insert mode.
108        REQ_LAST_FIELD     Move to the last field.
109        REQ_LAST_PAGE      Move to the last field.
110        REQ_LEFT_CHAR      Move left in the field.
111        REQ_LEFT_FIELD     Move left to a field.
112        REQ_NEW_LINE       Insert or overlay a new line.
113        REQ_NEXT_CHAR      Move to the next char.
114        REQ_NEXT_CHOICE    Display next field choice.
115
116        REQ_NEXT_FIELD     Move to the next field.
117        REQ_NEXT_LINE      Move to the next line.
118        REQ_NEXT_PAGE      Move to the next page.
119        REQ_NEXT_PAGE      Move to the next page.
120        REQ_NEXT_WORD      Move to the next word.
121        REQ_OVL_MODE       Enter overlay mode.
122        REQ_PREV_CHAR      Move to the previous char.
123        REQ_PREV_CHOICE    Display previous field choice.
124        REQ_PREV_FIELD     Move to the previous field.
125        REQ_PREV_LINE      Move to the previous line.
126        REQ_PREV_PAGE      Move to the previous page.
127        REQ_PREV_WORD      Move to the previous word.
128        REQ_RIGHT_CHAR     Move right in the field.
129        REQ_RIGHT_FIELD    Move right to a field.
130        REQ_SCR_BCHAR      Scroll the field backward a character.
131        REQ_SCR_BHPAGE     Scroll the field backward half a page.
132        REQ_SCR_BLINE      Scroll the field backward a line.
133        REQ_SCR_BPAGE      Scroll the field backward a page.
134        REQ_SCR_FCHAR      Scroll the field forward a character.
135        REQ_SCR_FHPAGE     Scroll the field forward half a page.
136        REQ_SCR_FLINE      Scroll the field forward a line.
137        REQ_SCR_FPAGE      Scroll the field forward a page.
138        REQ_SCR_HBHALF     Horizontal scroll the field backward half a line.
139        REQ_SCR_HBLINE     Horizontal scroll the field backward a line.
140        REQ_SCR_HFHALF     Horizontal scroll the field forward half a line.
141        REQ_SCR_HFLINE     Horizontal scroll the field forward a line.
142        REQ_SFIRST_FIELD   Move to the sorted first field.
143        REQ_SLAST_FIELD    Move to the sorted last field.
144        REQ_SNEXT_FIELD    Move to the sorted next field.
145        REQ_SPREV_FIELD    Move to the sorted previous field.
146        REQ_UP_CHAR        Move up in the field.
147        REQ_UP_FIELD       Move up to a field.
148        REQ_VALIDATION     Validate field.
149
150        If  the  second argument is a printable character, the driver places it
151        in the current position in the current field.  If  it  is  one  of  the
152        forms requests listed above, that request is executed.
153
154
155 </PRE><H3><a name="h3-Field-validation">Field validation</a></H3><PRE>
156        The  form  library  makes  updates  to  the window associated with form
157        fields rather than directly to the field buffers.
158
159        The form driver provides low-level control over  updates  to  the  form
160        fields.   The  form driver also provides for validating modified fields
161        to ensure that the contents meet whatever  constraints  an  application
162        may attach using <STRONG>set_field_type</STRONG>.
163
164        You  can  validate  a  field  without  making  any  changes to it using
165        <STRONG>REQ_VALIDATION</STRONG>.  The form driver also validates a field in these cases:
166
167        <STRONG>o</STRONG>   a call to <STRONG>set_current_field</STRONG> attempts to move to a different field.
168
169        <STRONG>o</STRONG>   a call to <STRONG>set_current_page</STRONG> attempts to move to a different page  of
170            the form.
171
172        <STRONG>o</STRONG>   a request attempts to move to a different field.
173
174        <STRONG>o</STRONG>   a request attempts to move to a different page of the form.
175
176        In each case, the move fails if the field is invalid.
177
178        If  the  modified  field  is valid, the form driver copies the modified
179        data from the window associated with the field to the field buffer.
180
181
182 </PRE><H3><a name="h3-Mouse-handling">Mouse handling</a></H3><PRE>
183        If the second argument is the KEY_MOUSE  special  key,  the  associated
184        mouse  event  is translated into one of the above pre-defined requests.
185        Currently only clicks in the user window (e.g., inside the form display
186        area or the decoration window) are handled.
187
188        If you click above the display region of the form:
189
190           a REQ_PREV_FIELD is generated for a single click,
191
192           a REQ_PREV_PAGE is generated for a double-click and
193
194           a REQ_FIRST_FIELD is generated for a triple-click.
195
196        If you click below the display region of the form:
197
198           a REQ_NEXT_FIELD is generated for a single click,
199
200           a REQ_NEXT_PAGE is generated for a double-click and
201
202           a REQ_LAST_FIELD is generated for a triple-click.
203
204        If you click at an field inside the display area of the form:
205
206           <STRONG>o</STRONG>   the form cursor is positioned to that field.
207
208           <STRONG>o</STRONG>   If  you  double-click  a field, the form cursor is positioned to
209               that field and <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned.  This return value
210               makes sense, because a double click usually means that an field-
211               specific action should be returned.  It is exactly  the  purpose
212               of this return value to signal that an application specific com-
213               mand should be executed.
214
215           <STRONG>o</STRONG>   If a translation into a request was  done,  <STRONG>form_driver</STRONG>  returns
216               the result of this request.
217
218        If  you clicked outside the user window or the mouse event could not be
219        translated into a form request an <STRONG>E_REQUEST_DENIED</STRONG> is returned.
220
221
222 </PRE><H3><a name="h3-Application-defined-commands">Application-defined commands</a></H3><PRE>
223        If the second argument is neither printable nor one of the  above  pre-
224        defined form requests, the driver assumes it is an application-specific
225        command and returns  <STRONG>E_UNKNOWN_COMMAND</STRONG>.   Application-defined  commands
226        should  be  defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these
227        pre-defined requests.
228
229
230 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
231        <STRONG>form_driver</STRONG> returns one of the following error codes:
232
233        <STRONG>E_OK</STRONG> The routine succeeded.
234
235        <STRONG>E_BAD_ARGUMENT</STRONG>
236             Routine detected an incorrect or out-of-range argument.
237
238        <STRONG>E_BAD_STATE</STRONG>
239             Routine was called from an initialization or termination function.
240
241        <STRONG>E_NOT_POSTED</STRONG>
242             The form has not been posted.
243
244        <STRONG>E_INVALID_FIELD</STRONG>
245             Contents of field is invalid.
246
247        <STRONG>E_NOT_CONNECTED</STRONG>
248             No fields are connected to the form.
249
250        <STRONG>E_REQUEST_DENIED</STRONG>
251             The form driver could not process the request.
252
253        <STRONG>E_SYSTEM_ERROR</STRONG>
254             System error occurred (see <STRONG>errno(3)</STRONG>).
255
256        <STRONG>E_UNKNOWN_COMMAND</STRONG>
257             The form driver code saw an unknown request code.
258
259
260 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
261        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>, <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>,
262        <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">getch(3x)</A></STRONG>.
263
264
265 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
266        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header files
267        <STRONG>&lt;curses.h&gt;</STRONG>.
268
269
270 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
271        These routines emulate the System V forms library.  They were not  sup-
272        ported on Version 7 or BSD versions.
273
274
275 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
276        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
277        Raymond.
278
279
280
281                                                                <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
282 </PRE>
283 <div class="nav">
284 <ul>
285 <li><a href="#h2-NAME">NAME</a></li>
286 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
287 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
288 <ul>
289 <li><a href="#h3-form_driver">form_driver</a></li>
290 <li><a href="#h3-form_driver_w">form_driver_w</a></li>
291 <li><a href="#h3-Form-driver-requests">Form-driver requests</a></li>
292 <li><a href="#h3-Field-validation">Field validation</a></li>
293 <li><a href="#h3-Mouse-handling">Mouse handling</a></li>
294 <li><a href="#h3-Application-defined-commands">Application-defined commands</a></li>
295 </ul>
296 </li>
297 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
298 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
299 <li><a href="#h2-NOTES">NOTES</a></li>
300 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
301 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
302 </ul>
303 </div>
304 </BODY>
305 </HTML>