summaryrefslogtreecommitdiff
path: root/sigalatvision/doc/html/classTFileList.html
blob: 3e7a5147062e648224b7ae71c9f1efb7a976ea9a (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
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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
<!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>TFileList 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>TFileList  Class Reference</h1>Implements a sorted two-column list box of file names; you can select a file name by mouse or keyboard cursor actions. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="stddlg_8h-source.html">stddlg.h</a>&gt;</code>
<p>
<p>Inheritance diagram for TFileList::
<p><center><img src="classTFileList.gif" usemap="#TFileList_map" border="0"></center>
<map name="TFileList_map">
<area href="classTSortedListBox.html" alt="TSortedListBox" shape="rect" coords="53,224,149,248">
<area href="classTListBox.html" alt="TListBox" shape="rect" coords="53,168,149,192">
<area href="classTListViewer.html" alt="TListViewer" shape="rect" coords="53,112,149,136">
<area href="classTView.html" alt="TView" shape="rect" coords="53,56,149,80">
<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,96,24">
<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="106,0,202,24">
</map>
<a href="classTFileList-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="classTFileList.html#a0">TFileList</a> (const <a class="el" href="classTRect.html">TRect</a> &amp;bounds, <a class="el" href="classTScrollBar.html">TScrollBar</a> *aScrollBar)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a1">~TFileList</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a2">focusItem</a> (short item)</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a3">selectItem</a> (short item)</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a4">getText</a> (char *dest, short item, short maxLen)</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a5">newList</a> (<a class="el" href="classTFileCollection.html">TFileCollection</a> *aList)</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a6">readDirectory</a> (const char *dir, const char *wildCard)</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a7">readDirectory</a> (const char *wildCard)</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a0">ushort</a>&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a8">dataSize</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a9">getData</a> (void *rec)</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a10">setData</a> (void *rec)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classTFileCollection.html">TFileCollection</a>*&nbsp;</td><td valign=bottom><a class="el" href="classTFileList.html#a11">list</a> ()</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="classTFileList.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="classTFileList.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="classTFileList.html#b0">TFileList</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
TFileList implements a sorted two-column list box of file names (held in a <a class="el" href="classTFileCollection.html">TFileCollection</a> object). You can select (highlight) a file name by mouse or keyboard cursor actions.
<p>
TFileList inherits most of its functionality from <a class="el" href="classTSortedListBox.html">TSortedListBox</a>. The following commands are broadcast by TFileList:
<p>
<pre>
 Constant            Value Meaning

 cmFileFocused       102   A new file was focused in object
 cmFileDoubleClicked 103   A file was selected in the TFileList object
 </pre> 
<p>

<p>
Definition at line <a class="el" href="stddlg_8h-source.html#l00491">491</a> of file <a class="el" href="stddlg_8h-source.html">stddlg.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="TFileList::TFileList"></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> 
TFileList::TFileList (
          </b></td>
          <td valign="bottom"><b>
const <a class="el" href="classTRect.html">TRect</a> &amp; <em>bounds</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
<a class="el" href="classTScrollBar.html">TScrollBar</a> * <em>aScrollBar</em>&nbsp;)
          </b></td>
        </tr>

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

<p>
Calls the <a class="el" href="classTSortedListBox.html">TSortedListBox</a> constructor to create a two-column TFileList object with the given bounds and, if `aScrollBar' is non-zero, a vertical scrollbar. <dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="classTSortedListBox.html#a0">TSortedListBox::TSortedListBox</a> </dl>    </td>
  </tr>
</table>
<a name="a1" doxytag="TFileList::~TFileList"></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> 
TFileList::~TFileList (
          </b></td>
          <td valign="bottom"><b>
)
          </b></td>
        </tr>

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

<p>
Deletes the file list.     </td>
  </tr>
</table>
<a name="b0" doxytag="TFileList::TFileList"></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> 
TFileList::TFileList (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>&nbsp;)<code> [inline, protected]</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="stddlg_8h-source.html#l00575">575</a> of file <a class="el" href="stddlg_8h-source.html">stddlg.h</a>.    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="d0" doxytag="TFileList::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> * TFileList::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="classTSortedListBox.html#d0">TSortedListBox</a>.    </td>
  </tr>
</table>
<a name="a8" doxytag="TFileList::dataSize"></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#a0">ushort</a> TFileList::dataSize (
          </b></td>
          <td valign="bottom"><b>
)<code> [virtual]</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="classTListBox.html#a2">TListBox</a>.    </td>
  </tr>
</table>
<a name="a2" doxytag="TFileList::focusItem"></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> 
void TFileList::focusItem (
          </b></td>
          <td valign="bottom"><b>
short <em>item</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>
Focuses the given item in the list. Calls <a class="el" href="classTListViewer.html#a3">TSortedListBox::focusItem</a>() and broadcasts a cmFileFocused event. 
<p>
Reimplemented from <a class="el" href="classTListViewer.html#a3">TListViewer</a>.    </td>
  </tr>
</table>
<a name="a9" doxytag="TFileList::getData"></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> 
void TFileList::getData (
          </b></td>
          <td valign="bottom"><b>
void * <em>rec</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>
Undocumented. 
<p>
Reimplemented from <a class="el" href="classTListBox.html#a3">TListBox</a>.    </td>
  </tr>
</table>
<a name="a4" doxytag="TFileList::getText"></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> 
void TFileList::getText (
          </b></td>
          <td valign="bottom"><b>
char * <em>dest</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
short <em>item</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
short <em>maxLen</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>
Grabs the <a class="el" href="structTSearchRec.html">TSearchRec</a> object at `item' and sets the file name in `dest'. "\" is appended if the name is a directory. 
<p>
Reimplemented from <a class="el" href="classTListBox.html#a4">TListBox</a>.    </td>
  </tr>
</table>
<a name="a11" doxytag="TFileList::list"></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="classTFileCollection.html">TFileCollection</a> * TFileList::list (
          </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>
Returns the private <a class="el" href="classTListBox.html#n0">items</a> data member, a pointer to the <a class="el" href="classTFileCollection.html">TFileCollection</a> object currently associated with this file list box. 
<p>
Reimplemented from <a class="el" href="classTSortedListBox.html#a4">TSortedListBox</a>.
<p>
Definition at line <a class="el" href="stddlg_8h-source.html#l00614">614</a> of file <a class="el" href="stddlg_8h-source.html">stddlg.h</a>.    </td>
  </tr>
</table>
<a name="a5" doxytag="TFileList::newList"></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> 
void TFileList::newList (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="classTFileCollection.html">TFileCollection</a> * <em>f</em>&nbsp;)<code> [inline]</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="classTSortedListBox.html#a2">TSortedListBox::newList</a>() to delete the existing <a class="el" href="classTFileCollection.html">TFileCollection</a> object associated with this list box and replace it with the file collection given by `aList'.
<p>
The first item of the new collection will receive the focus. 
<p>
Definition at line <a class="el" href="stddlg_8h-source.html#l00609">609</a> of file <a class="el" href="stddlg_8h-source.html">stddlg.h</a>.    </td>
  </tr>
</table>
<a name="a7" doxytag="TFileList::readDirectory"></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> 
void TFileList::readDirectory (
          </b></td>
          <td valign="bottom"><b>
const char * <em>wildCard</em>&nbsp;)
          </b></td>
        </tr>

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

<p>
Expands the `wildCard' string to generate the file collection associated with this file list. The resulting <a class="el" href="classTFileCollection.html">TFileCollection</a> object (a sorted set of <a class="el" href="structTSearchRec.html">TSearchRec</a> objects) is assigned to the private <a class="el" href="classTListBox.html#n0">items</a> data member (accessible via the <a class="el" href="classTFileList.html#a11">list</a>() member function).
<p>
If too many files are generated, a warning message box appears. <a class="el" href="classTFileList.html#a6">readDirectory</a>() knows about file attributes and will not generate hidden file names.     </td>
  </tr>
</table>
<a name="a6" doxytag="TFileList::readDirectory"></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> 
void TFileList::readDirectory (
          </b></td>
          <td valign="bottom"><b>
const char * <em>dir</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
const char * <em>wildCard</em>&nbsp;)
          </b></td>
        </tr>

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

<p>
Allows the separate submission of a relative or absolute path in the `dir' argument. Either "/" or "\" can be used as subdirectory separators (but "\" is converted to "/" for output).     </td>
  </tr>
</table>
<a name="a3" doxytag="TFileList::selectItem"></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> 
void TFileList::selectItem (
          </b></td>
          <td valign="bottom"><b>
short <em>item</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>
Undocumented. 
<p>
Reimplemented from <a class="el" href="classTListViewer.html#a8">TListViewer</a>.    </td>
  </tr>
</table>
<a name="a10" doxytag="TFileList::setData"></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> 
void TFileList::setData (
          </b></td>
          <td valign="bottom"><b>
void * <em>rec</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>
Undocumented. 
<p>
Reimplemented from <a class="el" href="classTListBox.html#a6">TListBox</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="TFileList::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 TFileList::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="classTSortedListBox.html#p0">TSortedListBox</a>.
<p>
Definition at line <a class="el" href="stddlg_8h-source.html#l00580">580</a> of file <a class="el" href="stddlg_8h-source.html">stddlg.h</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="stddlg_8h-source.html">stddlg.h</a></ul>
<hr><address><small>Generated at Sat Sep 22 20:19:25 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>