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