← Back to branch summary

~ubuntu-branches/ubuntu/natty/ncurses/natty

« back to all changes in this revision

Viewing changes to man/form_driver.3x

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-17 09:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517090042-86fgxrr6j5jzagot
Tags: 5.6-0ubuntu1
* New upstream version.
  - Remove patches applied upstream: ncurses.upstream, signed-chars.
  - Update patches: debian-backspace.
* Build-depend on g++-multilib instead of lib{32,64}c*-dev-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/form_driver.3x
1
1
.\"***************************************************************************
2
 
.\" Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
 
2
.\" Copyright (c) 1998-2002,2006 Free Software Foundation, Inc.              *
3
3
.\"                                                                          *
4
4
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
5
5
.\" copy of this software and associated documentation files (the            *
26
26
.\" authorization.                                                           *
27
27
.\"***************************************************************************
28
28
.\"
29
 
.\" $Id: form_driver.3x,v 1.9 2002/02/16 22:39:52 tom Exp $
 
29
.\" $Id: form_driver.3x,v 1.12 2006/11/04 18:51:00 tom Exp $
30
30
.TH form_driver 3X ""
31
31
.SH NAME
32
32
\fBform_driver\fR - command-processing loop of the form system
52
52
.TP 5
53
53
REQ_LAST_PAGE
54
54
Move to the last field.
55
 
 
 
55
.sp
56
56
.TP 5
57
57
REQ_NEXT_FIELD
58
58
Move to the next field.
89
89
.TP 5
90
90
REQ_DOWN_FIELD
91
91
Move down to a field.
92
 
 
 
92
.sp
93
93
.TP 5
94
94
REQ_NEXT_CHAR
95
95
Move to the next char.
132
132
.TP 5
133
133
REQ_DOWN_CHAR
134
134
Move down in the field.
135
 
 
 
135
.sp
136
136
.TP 5
137
137
REQ_NEW_LINE
138
138
Insert or overlay a new line.
169
169
.TP 5
170
170
REQ_INS_MODE
171
171
Enter insert mode.
172
 
 
 
172
.sp
173
173
.TP 5
174
174
REQ_SCR_FLINE
175
175
Scroll the field forward a line.
188
188
.TP 5
189
189
REQ_SCR_BHPAGE
190
190
Scroll the field backward half a page.
191
 
 
 
191
.sp
192
192
.TP 5
193
193
REQ_SCR_FCHAR
194
194
Scroll the field forward a character.
207
207
.TP 5
208
208
REQ_SCR_HBHALF
209
209
Horizontal scroll the field backward half a line.
210
 
 
 
210
.sp
211
211
.TP
212
212
REQ_VALIDATION
213
213
Validate field.
228
228
should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
229
229
pre-defined requests.
230
230
.SH RETURN VALUE
231
 
\fBform_driver\fR return one of the following error codes:
 
231
\fBform_driver\fR returns one of the following error codes:
232
232
.TP 5
233
 
\fBE_OK\fR
 
233
.B E_OK
234
234
The routine succeeded.
235
235
.TP 5
236
 
\fBE_SYSTEM_ERROR\fR
237
 
System error occurred (see \fBerrno\fR).
238
 
.TP 5
239
 
\fBE_BAD_ARGUMENT\fR
 
236
.B E_BAD_ARGUMENT
240
237
Routine detected an incorrect or out-of-range argument.
241
238
.TP 5
242
 
\fBE_BAD_STATE\fR
 
239
.B E_BAD_STATE
243
240
Routine was called from an initialization or termination function.
244
241
.TP 5
245
 
\fBE_NOT_POSTED\fR
 
242
.B E_NOT_POSTED
246
243
The form has not been posted.
247
244
.TP 5
248
 
\fBE_UNKNOWN_COMMAND\fR
249
 
The form driver code saw an unknown request code.
250
 
.TP 5
251
 
\fBE_INVALID_FIELD\fR
 
245
.B E_INVALID_FIELD
252
246
Contents of field is invalid.
253
247
.TP 5
254
 
\fBE_REQUEST_DENIED\fR
 
248
.B E_REQUEST_DENIED
255
249
The form driver could not process the request.
 
250
.TP 5
 
251
.B E_SYSTEM_ERROR
 
252
System error occurred (see \fBerrno\fR).
 
253
.TP 5
 
254
.B E_UNKNOWN_COMMAND
 
255
The form driver code saw an unknown request code.
 
256
.
256
257
.SH SEE ALSO
257
258
\fBcurses\fR(3X), \fBform\fR(3X).
258
259
.SH NOTES