usr/src/man/man3curses/form_driver.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH FORM_DRIVER 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_driver \- command processor for the forms subsystem
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  14 #include <form.h>
  15
  16 \fBint\fR \fBform_driver\fR(\fBFORM *\fR\fIform\fR, \fBint\fR \fIc\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBform_driver()\fR function is the workhorse of the \fBforms\fR subsystem;
  23 it checks to determine whether the character \fIc\fR is a \fBforms\fR request
  24 or data. If it is a request, the form driver executes the request and reports
  25 the result. If it is data (a printable \fBASCII\fR character), it enters the
  26 data into the current position in the current field. If it is not recognized,
  27 the form driver assumes it is an application-defined command and returns
  28 \fBE_UNKNOWN_COMMAND\fR. Application defined commands should be defined
  29 relative to \fBMAX_COMMAND\fR, the maximum value of a request listed below.
  30 .sp
  31 .LP
  32 Form driver requests:
  33 .sp
  34 .ne 2
  35 .na
  36 \fBREQ_NEXT_PAGE\fR
  37 .ad
  38 .RS 20n
  39 Move to the next page.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fBREQ_PREV_PAGE\fR
  46 .ad
  47 .RS 20n
  48 Move to the previous page.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fBREQ_FIRST_PAGE\fR
  55 .ad
  56 .RS 20n
  57 Move to the first page.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fBREQ_LAST_PAGE\fR
  64 .ad
  65 .RS 20n
  66 Move to the last page.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fBREQ_NEXT_FIELD\fR
  73 .ad
  74 .RS 20n
  75 Move to the next field.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fBREQ_PREV_FIELD\fR
  82 .ad
  83 .RS 20n
  84 Move to the previous field.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fBREQ_FIRST_FIELD\fR
  91 .ad
  92 .RS 20n
  93 Move to the first field.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fBREQ_LAST_FIELD\fR
 100 .ad
 101 .RS 20n
 102 Move to the last field.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fBREQ_SNEXT_FIELD\fR
 109 .ad
 110 .RS 20n
 111 Move to the sorted next field.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fBREQ_SPREV_FIELD\fR
 118 .ad
 119 .RS 20n
 120 Move to the sorted prev field.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fBREQ_SFIRST_FIELD\fR
 127 .ad
 128 .RS 20n
 129 Move to the sorted first field.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fBREQ_SLAST_FIELD\fR
 136 .ad
 137 .RS 20n
 138 Move to the sorted last field.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fBREQ_LEFT_FIELD\fR
 145 .ad
 146 .RS 20n
 147 Move left to field.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fBREQ_RIGHT_FIELD\fR
 154 .ad
 155 .RS 20n
 156 Move right to field.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fBREQ_UP_FIELD\fR
 163 .ad
 164 .RS 20n
 165 Move up to field.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fBREQ_DOWN_FIELD\fR
 172 .ad
 173 .RS 20n
 174 Move down to field.
 175 .RE
 176
 177 .sp
 178 .ne 2
 179 .na
 180 \fBREQ_NEXT_CHAR\fR
 181 .ad
 182 .RS 20n
 183 Move to the next character in the field.
 184 .RE
 185
 186 .sp
 187 .ne 2
 188 .na
 189 \fBREQ_PREV_CHAR\fR
 190 .ad
 191 .RS 20n
 192 Move to the previous character in the field.
 193 .RE
 194
 195 .sp
 196 .ne 2
 197 .na
 198 \fBREQ_NEXT_LINE\fR
 199 .ad
 200 .RS 20n
 201 Move to the next line in the field.
 202 .RE
 203
 204 .sp
 205 .ne 2
 206 .na
 207 \fBREQ_PREV_LINE\fR
 208 .ad
 209 .RS 20n
 210 Move to the previous line in the field.
 211 .RE
 212
 213 .sp
 214 .ne 2
 215 .na
 216 \fBREQ_NEXT_WORD\fR
 217 .ad
 218 .RS 20n
 219 Move to the next word in the field.
 220 .RE
 221
 222 .sp
 223 .ne 2
 224 .na
 225 \fBREQ_PREV_WORD\fR
 226 .ad
 227 .RS 20n
 228 Move to the previous word in the field.
 229 .RE
 230
 231 .sp
 232 .ne 2
 233 .na
 234 \fBREQ_BEG_FIELD\fR
 235 .ad
 236 .RS 20n
 237 Move to the first char in the field.
 238 .RE
 239
 240 .sp
 241 .ne 2
 242 .na
 243 \fBREQ_END_FIELD\fR
 244 .ad
 245 .RS 20n
 246 Move after the last char in the field.
 247 .RE
 248
 249 .sp
 250 .ne 2
 251 .na
 252 \fBREQ_BEG_LINE\fR
 253 .ad
 254 .RS 20n
 255 Move to the beginning of the line.
 256 .RE
 257
 258 .sp
 259 .ne 2
 260 .na
 261 \fBREQ_END_LINE\fR
 262 .ad
 263 .RS 20n
 264 Move after the last char in the line.
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fBREQ_LEFT_CHAR\fR
 271 .ad
 272 .RS 20n
 273 Move left in the field.
 274 .RE
 275
 276 .sp
 277 .ne 2
 278 .na
 279 \fBREQ_RIGHT_CHAR\fR
 280 .ad
 281 .RS 20n
 282 Move right in the field.
 283 .RE
 284
 285 .sp
 286 .ne 2
 287 .na
 288 \fBREQ_UP_CHAR\fR
 289 .ad
 290 .RS 20n
 291 Move up in the field.
 292 .RE
 293
 294 .sp
 295 .ne 2
 296 .na
 297 \fBREQ_DOWN_CHAR\fR
 298 .ad
 299 .RS 20n
 300 Move down in the field.
 301 .RE
 302
 303 .sp
 304 .ne 2
 305 .na
 306 \fBREQ_NEW_LINE\fR
 307 .ad
 308 .RS 20n
 309 Insert/overlay a new line.
 310 .RE
 311
 312 .sp
 313 .ne 2
 314 .na
 315 \fBREQ_INS_CHAR\fR
 316 .ad
 317 .RS 20n
 318 Insert the blank character at the cursor.
 319 .RE
 320
 321 .sp
 322 .ne 2
 323 .na
 324 \fBREQ_INS_LINE\fR
 325 .ad
 326 .RS 20n
 327 Insert a blank line at the cursor.
 328 .RE
 329
 330 .sp
 331 .ne 2
 332 .na
 333 \fBREQ_DEL_CHAR\fR
 334 .ad
 335 .RS 20n
 336 Delete the character at the cursor.
 337 .RE
 338
 339 .sp
 340 .ne 2
 341 .na
 342 \fBREQ_DEL_PREV\fR
 343 .ad
 344 .RS 20n
 345 Delete the character before the cursor.
 346 .RE
 347
 348 .sp
 349 .ne 2
 350 .na
 351 \fBREQ_DEL_LINE\fR
 352 .ad
 353 .RS 20n
 354 Delete the line at the cursor.
 355 .RE
 356
 357 .sp
 358 .ne 2
 359 .na
 360 \fBREQ_DEL_WORD\fR
 361 .ad
 362 .RS 20n
 363 Delete the word at the cursor.
 364 .RE
 365
 366 .sp
 367 .ne 2
 368 .na
 369 \fBREQ_CLR_EOL\fR
 370 .ad
 371 .RS 20n
 372 Clear to the end of the line.
 373 .RE
 374
 375 .sp
 376 .ne 2
 377 .na
 378 \fBREQ_CLR_EOF\fR
 379 .ad
 380 .RS 20n
 381 Clear to the end of the field.
 382 .RE
 383
 384 .sp
 385 .ne 2
 386 .na
 387 \fBREQ_CLR_FIELD\fR
 388 .ad
 389 .RS 20n
 390 Clear the entire field.
 391 .RE
 392
 393 .sp
 394 .ne 2
 395 .na
 396 \fBREQ_OVL_MODE\fR
 397 .ad
 398 .RS 20n
 399 Enter overlay mode.
 400 .RE
 401
 402 .sp
 403 .ne 2
 404 .na
 405 \fBREQ_INS_MODE\fR
 406 .ad
 407 .RS 20n
 408 Enter insert mode.
 409 .RE
 410
 411 .sp
 412 .ne 2
 413 .na
 414 \fBREQ_SCR_FLINE\fR
 415 .ad
 416 .RS 20n
 417 Scroll the field forward a line.
 418 .RE
 419
 420 .sp
 421 .ne 2
 422 .na
 423 \fBREQ_SCR_BLINE\fR
 424 .ad
 425 .RS 20n
 426 Scroll the field backward a line.
 427 .RE
 428
 429 .sp
 430 .ne 2
 431 .na
 432 \fBREQ_SCR_FPAGE\fR
 433 .ad
 434 .RS 20n
 435 Scroll the field forward a page.
 436 .RE
 437
 438 .sp
 439 .ne 2
 440 .na
 441 \fBREQ_SCR_BPAGE \fR
 442 .ad
 443 .RS 20n
 444 Scroll the field backward a page.
 445 .RE
 446
 447 .sp
 448 .ne 2
 449 .na
 450 \fBREQ_SCR_FHPAGE\fR
 451 .ad
 452 .RS 20n
 453 Scroll the field forward half a page.
 454 .RE
 455
 456 .sp
 457 .ne 2
 458 .na
 459 \fBREQ_SCR_BHPAGE\fR
 460 .ad
 461 .RS 20n
 462 Scroll the field backward half a page.
 463 .RE
 464
 465 .sp
 466 .ne 2
 467 .na
 468 \fBREQ_SCR_FCHAR\fR
 469 .ad
 470 .RS 20n
 471 Horizontal scroll forward a character.
 472 .RE
 473
 474 .sp
 475 .ne 2
 476 .na
 477 \fBREQ_SCR_BCHAR\fR
 478 .ad
 479 .RS 20n
 480 Horizontal scroll backward a character
 481 .RE
 482
 483 .sp
 484 .ne 2
 485 .na
 486 \fBREQ_SCR_HFLINE\fR
 487 .ad
 488 .RS 20n
 489 Horizontal scroll forward a line.
 490 .RE
 491
 492 .sp
 493 .ne 2
 494 .na
 495 \fBREQ_SCR_HBLINE\fR
 496 .ad
 497 .RS 20n
 498 Horizontal scroll backward a line.
 499 .RE
 500
 501 .sp
 502 .ne 2
 503 .na
 504 \fBREQ_SCR_HFHALF\fR
 505 .ad
 506 .RS 20n
 507 Horizontal scroll forward half a line.
 508 .RE
 509
 510 .sp
 511 .ne 2
 512 .na
 513 \fBREQ_SCR_HBHALF\fR
 514 .ad
 515 .RS 20n
 516 Horizontal scroll backward half a line.
 517 .RE
 518
 519 .sp
 520 .ne 2
 521 .na
 522 \fBREQ_VALIDATION\fR
 523 .ad
 524 .RS 20n
 525 Validate field.
 526 .RE
 527
 528 .sp
 529 .ne 2
 530 .na
 531 \fBREQ_PREV_CHOICE\fR
 532 .ad
 533 .RS 20n
 534 Display the previous field choice.
 535 .RE
 536
 537 .sp
 538 .ne 2
 539 .na
 540 \fBREQ_NEXT_CHOICE\fR
 541 .ad
 542 .RS 20n
 543 Display the next field choice.
 544 .RE
 545
 546 .SH RETURN VALUES
 547 .sp
 548 .LP
 549 The \fBform_driver()\fR function returns one of the following:
 550 .sp
 551 .ne 2
 552 .na
 553 \fBE_OK\fR
 554 .ad
 555 .RS 21n
 556 The function returned successfully.
 557 .RE
 558
 559 .sp
 560 .ne 2
 561 .na
 562 \fBE_SYSTEM_ERROR\fR
 563 .ad
 564 .RS 21n
 565 System error.
 566 .RE
 567
 568 .sp
 569 .ne 2
 570 .na
 571 \fBE_BAD_ARGUMENT\fR
 572 .ad
 573 .RS 21n
 574 An argument is incorrect.
 575 .RE
 576
 577 .sp
 578 .ne 2
 579 .na
 580 \fBE_NOT_POSTED\fR
 581 .ad
 582 .RS 21n
 583 The form is not posted.
 584 .RE
 585
 586 .sp
 587 .ne 2
 588 .na
 589 \fBE_INVALID_FIELD\fR
 590 .ad
 591 .RS 21n
 592 The field contents are invalid.
 593 .RE
 594
 595 .sp
 596 .ne 2
 597 .na
 598 \fBE_BAD_STATE\fR
 599 .ad
 600 .RS 21n
 601 The routine was called from an initialization or termination function.
 602 .RE
 603
 604 .sp
 605 .ne 2
 606 .na
 607 \fBE_REQUEST_DENIED\fR
 608 .ad
 609 .RS 21n
 610 The form driver request failed.
 611 .RE
 612
 613 .sp
 614 .ne 2
 615 .na
 616 \fBE_UNKNOWN_COMMAND\fR
 617 .ad
 618 .RS 21n
 619 An unknown request was passed to the form driver.
 620 .RE
 621
 622 .SH ATTRIBUTES
 623 .sp
 624 .LP
 625 See \fBattributes\fR(5) for descriptions of the following attributes:
 626 .sp
 627
 628 .sp
 629 .TS
 630 box;
 631 c | c
 632 l | l .
 633 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 634 _
 635 MT-Level        Unsafe
 636 .TE
 637
 638 .SH SEE ALSO
 639 .sp
 640 .LP
 641 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 642 .SH NOTES
 643 .sp
 644 .LP
 645 The header <\fBform.h\fR> automatically includes the headers <\fBeti.h\fR> and
 646 <\fBcurses.h\fR>.