-
Notifications
You must be signed in to change notification settings - Fork 1
/
BrookStringMap.TBrookStringMap.html
503 lines (502 loc) · 25.2 KB
/
BrookStringMap.TBrookStringMap.html
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
502
503
<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookStringMap: Class TBrookStringMap</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<span id="TBrookStringMap"></span><h1 class="cio">Class TBrookStringMap</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookStringMap.html">BrookStringMap</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookStringMap = class(<a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html">TBrookHandledPersistent</a>)</code></p>
<h2 class="description">Description</h2>
<p>
String map class and its related methods.</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor">TPersistent</li>
<li class="ancestor"><a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html">TBrookHandledPersistent</a></li>
<li class="thisitem">TBrookStringMap</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <strong><a href="BrookStringMap.TBrookStringMap.html#Create">Create</a></strong>(AHandle: Pointer); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <strong><a href="BrookStringMap.TBrookStringMap.html#Destroy">Destroy</a></strong>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#Assign">Assign</a></strong>(ASource: TPersistent); override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#IsEmpty">IsEmpty</a></strong>: Boolean; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#GetEnumerator">GetEnumerator</a></strong>: <a href="BrookStringMap.TBrookStringMapEnumerator.html">TBrookStringMapEnumerator</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#Add">Add</a></strong>(const AName, AValue: string); virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#AddOrSet">AddOrSet</a></strong>(const AName, AValue: string); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#Remove">Remove</a></strong>(const AName: string); virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#Clear">Clear</a></strong>; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#Find">Find</a></strong>(const AName: string; out APair: <a href="BrookStringMap.TBrookStringPair.html">TBrookStringPair</a>): Boolean; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#Contains">Contains</a></strong>(const AName: string): Boolean; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#Get">Get</a></strong>(const AName: string): string; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#TryValue">TryValue</a></strong>(const AName: string; out AValue: string): Boolean; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#First">First</a></strong>(out APair: <a href="BrookStringMap.TBrookStringPair.html">TBrookStringPair</a>): Boolean; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#Next">Next</a></strong>(out APair: <a href="BrookStringMap.TBrookStringPair.html">TBrookStringPair</a>): Boolean; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#Iterate">Iterate</a></strong>(AIterator: <a href="BrookStringMap.html#TBrookStringMapIterator">TBrookStringMapIterator</a>; AData: Pointer); virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#Sort">Sort</a></strong>(AComparator: <a href="BrookStringMap.html#TBrookStringMapComparator">TBrookStringMapComparator</a>; AData: Pointer); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#Fetch">Fetch</a></strong>(AObject: TObject; const AAllowed, AIgnored: array of string); overload; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookStringMap.TBrookStringMap.html#Fetch">Fetch</a></strong>(AObject: TObject); overload; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookStringMap.TBrookStringMap.html#ToString">ToString</a></strong>: string; override;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookStringMap.TBrookStringMap.html#Count">Count</a></strong>: Integer read GetCount;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookStringMap.TBrookStringMap.html#Values">Values</a></strong>[constAName:string]: string read GetValue
write SetValue;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookStringMap.TBrookStringMap.html#EOF">EOF</a></strong>: Boolean read IsEOF;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookStringMap.TBrookStringMap.html#Empty">Empty</a></strong>: Boolean read <a href="BrookStringMap.TBrookStringMap.html#IsEmpty">IsEmpty</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookStringMap.TBrookStringMap.html#ClearOnDestroy">ClearOnDestroy</a></strong>: Boolean read FClearOnDestroy write FClearOnDestroy;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookStringMap.TBrookStringMap.html#OnChange">OnChange</a></strong>: <a href="BrookStringMap.html#TBrookStringMapChangeEvent">TBrookStringMapChangeEvent</a> read FOnChange write FOnChange;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Create"></span><code>constructor <strong>Create</strong>(AHandle: Pointer); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of <code><a class="normal" href="BrookStringMap.TBrookStringMap.html">TBrookStringMap</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AHandle[in]</dt>
<dd>Pointer to store the string map <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Destroy"></span><code>destructor <strong>Destroy</strong>; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Frees an instance of <code><a class="normal" href="BrookStringMap.TBrookStringMap.html">TBrookStringMap</a></code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Assign"></span><code>procedure <strong>Assign</strong>(ASource: TPersistent); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Copies the properties of the source string map. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASource[in]</dt>
<dd>String map source to be copied.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="IsEmpty"></span><code>function <strong>IsEmpty</strong>: Boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Checks if the map is <a class="normal" href="BrookStringMap.TBrookStringMap.html#Empty">empty</a>. </p>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> when map is <a class="normal" href="BrookStringMap.TBrookStringMap.html#Empty">empty</a>, <code>False</code> otherwise.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="GetEnumerator"></span><code>function <strong>GetEnumerator</strong>: <a href="BrookStringMap.TBrookStringMapEnumerator.html">TBrookStringMapEnumerator</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets an instance of <code><a class="normal" href="BrookStringMap.TBrookStringMapEnumerator.html">TBrookStringMapEnumerator</a></code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Add"></span><code>procedure <strong>Add</strong>(const AName, AValue: string); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Adds a pair of strings to the map. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name of the pair.</dd>
<dt>AValue[in]</dt>
<dd>Value of the pair.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="AddOrSet"></span><code>procedure <strong>AddOrSet</strong>(const AName, AValue: string); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Adds or sets a pair of strings to the map. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name of the pair.</dd>
<dt>AValue[in]</dt>
<dd>Value of the pair.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Remove"></span><code>procedure <strong>Remove</strong>(const AName: string); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Removes a pair by its name. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name of the pair.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Clear"></span><code>procedure <strong>Clear</strong>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clears the entire map.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Find"></span><code>function <strong>Find</strong>(const AName: string; out APair: <a href="BrookStringMap.TBrookStringPair.html">TBrookStringPair</a>): Boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Finds a pair by its name. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name of the pair.</dd>
<dt>APair[out]</dt>
<dd>Reference to store found pair.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> when pair is found, <code>False</code> otherwise.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Contains"></span><code>function <strong>Contains</strong>(const AName: string): Boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Checks if map <code>contains</code> a pair by its name. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name of the pair.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> when map <code>contains</code> the pair, <code>False</code> otherwise.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Get"></span><code>function <strong>Get</strong>(const AName: string): string; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets a pair by name and returns its value. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name of the pair.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Pair value.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="TryValue"></span><code>function <strong>TryValue</strong>(const AName: string; out AValue: string): Boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Tries to <a class="normal" href="BrookStringMap.TBrookStringMap.html#Find">find</a> a pair value by its name. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Name of the pair.</dd>
<dt>AValue[out]</dt>
<dd>Reference to store found value.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> when pair is found, <code>False</code> otherwise.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="First"></span><code>function <strong>First</strong>(out APair: <a href="BrookStringMap.TBrookStringPair.html">TBrookStringPair</a>): Boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Retrieves the <code>first</code> pair in the map. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APair[out]</dt>
<dd><code>First</code> pair returned.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> when pair is found, <code>False</code> otherwise.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Next"></span><code>function <strong>Next</strong>(out APair: <a href="BrookStringMap.TBrookStringPair.html">TBrookStringPair</a>): Boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Retrieves the <code>next</code> pair in the map. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APair[out]</dt>
<dd><code>Next</code> pair returned.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Iterate"></span><code>procedure <strong>Iterate</strong>(AIterator: <a href="BrookStringMap.html#TBrookStringMapIterator">TBrookStringMapIterator</a>; AData: Pointer); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Iterates over pairs map. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AIterator[in]</dt>
<dd>Function to <code>iterate</code> the pairs.</dd>
<dt>AData[in,out]</dt>
<dd>User-specified value.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Sort"></span><code>procedure <strong>Sort</strong>(AComparator: <a href="BrookStringMap.html#TBrookStringMapComparator">TBrookStringMapComparator</a>; AData: Pointer); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sorts the pairs map. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AComparator[in]</dt>
<dd>Function to <code>sort</code> the pairs.</dd>
<dt>AData[in,out]</dt>
<dd>User-specified value.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Fetch"></span><code>procedure <strong>Fetch</strong>(AObject: TObject; const AAllowed, AIgnored: array of string); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Fetches a string map as an object. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AObject[in]</dt>
<dd>Object with properties that correspond to the fetched string map.</dd>
<dt>AAllowed[in]</dt>
<dd>Array of properties to be allowed when fetching.</dd>
<dt>AIgnored[in]</dt>
<dd>Array of properties to be ignored when fetching.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Fetch"></span><code>procedure <strong>Fetch</strong>(AObject: TObject); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Fetches a string map as an object.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="ToString"></span><code>function <strong>ToString</strong>: string; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets the map as big string using equal sign to separate each pair and ending lines using line break.</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Count"></span><code>property <strong>Count</strong>: Integer read GetCount;</code></td>
</tr>
<tr><td colspan="2">
<p>
Counts the total pairs present in the map.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Values"></span><code>property <strong>Values</strong>[constAName:string]: string read GetValue
write SetValue;</code></td>
</tr>
<tr><td colspan="2">
<p>
Adds or gets the pair value.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="EOF"></span><code>property <strong>EOF</strong>: Boolean read IsEOF;</code></td>
</tr>
<tr><td colspan="2">
<p>
Indicates the end of map.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Empty"></span><code>property <strong>Empty</strong>: Boolean read <a href="BrookStringMap.TBrookStringMap.html#IsEmpty">IsEmpty</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Indicates if the map is <code>empty</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="ClearOnDestroy"></span><code>property <strong>ClearOnDestroy</strong>: Boolean read FClearOnDestroy write FClearOnDestroy;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clears the list on <a class="normal" href="BrookStringMap.TBrookStringMap.html#Destroy">destroy</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="OnChange"></span><code>property <strong>OnChange</strong>: <a href="BrookStringMap.html#TBrookStringMapChangeEvent">TBrookStringMapChangeEvent</a> read FOnChange write FOnChange;</code></td>
</tr>
<tr><td colspan="2">
<p>
Notifies a change in the map.</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>