1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>TPXPictureValidator class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>TPXPictureValidator Class Reference</h1>Compare user input with a picture of a data format to determine the validity of entered data.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="validate_8h-source.html">validate.h</a>></code>
<p>
<p>Inheritance diagram for TPXPictureValidator:
<p><center><img src="classTPXPictureValidator.png" usemap="#TPXPictureValidator_map" border="0" alt=""></center>
<map name="TPXPictureValidator_map">
<area href="classTValidator.html" alt="TValidator" shape="rect" coords="68,56,195,80">
<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,127,24">
<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="137,0,264,24">
</map>
<a href="classTPXPictureValidator-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#a0">TPXPictureValidator</a> (const char *aPic, <a class="el" href="ttypes_8h.html#a13">Boolean</a> autoFill)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#a1">~TPXPictureValidator</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#a2">error</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a13">Boolean</a> </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#a3">isValidInput</a> (char *s, <a class="el" href="ttypes_8h.html#a13">Boolean</a> suppressFill)</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a13">Boolean</a> </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#a4">isValid</a> (const char *s)</td></tr>
<tr><td nowrap align=right valign=top>virtual TPicResult </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#a5">picture</a> (char *input, <a class="el" href="ttypes_8h.html#a13">Boolean</a> autoFill)</td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classTStreamable.html">TStreamable</a> * </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#d0">build</a> ()</td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#p0">name</a></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#b0">TPXPictureValidator</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#b1">write</a> (<a class="el" href="classopstream.html">opstream</a> &os)</td></tr>
<tr><td nowrap align=right valign=top>virtual void * </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#b2">read</a> (<a class="el" href="classipstream.html">ipstream</a> &is)</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classTPXPictureValidator.html#n0">pic</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Picture validator objects compare user input with a picture of a data format to determine the validity of entered data. The pictures are compatible with the pictures Borland's Paradox relational database uses to control data entry.
<p>
For a complete description of picture specifiers see method <a class="el" href="classTPXPictureValidator.html#a5">TPXPictureValidator::picture()</a>
<p>
<p>
Definition at line <a class="el" href="validate_8h-source.html#l00254">254</a> of file <a class="el" href="validate_8h-source.html">validate.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="TPXPictureValidator::TPXPictureValidator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> TPXPictureValidator::TPXPictureValidator </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>aPic</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="ttypes_8h.html#a13">Boolean</a> </td>
<td class="mdname" nowrap> <em>autoFill</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a picture validator object by first calling the constructor inherited from <a class="el" href="classTValidator.html">TValidator</a>, then allocating a copy of `aPic' on the heap and setting pic data member to point to it, then setting the voFill bit in <a class="el" href="classTValidator.html#m1">TValidator::options</a> data member if `autoFill' is True. </td>
</tr>
</table>
<a name="a1" doxytag="TPXPictureValidator::~TPXPictureValidator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> TPXPictureValidator::~TPXPictureValidator </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Disposes of the string pointed to by pic data member, then disposes of the picture validator object by calling the destructor inherited from <a class="el" href="classTValidator.html">TValidator</a>. </td>
</tr>
</table>
<a name="b0" doxytag="TPXPictureValidator::TPXPictureValidator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> TPXPictureValidator::TPXPictureValidator </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a14">StreamableInit</a> </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Each streamable class needs a "builder" to allocate the correct memory for its objects together with the initialized virtual table pointers. This is achieved by calling this constructor with an argument of type <a class="el" href="ttypes_8h.html#a14">StreamableInit</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="d0" doxytag="TPXPictureValidator::build"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classTStreamable.html">TStreamable</a>* TPXPictureValidator::build </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Called to create an object in certain stream-reading situations.
<p>
Reimplemented from <a class="el" href="classTValidator.html#d0">TValidator</a>. </td>
</tr>
</table>
<a name="a2" doxytag="TPXPictureValidator::error"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void TPXPictureValidator::error </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Displays a message box indicating an error in the picture format, displaying the string pointed to by pic data member.
<p>
Reimplemented from <a class="el" href="classTValidator.html#a1">TValidator</a>. </td>
</tr>
</table>
<a name="a4" doxytag="TPXPictureValidator::isValid"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="ttypes_8h.html#a13">Boolean</a> TPXPictureValidator::isValid </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>s</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compares the string passed in `s' with the format picture specified in pic data member and returns True if pic is null or if <a class="el" href="classTPXPictureValidator.html#a5">picture()</a> returns prComplete for `s', indicating that `s' needs no further input to meet the specified format.
<p>
Reimplemented from <a class="el" href="classTValidator.html#a3">TValidator</a>. </td>
</tr>
</table>
<a name="a3" doxytag="TPXPictureValidator::isValidInput"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="ttypes_8h.html#a13">Boolean</a> TPXPictureValidator::isValidInput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname" nowrap> <em>s</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="ttypes_8h.html#a13">Boolean</a> </td>
<td class="mdname" nowrap> <em>suppressFill</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Checks the string passed in `s' against the format picture specified in pic data member and returns True if pic is null or <a class="el" href="classTPXPictureValidator.html#a5">picture()</a> does not return prError for `s'; otherwise returns False.
<p>
The `suppressFill' parameter overrides the value in voFill for the duration of the call to <a class="el" href="classTPXPictureValidator.html#a3">isValidInput()</a>.
<p>
`s' is a pointer to string, so <a class="el" href="classTPXPictureValidator.html#a3">isValidInput()</a> can modify its value. For example, if `suppressFill' is False and voFill is set, the call to <a class="el" href="classTPXPictureValidator.html#a5">picture()</a> returns a filled string based on `s', so the image in the input line automatically reflects the format specified in pic.
<p>
Reimplemented from <a class="el" href="classTValidator.html#a2">TValidator</a>. </td>
</tr>
</table>
<a name="a5" doxytag="TPXPictureValidator::picture"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual TPicResult TPXPictureValidator::picture </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname" nowrap> <em>input</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="ttypes_8h.html#a13">Boolean</a> </td>
<td class="mdname" nowrap> <em>autoFill</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Formats the string passed in `input' according to the format specified by the picture string pointed to by pic data member. Returns prError if there is an error in the picture string or if `input' contains data that cannot fit the specified picture.
<p>
Returns prComplete if `input' can fully satisfy the specifed picture. Returns prIncomplete if `input' contains data that fits the specified picture but not completely.
<p>
The following table shows the characters used in creating format pictures.
<p>
<pre>
Type of character Character Description
Special # Accept only a digit
? Accept only a letter (case-insensitive)
& Accept only a letter, force to uppercase
@ Accept any character
! Accept any character, force to uppercase
Match ; Take next character literally
* Repetition count
[] Option
{} Grouping operators
, Set of alternatives
All others Taken literally
</pre>
<p>
Here are some advanced pictures, which show the power of TPXPictureValidator; these examples come from an old Pascal FAQ written by Berend de Boer, <<a href="mailto:berend@beard.nest.nl">berend@beard.nest.nl</a>>.
<p>
<pre>
Name Value Description
UnsignedPic1 #[#][#]*{[;,]###} unsigned int with optional commas
UnsignedPic2 #[#][#]*{;,###} unsigned int with commas
SignedPic1 [-]#[#][#]*{[;,]###} signed int with optional commas
SignedPic2 [-]#[#][#]*{;,###} signed int with commas
MoneyPic1 [$]*#.{##,00} dollars, with comma and optinal dollar sign
MoneyPic2 $*#{.##,.00} dollars, with comma and dollar sign
DatePic1 #[#]/#[#]/## date with 2 digit year (dd/mm/yy or mm/dd/yy)
DatePic2 #[#]/#[#]/##[##] date with 2 or 4 digit year (mm/dd/yy or mm/dd/yyyy)
DatePic3 #[#]/#[#]/#### date with 4 digit year (mm/dd/yyyy)
TimePic1 {##}:{##}[:{##}] HH:MM:SS with optional seconds
TimePic2 {##}:{##}:{##} HH:MM:SS
PhonePic1 [(###) ]###-#### phone number with optional area code
PhonePic2 (###) ###-#### phone number with area code
SSNPic ###-##-####
FirstCharUpPic *{&*? } uppercase the first char of every word
FilenamePic {&*7[&]}.{*3[&]} filename (no path) with extension
</pre>
<p>
Note the *7 and *3 in this last example. A number after a `*' says how many times the next sequence should be repeated; uncovered in the manuals. But this example is not completely correct (is this a bug?), because the `*' is interpreted as that there should be exactly 8 characters! No more, no less. Correct is:
<p>
<pre>
FilenamePic {&[&][&][&][&][&][&][&]}.{[&][&][&]}
</pre>
<p>
The following examples were given by Sean Wenzel in the Borland Turbo Vision forum on CompuServe:
<p>
<ul>
<li>US Phone with optional area code: [(*3{#})]*3{#}-*4{#}</ul>
<ul>
<li>Colors with autofill-in: {Red,Gr{ay,een},B{l{ack,ue},rown},White,Yellow}</ul>
<ul>
<li>A date in the format "Jan, 31, 1999" with auto fill-in: {J{AN ,U{N ,L }},FEB ,MA{R ,Y },A{PR ,UG },SEP ,OCT ,NOV ,DEC} {1[#],2[#],30,31,#};, 19##</ul>
Finally, here my solution for a real validator, for the format "1.234E-6" or "3.14159":
<p>
[-]#[*#][[.]#[*#]][E[-]#[#]] </td>
</tr>
</table>
<a name="b2" doxytag="TPXPictureValidator::read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void* TPXPictureValidator::read </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classipstream.html">ipstream</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>is</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Reads from the input stream `is'.
<p>
Reimplemented from <a class="el" href="classTValidator.html#b2">TValidator</a>. </td>
</tr>
</table>
<a name="b1" doxytag="TPXPictureValidator::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void TPXPictureValidator::write </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classopstream.html">opstream</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>os</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Writes to the output stream `os'.
<p>
Reimplemented from <a class="el" href="classTValidator.html#b1">TValidator</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="TPXPictureValidator::name"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const char* const TPXPictureValidator::name<code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Undocumented.
<p>
Reimplemented from <a class="el" href="classTValidator.html#p0">TValidator</a>.
<p>
Definition at line <a class="el" href="validate_8h-source.html#l00459">459</a> of file <a class="el" href="validate_8h-source.html">validate.h</a>. </td>
</tr>
</table>
<a name="n0" doxytag="TPXPictureValidator::pic"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* TPXPictureValidator::pic<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Points to a string containing the picture that specifies the format for data in the associated input line. The constructor sets pic to the string passed as one of its parameters.
<p>
Definition at line <a class="el" href="validate_8h-source.html#l00401">401</a> of file <a class="el" href="validate_8h-source.html">validate.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="validate_8h-source.html">validate.h</a></ul>
<hr><address style="align: right;"><small>Generated on Wed Apr 2 22:13:16 2003 for TVision by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>
|
