ncurses 6.0 - patch 20171118
[ncurses.git] / man / form_driver.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: form_driver.3x,v 1.28 2017/11/18 23:47:37 tom Exp $
30 .TH form_driver 3X ""
31 .de bP
32 .ie n  .IP \(bu 4
33 .el    .IP \(bu 2
34 ..
35 .SH NAME
36 \fBform_driver\fR,
37 \fBform_driver_w\fR \- command-processing loop of the form system
38 .SH SYNOPSIS
39 \fB#include <form.h>\fR
40 .br
41 \fBint form_driver(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB);\fP
42 .br
43 \fBint form_driver_w(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB, wchar_t \fP\fIwch\fP\fB);\fP
44 .br
45 .SH DESCRIPTION
46 .SS form_driver
47 Once a form has been posted (displayed), you should funnel input events to it
48 through \fBform_driver\fR.  This routine has three major input cases:
49 .bP
50 The input is a form navigation request.
51 Navigation request codes are constants defined in \fB<form.h>\fP,
52 which are distinct from the key- and character codes returned by \fBwgetch\fP(3X).
53 .bP
54 The input is a printable character.
55 Printable characters (which must be positive, less than 256) are
56 checked according to the program's locale settings.
57 .bP
58 The input is the KEY_MOUSE special key associated with an mouse event.
59 .SS form_driver_w
60 .PP
61 This extension simplifies the use of the forms library using wide characters.
62 The input is either a key code (a request) or a wide character
63 returned by \fBget_wch\fP(3X).
64 The type must be passed as well,
65 to enable the library to determine whether the parameter
66 is a wide character or a request.
67 .SS Form-driver requests
68 .PP
69 The form driver requests are as follows:
70 .TS
71 l l
72 _ _
73 l l.
74 \fIName\fR      \fIDescription\fR
75 REQ_BEG_FIELD   Move to the beginning of the field.
76 REQ_BEG_LINE    Move to the beginning of the line.
77 REQ_CLR_EOF     Clear to end of field from cursor.
78 REQ_CLR_EOL     Clear to end of line from cursor.
79 REQ_CLR_FIELD   Clear the entire field.
80 REQ_DEL_CHAR    Delete character at the cursor.
81 REQ_DEL_LINE    Delete line at the cursor.
82 REQ_DEL_PREV    Delete character before the cursor.
83 REQ_DEL_WORD    Delete blank-delimited word at the cursor.
84 REQ_DOWN_CHAR   Move down in the field.
85 REQ_DOWN_FIELD  Move down to a field.
86 REQ_END_FIELD   Move to the end of the field.
87 REQ_END_LINE    Move to the end of the line.
88 REQ_FIRST_FIELD Move to the first field.
89 REQ_FIRST_PAGE  Move to the first page.
90 REQ_INS_CHAR    Insert a blank at the cursor.
91 REQ_INS_LINE    Insert a blank line at the cursor.
92 REQ_INS_MODE    Enter insert mode.
93 REQ_LAST_FIELD  Move to the last field.
94 REQ_LAST_PAGE   Move to the last field.
95 REQ_LEFT_CHAR   Move left in the field.
96 REQ_LEFT_FIELD  Move left to a field.
97 REQ_NEW_LINE    Insert or overlay a new line.
98 REQ_NEXT_CHAR   Move to the next char.
99 REQ_NEXT_CHOICE Display next field choice.
100 REQ_NEXT_FIELD  Move to the next field.
101 REQ_NEXT_LINE   Move to the next line.
102 REQ_NEXT_PAGE   Move to the next page.
103 REQ_NEXT_PAGE   Move to the next page.
104 REQ_NEXT_WORD   Move to the next word.
105 REQ_OVL_MODE    Enter overlay mode.
106 REQ_PREV_CHAR   Move to the previous char.
107 REQ_PREV_CHOICE Display previous field choice.
108 REQ_PREV_FIELD  Move to the previous field.
109 REQ_PREV_LINE   Move to the previous line.
110 REQ_PREV_PAGE   Move to the previous page.
111 REQ_PREV_WORD   Move to the previous word.
112 REQ_RIGHT_CHAR  Move right in the field.
113 REQ_RIGHT_FIELD Move right to a field.
114 REQ_SCR_BCHAR   Scroll the field backward a character.
115 REQ_SCR_BHPAGE  Scroll the field backward half a page.
116 REQ_SCR_BLINE   Scroll the field backward a line.
117 REQ_SCR_BPAGE   Scroll the field backward a page.
118 REQ_SCR_FCHAR   Scroll the field forward a character.
119 REQ_SCR_FHPAGE  Scroll the field forward half a page.
120 REQ_SCR_FLINE   Scroll the field forward a line.
121 REQ_SCR_FPAGE   Scroll the field forward a page.
122 REQ_SCR_HBHALF  Horizontal scroll the field backward half a line.
123 REQ_SCR_HBLINE  Horizontal scroll the field backward a line.
124 REQ_SCR_HFHALF  Horizontal scroll the field forward half a line.
125 REQ_SCR_HFLINE  Horizontal scroll the field forward a line.
126 REQ_SFIRST_FIELD        Move to the sorted first field.
127 REQ_SLAST_FIELD Move to the sorted last field.
128 REQ_SNEXT_FIELD Move to the sorted next field.
129 REQ_SPREV_FIELD Move to the sorted previous field.
130 REQ_UP_CHAR     Move up in the field.
131 REQ_UP_FIELD    Move up to a field.
132 REQ_VALIDATION  Validate field.
133 .TE
134 .PP
135 If the second argument is a printable character, the driver places it
136 in the current position in the current field.  If it is one of the forms
137 requests listed above, that request is executed.
138 .SS Field validation
139 The form library makes updates to the window associated with form fields rather than
140 directly to the field buffers.
141 .PP
142 The form driver provides low-level control over updates to the form fields.
143 The form driver also provides for validating modified fields to ensure that the contents
144 meet whatever constraints an application may attach using \fBset_field_type\fP.
145 .PP
146 .PP
147 You can validate a field without making any changes to it using
148 \fBREQ_VALIDATION\fP.
149 The form driver also validates a field in these cases:
150 .bP
151 a call to \fBset_current_field\fP attempts to move to a different field.
152 .bP
153 a call to \fBset_current_page\fP attempts to move to a different page of the form.
154 .bP
155 a request attempts to move to a different field.
156 .bP
157 a request attempts to move to a different page of the form.
158 .PP
159 In each case, the move fails if the field is invalid.
160 .PP
161 If the modified field is valid, the form driver copies the modified
162 data from the window associated with the field
163 to the field buffer.
164 .SS Mouse handling
165 .PP
166 If the second argument is the KEY_MOUSE special key, the associated
167 mouse event is translated into one of the above pre-defined requests.
168 Currently only clicks in the user window (e.g., inside the form display
169 area or the decoration window) are handled.
170 .PP
171 If you click above the display region of the form:
172 .RS 3
173 .TP
174 a REQ_PREV_FIELD is generated for a single click,
175 .TP
176 a REQ_PREV_PAGE is generated for a double-click and
177 .TP
178 a REQ_FIRST_FIELD is generated for a triple-click.
179 .RE
180 .PP
181 If you click below the display region of the form:
182 .RS 3
183 .TP
184 a REQ_NEXT_FIELD is generated for a single click,
185 .TP
186 a REQ_NEXT_PAGE is generated for a double-click and
187 .TP
188 a REQ_LAST_FIELD is generated for a triple-click.
189 .RE
190 .PP
191 If you click at an field inside the display area of the form:
192 .RS 3
193 .bP
194 the form cursor is positioned to that field.
195 .bP
196 If you double-click a field,
197 the form cursor is positioned to that field
198 and \fBE_UNKNOWN_COMMAND\fR is returned.
199 This return value makes sense,
200 because a double click usually means that an field-specific action should
201 be returned.
202 It is exactly the purpose of this return value to signal that an
203 application specific command should be executed.
204 .bP
205 If a translation
206 into a request was done, \fBform_driver\fR returns the result of this request.
207 .RE
208 .PP
209 If you clicked outside the user window or the mouse event could not be translated
210 into a form request an \fBE_REQUEST_DENIED\fR is returned.
211 .SS Application-defined commands
212 .PP
213 If the second argument is neither printable nor one of the above
214 pre-defined form requests, the driver assumes it is an application-specific
215 command and returns \fBE_UNKNOWN_COMMAND\fR.  Application-defined commands
216 should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
217 pre-defined requests.
218 .SH RETURN VALUE
219 \fBform_driver\fR returns one of the following error codes:
220 .TP 5
221 .B E_OK
222 The routine succeeded.
223 .TP 5
224 .B E_BAD_ARGUMENT
225 Routine detected an incorrect or out-of-range argument.
226 .TP 5
227 .B E_BAD_STATE
228 Routine was called from an initialization or termination function.
229 .TP 5
230 .B E_NOT_POSTED
231 The form has not been posted.
232 .TP 5
233 .B E_INVALID_FIELD
234 Contents of field is invalid.
235 .TP 5
236 .B E_REQUEST_DENIED
237 The form driver could not process the request.
238 .TP 5
239 .B E_SYSTEM_ERROR
240 System error occurred (see \fBerrno\fR).
241 .TP 5
242 .B E_UNKNOWN_COMMAND
243 The form driver code saw an unknown request code.
244 .
245 .SH SEE ALSO
246 \fBcurses\fR(3X),
247 \fBform\fR(3X),
248 \fBform_field_buffer\fR(3X),
249 \fBform_field_validation\fR(3X),
250 \fBform_fieldtype\fR(3X),
251 \fBform_variables\fR(3X),
252 \fBgetch\fR(3X).
253 .SH NOTES
254 The header file \fB<form.h>\fR automatically includes the header files
255 \fB<curses.h>\fR.
256 .SH PORTABILITY
257 These routines emulate the System V forms library.  They were not supported on
258 Version 7 or BSD versions.
259 .SH AUTHORS
260 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
261 S. Raymond.