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