summaryrefslogtreecommitdiff
path: root/sigalatvision/doc/html/classTLookupValidator.html
blob: badddbbce1a61186613767c4b1be9cf2dd6daed2 (plain)
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
<!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>TLookupValidator class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>TLookupValidator  Class Reference</h1>Compares the string typed by a user with a list of acceptable values. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="validate_8h-source.html">validate.h</a>&gt;</code>
<p>
<p>Inheritance diagram for TLookupValidator::
<p><center><img src="classTLookupValidator.gif" usemap="#TLookupValidator_map" border="0"></center>
<map name="TLookupValidator_map">
<area href="classTValidator.html" alt="TValidator" shape="rect" coords="77,56,221,80">
<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,144,24">
<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="154,0,298,24">
<area href="classTStringLookupValidator.html" alt="TStringLookupValidator" shape="rect" coords="77,168,221,192">
</map>
<a href="classTLookupValidator-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classTLookupValidator.html#a0">TLookupValidator</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a13">Boolean</a>&nbsp;</td><td valign=bottom><a class="el" href="classTLookupValidator.html#a1">isValid</a> (const char *s)</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a13">Boolean</a>&nbsp;</td><td valign=bottom><a class="el" href="classTLookupValidator.html#a2">lookup</a> (const char *s)</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>*&nbsp;</td><td valign=bottom><a class="el" href="classTLookupValidator.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&nbsp;</td><td valign=bottom><a class="el" href="classTLookupValidator.html#p0">name</a></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classTLookupValidator.html#b0">TLookupValidator</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A lookup validator compares the string typed by a user with a list of acceptable values. TLookupValidator is an abstract validator type from which you can derive useful lookup validators. You will never create an instance of TLookupValidator.
<p>
When you create a lookup validator type, you need to specify a list of valid items and override the <a class="el" href="classTLookupValidator.html#a2">lookup</a>() method to return True only if the user input matches an item in that list. One example of a working descendant of TLookupValidator is <a class="el" href="classTStringLookupValidator.html">TStringLookupValidator</a>. 
<p>

<p>
Definition at line <a class="el" href="validate_8h-source.html#l00752">752</a> of file <a class="el" href="validate_8h-source.html">validate.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="TLookupValidator::TLookupValidator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
TLookupValidator::TLookupValidator (
          </b></td>
          <td valign="bottom"><b>
)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Undocumented. 
<p>
Definition at line <a class="el" href="validate_8h-source.html#l00758">758</a> of file <a class="el" href="validate_8h-source.html">validate.h</a>.    </td>
  </tr>
</table>
<a name="b0" doxytag="TLookupValidator::TLookupValidator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
TLookupValidator::TLookupValidator (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>&nbsp;)<code> [protected]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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="TLookupValidator::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 nowrap valign="top"><b> 
<a class="el" href="classTStreamable.html">TStreamable</a> * TLookupValidator::build (
          </b></td>
          <td valign="bottom"><b>
)<code> [static]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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>.
<p>
Reimplemented in <a class="el" href="classTStringLookupValidator.html#d0">TStringLookupValidator</a>.    </td>
  </tr>
</table>
<a name="a1" doxytag="TLookupValidator::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 nowrap valign="top"><b> 
<a class="el" href="ttypes_8h.html#a13">Boolean</a> TLookupValidator::isValid (
          </b></td>
          <td valign="bottom"><b>
const char * <em>s</em>&nbsp;)<code> [virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Calls <a class="el" href="classTLookupValidator.html#a2">lookup</a>() to find the string `s' in the list of valid input items. Returns True if <a class="el" href="classTLookupValidator.html#a2">lookup</a>() returns True, meaning <a class="el" href="classTLookupValidator.html#a2">lookup</a>() found `s' in its list; otherwise returns False. 
<p>
Reimplemented from <a class="el" href="classTValidator.html#a3">TValidator</a>.    </td>
  </tr>
</table>
<a name="a2" doxytag="TLookupValidator::lookup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
<a class="el" href="ttypes_8h.html#a13">Boolean</a> TLookupValidator::lookup (
          </b></td>
          <td valign="bottom"><b>
const char * <em>s</em>&nbsp;)<code> [virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Searches for the string `s' in the list of valid entries and returns True if it finds `s'; otherwise returns False. TLookupValidator's <a class="el" href="classTLookupValidator.html#a2">lookup</a>() is an abstract method that always returns False.
<p>
Descendant lookup validator types must override <a class="el" href="classTLookupValidator.html#a2">lookup</a>() to perform a search based on the actual list of acceptable items. 
<p>
Reimplemented in <a class="el" href="classTStringLookupValidator.html#a3">TStringLookupValidator</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="TLookupValidator::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 nowrap valign="top"><b> 
const char *const TLookupValidator::name<code> [static]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Undocumented. 
<p>
Reimplemented from <a class="el" href="classTValidator.html#p0">TValidator</a>.
<p>
Reimplemented in <a class="el" href="classTStringLookupValidator.html#p0">TStringLookupValidator</a>.
<p>
Definition at line <a class="el" href="validate_8h-source.html#l00781">781</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><small>Generated at Sat Sep 22 20:19:28 2001 for TVision by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.8.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>