File: shellctrls.xml

package info (click to toggle)
lazarus 2.2.6%2Bdfsg2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 219,980 kB
  • sloc: pascal: 1,944,919; xml: 357,634; makefile: 270,608; cpp: 57,115; sh: 3,249; java: 609; perl: 297; sql: 222; ansic: 137
file content (1741 lines) | stat: -rw-r--r-- 95,585 bytes parent folder | download
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
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="lcl">
    <!--
    ====================================================================
      ShellCtrls
    ====================================================================
    -->
    <module name="ShellCtrls">
    <short>Contains controls which display files and directories.</short>
    <descr>
      <p>
        <file>shellctrls.pas</file> contains tree view and list view controls used to access files and directories on the local file system. The following components are added to the Lazarus IDE component palette:
      </p>
      <p>
        <b>Misc</b> Tab
      </p>
      <ul>
        <li>TShellTreeView</li>
        <li>TShellListView</li>
      </ul>
    </descr>

      <!-- unresolved references -->
      <element name="Classes"/>
      <element name="SysUtils"/>
      <element name="Laz_AVL_Tree"/>
      <element name="Forms"/>
      <element name="Graphics"/>
      <element name="ComCtrls"/>
      <element name="LCLProc"/>
      <element name="LCLType"/>
      <element name="LCLStrConsts"/>
      <element name="Types"/>
      <element name="FileUtil"/>
      <element name="LazFileUtils"/>
      <element name="LazUTF8"/>
      <element name="Masks"/>

      <element name="TObjectType">
        <short>Indicates which objects should be visible in a Shell control.</short>
        <descr>
          <p>
            <var>TObjectType</var> is an enumerated type with values that indicate which file system objects are visible in a Shell control. Values from the enumeration are stored in the <var>TObjectTypes</var> set type.
          </p>
        </descr>
        <seealso>
          <link id="TObjectTypes"/>
          <link id="TCustomShellTreeView.ObjectTypes"/>
          <link id="TCustomShellListView.ObjectTypes"/>
        </seealso>
      </element>
      <element name="TObjectType.otFolders">
        <short>
          Indicates that folders (directories) should be visible. This includes folders which represent virtual objects such as disk devices. Hidden folders are shown only if otHidden is also present.
        </short>
      </element>
      <element name="TObjectType.otNonFolders">
        <short>
          Indicates that non-folder objects should be shown, which are usually files. Hidden files will be shown if otHidden is also present.
        </short>
      </element>
      <element name="TObjectType.otHidden">
        <short>
          Indicates that hidden objects should be shown. This value is meaningful when used along with one of the other values.
        </short>
      </element>

      <element name="TObjectTypes">
        <short>
          Set type with values that indicate the visible objects in a Shell control.
        </short>
        <descr></descr>
        <seealso>
          <link id="TObjectType"/>
          <link id="TCustomShellTreeView.ObjectTypes"/>
          <link id="TCustomShellListView.ObjectTypes"/>
        </seealso>
      </element>

      <element name="TFileSortType">
        <short>Represents sorting options for the items in a shell control.</short>
        <descr>
          <p>
            <var>TFileSortType</var> is an enumerated type with values that control the sort order for the items in a shell control. TFileSortType is the type used to implement the <var>TCustomShellTreeView.FileSortType</var> property.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.FileSortType"/>
        </seealso>
      </element>
      <element name="TFileSortType.fstNone">
        <short>
          No special sorting is done; items will appear in the order provided by the file system.
        </short>
      </element>
      <element name="TFileSortType.fstAlphabet">
        <short>Items are sorted alphabetically with folders and files mixed.</short>
      </element>
      <element name="TFileSortType.fstFoldersFirst">
        <short>
          Items are sorted alphabetically with folders placed at the beginning of the list.
        </short>
      </element>

      <element name="TMaskCaseSensitivity">
        <short>Represents case sensitivity options for file masks.</short>
        <descr>
          <p>
            <var>TMaskCaseSensitivity</var> is an enumeration type with values that represent case sensitivity options for the platform or OS where shell controls are implemented. TMaskCaseSensitivity is the type used for the <var>MaskCaseSensitivity</var> property in <var>TCustomShellListView</var>. It is also passed as an argument to methods in <var>TCustomShellTreeView</var>.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.MaskCaseSensitivity"/>
        </seealso>
      </element>
      <element name="TMaskCaseSensitivity.mcsPlatformDefault">
        <short>File masks used the default for the platform or OS.</short>
      </element>
      <element name="TMaskCaseSensitivity.mcsCaseInsensitive">
        <short>File masks are case insensitive.</short>
      </element>
      <element name="TMaskCaseSensitivity.mcsCaseSensitive">
        <short>File masks are case sensitive.</short>
      </element>

      <element name="TAddItemEvent">
        <short>
          Specifies an event handler signalled when an item is added to a shell control.
        </short>
        <descr>
          <p>
            <var>TAddItemEvent</var> specifies an event handler signalled when an item is added to a shell control. TAddItemEvent is the type used to implement the <var>OnAddItem</var> event handler in <var>TCustomShellListView</var> and <var>TCustomShellTreeView</var>.
          </p>
          <p>
            Applications must implement and assign an object procedure using the signature for the event to respond to the notification. The <var>Sender</var> argument must be cast to the correct class type to access properties and method in the control. Set the value in the <var>CanAdd</var> variable parameter to <b>False</b> to prevent the item from being added in the calling procedure.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.OnAddItem"/>
          <link id="TCustomShellTreeView.OnAddItem"/>
        </seealso>
      </element>
      <element name="TAddItemEvent.Sender">
        <short>Object (control) generating the event notification.</short>
      </element>
      <element name="TAddItemEvent.ABasePath">
        <short>Base path for the item added to the shell control.</short>
      </element>
      <element name="TAddItemEvent.AFileInfo">
        <short>Search record with information for the item added to the shell control.</short>
      </element>
      <element name="TAddItemEvent.CanAdd">
        <short>True if the item can be added.</short>
      </element>

      <element name="TCustomShellTreeView">
        <short>
          The base class for a tree view control used to display files, directories and other objects (such as devices) from the local file system.
        </short>
        <descr>
          <p>
            <var>TCustomShellTreeView</var> is a <var>TCustomTreeView</var> descendant that defines the base class used to display files, directories, and other objects (such as devices) from the local file system. TCustomShellTreeView provides a hierarchical tree view for the file system objects, and is used to navigate between items in the control.
          </p>
          <p>
            TCustomShellTreeView extends the ancestor class with properties, methods, and events needed to access, maintain, and navigate file system objects in the tree. Applications should not create instances of TCustomShellTreeView; use the <var>TShellTreeView</var> class instead.
          </p>
        </descr>
        <seealso>
          <link id="TShellTreeView"/>
          <link id="#lcl.comctrls.TCustomTreeView">TCustomTreeView</link>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.FObjectTypes"/>
      <element name="TCustomShellTreeView.FRoot"/>
      <element name="TCustomShellTreeView.FShellListView"/>
      <element name="TCustomShellTreeView.FFileSortType"/>
      <element name="TCustomShellTreeView.FInitialRoot"/>
      <element name="TCustomShellTreeView.FUseBuiltinIcons"/>
      <element name="TCustomShellTreeView.FOnAddItem"/>

      <element name="TCustomShellTreeView.GetPath">
        <short>Gets the value for the Path property.</short>
        <descr></descr>
        <seealso>
          <link id="TCustomShellTreeView.Path"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.GetPath.Result">
        <short>Value for the property.</short>
      </element>

      <element name="TCustomShellTreeView.SetFileSortType">
        <short>Sets the value for the FileSortType property.</short>
        <descr></descr>
        <seealso>
          <link id="TShellTreeView.FileSortType"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.SetFileSortType.AValue">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellTreeView.SetObjectTypes">
        <short>Sets the value for the ObjectTypes property.</short>
        <descr></descr>
        <seealso>
          <link id="TCustomShellTreeView.ObjectTypes"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.SetObjectTypes.AValue">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellTreeView.SetPath">
        <short>Sets the value for the Path property.</short>
        <descr></descr>
        <seealso>
          <link id="TCustomShellTreeView.Path"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.SetPath.AValue">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellTreeView.SetRoot">
        <short>Sets the value for the Root property.</short>
        <descr></descr>
        <seealso>
          <link id="TCustomShellTreeView.Root"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.SetRoot.AValue">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellTreeView.SetShellListView">
        <short>Sets the value for the ShellListView property.</short>
        <descr></descr>
        <seealso>
          <link id="TCustomShellTreeView.ShellListView"/>
          <link id="TCustomShellListView"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.SetShellListView.Value">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellTreeView.SetUseBuiltinIcons">
        <short>Sets the value for the UseBuiltinIcons property.</short>
        <descr/>
        <seealso>
          <link id="TCustomShellTreeView.UseBuiltinIcons"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.SetUseBuiltinIcons.AValue">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellTreeView.DoCreateNodeClass">
        <short>Performs actions needed to create a new tree node in the shell control.</short>
        <descr>
          <p>
            <var>DoCreateNodeClass</var> is an overridden method used to perform actions needed to create a new tree node in the Items for the shell control. DoCreateNodeClass sets <var>NewNodeClass</var> to the <var>TShellTreeNode</var> class type used in <var>TCustomShellTreeView</var>. DoCreateNodeClass calls the inherited method using NewNodeClass as an argument.
          </p>
        </descr>
        <seealso>
          <link id="TShellTreeNode"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.DoCreateNodeClass.NewNodeClass">
        <short>Class reference used to create tree nodes in the shell control.</short>
      </element>

      <element name="TCustomShellTreeView.Loaded">
        <short>Performs actions needed when LCL component streaming has been completed.</short>
        <descr>
          <p>
            <var>Loaded</var> is an overridden procedure used to perform actions needed when LCL component streaming has been completed. In <var>TCustomShellTreeView</var>, this includes calling the inherited method and setting the initial value for the root directory. If the initial root directory was assigned at design-time, <var>PopulateWithBaseFiles</var> is called to load files in the shell control.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.Root"/>
          <link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.CreateNode">
        <short>Creates a new tree node for the shell control.</short>
        <descr>
          <p>
            <var>CreateNode</var> is an overridden method used to create an new <var>TTreeNode</var>  instance for the shell control. CreateNode calls the inherited method to create the class instance used as the return value for the method.
          </p>
          <p>
            CreateNode ensures that the tree node is a <var>TShellTreeNode</var> class instance; the class type can be overridden in the <var>OnCreateNodeClass</var> event handler. If the new tree node is not derived from <var>TShellTreeNode</var>, an <var>EShellCtrl</var> exception is raised to indicate the invalid node type.
          </p>
        </descr>
        <errors>
          Raises an <var>EShellCtrl</var> exception if the new tree node is not derived from <var>TShellTreeNode</var>.
        </errors>
        <seealso>
          <link id="TShellTreeNode"/>
          <link id="EShellCtrl"/>
          <link id="#lcl.comctrls.TTreeNodeClass">TTreeNodeClass</link>
          <link id="#lcl.comctrls.TCustomTreeView.OnCreateNodeClass">TCustomTreeView.OnCreateNodeClass</link>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.CreateNode.Result">
        <short>New tree node created in the method.</short>
      </element>

      <element name="TCustomShellTreeView.PopulateTreeNodeWithFiles">
        <short>
          Adds tree nodes for file system objects found starting at the specified node / path.
        </short>
        <descr>
          <p>
            <var>PopulateTreeNodeWithFiles</var> is a <var>Boolean</var> function used to fill the <var>Items</var> property with the file system objects for a given tree node. <var>ANode</var> contains the initial tree node examined in the method. <var>ANodePath</var> contains the path on the local file system to the tree node in <var>ANode</var>. The return value is <b>True</b> if at least one node was added to Items in the method.
          </p>
          <p>
            No actions are performed in the method at design-time, and the return value is set to <b>False</b>.
          </p>
          <p>
            <var>PopulateTreeNodeWithFiles</var> fills a list with <var>TFileItem</var> instances for file system objects matching the <var>ObjectTypes</var> for the shell control. <var>DoAddItem</var> is called for each <var>TFileItem</var> instance, which signals the <var>OnAddItem</var> event handler (when assigned). The event handler is used to selectively filter file system objects added to the <var>Items</var> in the control. If the <var>TAddItemEvent</var> handler sets its <var>CanAdd</var> argument to <b>False</b>, the file system object is not added to Items.
          </p>
          <p>
            On exit, Items contains the <var>TShellTreeNode</var> instances where ANode is the parent. If an entry is a directory which has sub-directories, its <var>HasChildren</var> property is set to <b>True</b>.
          </p>
          <p>
            <var>PopulateTreeNodeWithFiles</var> is used in the implementation of the <var>PopulateWithBaseFiles</var> and <var>CanExpand</var> methods in <var>TCustomShellTreeView</var>.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.ObjectTypes"/>
          <link id="TCustomShellTreeView.Items"/>
          <link id="TCustomShellTreeView.DoAddItem"/>
          <link id="TCustomShellTreeView.CanExpand"/>
          <link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
          <link id="TShellTreeNode"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.PopulateTreeNodeWithFiles.Result">
        <short>Returns True if at least one item was added to the shell control.</short>
      </element>
      <element name="TCustomShellTreeView.PopulateTreeNodeWithFiles.ANode">
        <short>Initial tree node used when filling the Items for the shell control.</short>
      </element>
      <element name="TCustomShellTreeView.PopulateTreeNodeWithFiles.ANodePath">
        <short>Path to the initial tree node used in the method.</short>
      </element>

      <element name="TCustomShellTreeView.DoSelectionChanged">
        <short>Performs actions needed when a new item is selected in the shell control.</short>
        <descr>
          <p>
            <var>DoSelectionChanged</var> is an overridden method used to perform actions needed when a new item is selected in the shell control. DoSelectionChanged calls the inherited DoSelectionChanged method, and ensures that a <var>TCustomShellListView</var> control assigned to <var>ShellListView</var> is synchronized to the current selection in the class.
          </p>
          <p>
            No actions are performed in the method if values for either <var>ShellListView</var> or <var>Selected</var> have not been assigned (contain <b>Nil</b>).
          </p>
          <p>
            <var>Selected</var> contains the current tree node selected in the shell control, and is used to determine if the selection is a file, directory, or other device. When it is a directory, its path is assigned to the <var>Root</var> property in <var>ShellListView</var>.
          </p>
          <p>
            If <var>Selected</var> does not represent a directory, the path refers to a file name that must exist on the local file system. An <var>EShellCtrl</var> exception is raised if the selected item does not exist. If <var>Selected</var> has a parent tree node, its path is assigned to the <var>Root</var> property in  <var>ShellListView</var>. If no parent is available, the <var>Root</var> property in <var>ShellListView</var> is set to an empty string (<b>''</b>).
          </p>
        </descr>
        <errors>
          Raises an <var>EShellCtrl</var> exception if Selected refers to a file name that no longer exists on the local file system.
        </errors>
        <seealso>
          <link id="TCustomShellTreeView.ShellListView"/>
          <link id="TCustomShellListView"/>
          <link id="TCustomShellListView.Root"/>
          <link id="TShellTreeNode"/>
          <link id="EShellCtrl"/>
          <link id="#lcl.comctrls.TCustomTreeView.Selected">TCustomTreeView.Selected</link>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.DoAddItem">
        <short>Performs actions needed to add a new tree node to the shell control.</short>
        <descr>
          <p>
            <var>DoAddItem</var> is a procedure used to perform actions needed when a new tree node is added to the shell control. DoAddItem signals the <var>OnAddItem</var> event handler (when assigned) to examine and process the arguments passed to the method.
          </p>
          <p>
            <var>ABasePath</var> contains the path on the local file system where the file system object exists.
          </p>
          <p>
            <var>AFileInfo</var> is a <var>TSearchRec</var> instance with the details for the file system object.
          </p>
          <p>
            <var>CanAdd</var> is a variable Boolean parameter used to indicate if the new tree node can be added to the shell control.
          </p>
          <p>
            No actions are performed in the method when <var>OnAddItem</var> has not been assigned (contains <b>Nil</b>). Applications must implement and assign an object procedure to the event handler which responds to the event notification.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.OnAddItem"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.DoAddItem.ABasePath">
        <short>Base path for the new tree node.</short>
      </element>
      <element name="TCustomShellTreeView.DoAddItem.AFileInfo">
        <short>TSearchRec with information about the file system object.</short>
      </element>
      <element name="TCustomShellTreeView.DoAddItem.CanAdd">
        <short>Indicates if the tree node can be added for the specified path.</short>
      </element>

      <element name="TCustomShellTreeView.CanExpand">
        <short>
          Determines if the specified tree node can be expanded in the shell control.
        </short>
        <descr>
          <p>
            <var>CanExpand</var> is an overridden <var>Boolean</var> function used to determine if the specified tree node can be expanded in the shell control. <var>Node</var> contains the <var>TTreeNode</var> examined in the method.
          </p>
          <p>
            CanExpand calls the inherited method to signal the OnExpanding event handler (when assigned). No additional actions are performed if the inherited method returns <b>False</b>.
          </p>
          <p>
            <var>CanExpand</var> temporarily disables the <var>AutoExpand</var> functionality in the shell control, and removes all child tree nodes in <var>Node</var>. The child nodes are re-created using the <var>PopulateTreeNodeWithFiles</var> method. This ensures that the shell control reflects the current content in the local file system during execution of the method. The value in <var>AutoExpand</var> is restored to its original value prior to exiting from the method.
          </p>
          <p>
            The entire update process is done in a BeginUpdate  / EndUpdate block to reduce the number of screen refreshes in the method.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.PopulateTreeNodeWithFiles"/>
          <link id="TShellTreeView.AutoExpand"/>
          <link id="TShellTreeNode"/>
          <link id="TTreeNode"/>
          <link id="#lcl.comctrls.TCustomTreeView.AutoExpand">TCustomTreeView.AutoExpand</link>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.CanExpand.Result">
        <short>True when the tree node contains child nodes and be expanded.</short>
      </element>
      <element name="TCustomShellTreeView.CanExpand.Node">
        <short>Tree node examined in the method.</short>
      </element>

      <element name="TCustomShellTreeView.DrawBuiltInIcon">
        <short>Draws the Shell Icon for the specified tree node.</short>
        <descr>
          <p>
            <var>DrawBuiltInIcon</var> is an overridden <var>TSize</var> function used draw an icon in the tree using the Shell icon for the file name in <var>ANode</var>. It re-implements the method in the <var>TCustomTreeView</var> ancestor, and does <b>not</b> call the inherited method.
          </p>
          <p>
            When <var>UseBuiltinIcons</var> is <b>True</b>, the internal <var>GetShellIcon</var> routine is called to get the icon used for the file. The icon is drawn on the control <var>Canvas</var> using the rectangle in <var>ARect</var>. The icon is centered vertically in the specified rectangle.
          </p>
          <p>
            The return value contains the dimensions for the icon as a <var>TSize</var> instance. When UseBuiltinIcons is <b>False</b>, the return value always contains a TSize instance with both the <var>Width</var> (<var>CX</var>) and <var>Height</var> (<var>CY</var>)  are set to <b>0</b> (<b>zero</b>).
          </p>
          <remark>
            DrawBuiltInIcon is defined for the Windows platform only; it requires use of the <var>SHGetFileInfoW</var> routine in the FPC <file>ShellApi.pp</file> unit.
          </remark>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.UseBuiltinIcons"/>
          <link id="TCustomShellTreeView.GetBuiltinIconSize"/>
          <link id="#lcl.comctrls.TCustomTreeView.DrawBuiltinIcon">TCustomTreeView.DrawBuiltinIcon</link>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.DrawBuiltInIcon.Result">
        <short>TSize instance with the dimension for the icon.</short>
      </element>
      <element name="TCustomShellTreeView.DrawBuiltInIcon.ANode">
        <short>Tree node with the name for the file system entry.</short>
      </element>
      <element name="TCustomShellTreeView.DrawBuiltInIcon.ARect">
        <short>Rectangle where the icon is drawn.</short>
      </element>

      <element name="TCustomShellTreeView.GetBuiltinIconSize">
        <short>Gets the size for a shell icon used in the control.</short>
        <descr>
          <p>
            <var>GetBuiltinIconSize</var> is an overridden <var>TSize</var> function used to get the dimensions for a shell icon displayed for a file system entry in the control. GetBuiltinIconSize re-implements the method from the <var>TCustomTreeView</var> ancestor, and does <b>not</b> call the inherited method.
          </p>
          <p>
            The return value is a <var>TSize</var> instance with the <var>Width</var> (<var>CX</var>) and <var>Height</var> (<var>CY</var>) for the shell icon.
          </p>
          <p>
            When <var>UseBuiltinIcons</var> is <b>True</b>, the internal member used for the icon size is checked. It is used when explicit values have been set for the Width and Height in the TSize instance. If the default values (0) are in Width and Height, the internal GetShellIcon routine is called to get the icon size used for Drive letter designations. It is assigned as the return value for the method, and stored in the internal member.
          </p>
          <p>
            When UseBuiltinIcons is <b>False</b>, the return value always contains a TSize instance with both the <var>Width</var> (<var>CX</var>) and <var>Height</var> (<var>CY</var>)  are set to <b>0</b> (<b>zero</b>).
          </p>
          <remark>
            GetBuiltinIconSize is defined for the Windows platform only; it requires use of the <var>SHGetFileInfoW</var> routine in the FPC <file>ShellApi.pp</file> unit.
          </remark>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.UseBuiltinIcons"/>
          <link id="#lcl.comctrls.TCustomTreeView.DrawBuiltinIcon">TCustomTreeView.GetBuiltinIconSize</link>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.GetBuiltinIconSize.Result">
        <short>TSize instance with the dimensions for the shell icon.</short>
      </element>

      <element name="TCustomShellTreeView.Create">
        <short>Constructor for the class instance.</short>
        <descr>
          <p>
            <var>Create</var> is the constructor for the class instance.  Create calls the inherited method using the value in <var>AOwner</var> as the owner for the class instance. Create initializes an internal member used to monitor the <var>Root</var> property for changes to its value. Create sets the value in <var>ObjectTypes</var> to display folders.
          </p>
          <p>
            Please note: Design-time values in the <var>Items</var> property are populated when the <var>Loaded</var> method is called during component streaming.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.Root"/>
          <link id="TCustomShellTreeView.ObjectTypes"/>
          <link id="TCustomShellTreeView.Items"/>
          <link id="TCustomShellTreeView.ShellListView"/>
          <link id="TCustomShellTreeView.Loaded"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.Create.AOwner">
        <short>Component that owns the class instance.</short>
      </element>

      <element name="TCustomShellTreeView.Destroy">
        <short>Destructor for the class instance.</short>
        <descr>
          <p>
            <var>Destroy</var> is the destructor for the class instance. Destroy ensures that the <var>ShellListView</var> is set to <b>Nil</b> prior to calling the inherited destructor.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.ShellListView"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.GetBasePath">
        <short>
          Returns the initial path in the file system hierarchy for the platform.
        </short>
        <descr>
          <p>
            <var>GetBasePath</var> is a <var>String</var> class function used to get the notation for the initial path in the file system hierarchy. The return value contains the following values for the supported platforms:
          </p>
          <dl>
            <dt>Windows platforms (other than Windows CE)</dt>
            <dd>'' (empty string)</dd>
            <dt>Windows CE</dt>
            <dd>'\'</dd>
            <dt>UNIX-like operating systems</dt>
            <dd>'/'</dd>
            <dt>Amiga</dt>
            <dd>'' (empty string)</dd>
          </dl>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.Root"/>
          <link id="TCustomShellTreeView.GetRootPath"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.GetRootPath">
        <short>
          Returns the effective root value, returning the value of GetBasePath() of Root is empty or the Root property value otherwise.
        </short>
        <descr/>
        <errors>
        </errors>
        <seealso>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.GetPathFromNode">
          <short>
            Returns the path (including the file name) from the file system that a particular node represents.
        </short>
          <descr></descr>
          <seealso></seealso>
      </element>

      <element name="TCustomShellTreeView.PopulateWithBaseFiles">
        <short>Fills the tree view when the Root directory is empty.</short>
        <descr>
          <remark>
            The implementation of PopulateWithBaseFiles is platform-specific.
          </remark>
          <p>
            For Windows platforms other than Windows CE, the tree view is filled with <var>TShellTreeNode</var> entries for the logical drive names found on the system. The drive information is retrieved using the <var>GetLogicalDriveStrings</var> routine in the Windows API.
          </p>
          <p>
            For other platforms, which do not use drive letters, the tree view is populated with nodes for the files or directories in the base path for the control.
          </p>
          <p>
            PopulateWithBaseFiles is called from the <var>Loaded</var>, <var>SetRoot</var>, and <var>SetFileSortType</var> methods when an empty string (<b>''</b>) is assigned to the <var>Root</var> property.
          </p>
          <p>
            No actions are performed in the method at design-time, or when the component is loaded using the LCL streaming mechanism on platforms other than Windows.
          </p>
        </descr>
        <seealso></seealso>
      </element>

      <element name="TCustomShellTreeView.Refresh">
        <short>
          Updates the tree view to display file system objects starting at the specified tree node.
        </short>
        <descr>
          Used in the implementation of the SetObjectTypes method.
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.Items"/>
          <link id="TCustomShellTreeView.Root"/>
        </seealso>
      </element>
      <element name="TCustomShellTreeView.Refresh.ANode">
        <short>
          Tree node with the initial path displayed in the shell control; Nil defaults to the root directory.
        </short>
      </element>

      <element name="TCustomShellTreeView.UseBuiltinIcons">
        <short>Indicates if OS-provided icons are used for entries in the Shell control.</short>
        <descr>
          <p>
            <var>UseBuiltinIcons</var> is a <var>Boolean</var> property which indicates if OS-provided icons are used for the file system entries in the Shell control.
          </p>
          <p>
            The default value for the property is <b>True</b>. Setting a new value for the property causes the <var>Invalidate</var> method to be called to redraw the control.
          </p>
          <p>
            UseBuiltinIcons is used in the <var>DrawBuiltinIcon</var> method, and controls whether the corresponding method is called in the widgetset class. When UseBuiltinIcons is set to <b>False</b>, an icon is not drawn in the DrawBuiltinIcon method.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.DrawBuiltinIcon"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.ObjectTypes">
        <short>
          Indicates which objects should be shown in this control (for example if it should show files and directories or only directories).
        </short>
        <descr>
        </descr>
        <seealso>
          <link id="TObjectTypes"/>
          <link id="TCustomShellListView.ObjectTypes"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.ShellListView">
        <short>
          Connects this ShellTreeView to a ShellListView.
        </short>
        <descr>
          <p>
            <var>ShellListView</var> is a <var>TCustomShellListView</var> property used to connect the tree view to a list view control.
          </p>
          <p>
            Methods and properties in the list view control can be used to change the currently selected directory, or to limit its display to specic object types. Changes to the <var>Root</var> or <var>ObjectTypes</var> properties in the list view are propogated to the associated tree view control.
          </p>
          <p>
            In a similar fashion, changes to the <var>Root</var> property or the selected item in the tree view causes the changes to be propogated to the associated list view control.
          </p>
        </descr>
        <seealso>
          <link id="TShellListView"/>
          <link id="TCustomShellListView"/>
          <link id="TCustomShellListView.ShellTreeView"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.FileSortType">
        <short>Indicates how the items should be sorted in the tree.</short>
        <descr>
          <p>
            <var>FileSortType</var> is a <var>TFileSortType</var> property used to indicate the sort order for tree nodes in the <var>Items</var> property. See <var>TFileSortType</var> for information about enumeration values and their meanings.
          </p>
          <p>
            Changing the value in <var>FileSortType</var> causes the <var>Items</var> property to be cleared, and the tree nodes to be re-created for the <var>Path</var> when <var>Root</var> has been assigned. If Root contains an empty string (<b>''</b>), the <var>PopulateWithBaseFiles</var> method is called. Otherwise, the <var>Path</var> is updated to force the control to be reloaded.
          </p>
          <p>
            No action other than setting the property value is performed in the method at design-time.
          </p>
          <p>
            The value in <var>FileSortType</var> is used in the <var>PopulateTreeNodeWithFiles</var> method and passed as an argument to the internal <var>GetFilesInDir</var> procedure.
          </p>
          <remark>
            The value in FileSortType is not used in <var>PopulateWithBaseFiles</var> on Windows platforms. The entries are logical drive letters, and are processed in the order provided by the file system.
          </remark>
        </descr>
        <seealso>
          <link id="TFileSortType"/>
          <link id="EInvalidPath"/>
          <link id="TCustomShellTreeView.Items"/>
          <link id="TCustomShellTreeView.Root"/>
          <link id="TCustomShellTreeView.Path"/>
          <link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
          <link id="TCustomShellTreeView.PopulateTreeNodeWithFiles"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.Root">
        <short>
          Indicates the directory to start showing the list of items.
        </short>
        <descr>
          <p>
            <var>Root</var> is a <var>String</var> property used to set the directory (or logical device) used to fill the list of items in the tree view control. Changing the value in Root causes the Items in the control to be re-populated.
          </p>
          <p>
            No actions are performed in the method when a new value is set for the the Root property while the component is being loaded using the LCL streaming mechanism. The actions are performed when the Loaded method is called.
          </p>
          <p>
            An empty string (<b>''</b>) indicates that the base path for the platform should be used to populate the tree view. This causes the PopulateWithBaseFiles method to be called to determine the Items displayed in the control.
          </p>
          <p>
            Setting Root to an invalid path name causes an EInvalidPath exception to be raised at run-time. The error is ignored, and an exception is not raised, at design-time to prevent crashing the Lazarus IDE.
          </p>
          <p>
            TShellTreeNode instances are created and added to the Items property using the  expanded fully qualified path name in Root.
          </p>
          <p>
            If ShellListView has been assigned for the control, its Root property is updated to match the new value for the property.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.GetBasePath"/>
          <link id="TCustomShellTreeView.Items"/>
          <link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
          <link id="TShellTreeView.ShellListView"/>
          <link id="TShellListView"/>
          <link id="TShellTreeNode"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.Path">
        <short>Path to the directory displayed in the shell control.</short>
        <descr>
          <p>
            <var>Path</var> is a <var>String</var> property which represents the path on the local file system to the Selected tree node in the  control.
          </p>
          <p>
            Reading the value for the property calls the <var>GetPathFromNode</var> method to derive the value for the property using the <var>Selected</var> tree node. The full path for the <var>TShellTreeNode</var> is used, with a path delimiter appended for a directory entry. If the path is not absolute, the base path name is prepended to the path value.
          </p>
          <p>
            Setting the value for the property causes the the new value to be resolved to a fully qualified path name when needed. A relative path is expanded into a fully qualified absolute path value resolved relative to the base path in <var>Root</var>.
          </p>
          <p>
            An <var>EInvalidPath</var> exception is raised when setting Path to a value that is not valid, including:
          </p>
          <ul>
            <li>The path does not exist on the local file system</li>
            <li>The path cannot be resolved as a directory located under the Root directory</li>
            <li>The path represents an entry not valid for the settings in ObjectTypes</li>
          </ul>
        </descr>
        <seealso></seealso>
      </element>

      <element name="TCustomShellTreeView.OnAddItem">
        <short>
          Event handler signalled when an item (tree node) is added to the shell control.
        </short>
        <descr>
          <p>
            <var>OnAddItem</var> is a <var>TAddItemEvent</var> property which contains the event handler signalled when an item (tree node) is added to the shell control. OnAddItem is signalled from the <var>PopulateTreeNodeWithFiles</var> method, and allows the base path and file information for each file to be checked before it is added to the tree view.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.PopulateTreeNodeWithFiles"/>
        </seealso>
      </element>

      <element name="TCustomShellTreeView.Items" link="#lcl.comctrls.TCustomTreeView.Items"/>

      <element name="TShellTreeView">
        <short>
          Implements a tree view control to display the files, directories and other objects (such as devices) from the local file system.
        </short>
        <descr>
          <p>
            <var>TShellTreeView</var> is a <var>TCustomShellTreeView</var> descendant that implements a tree view used to display files, directories, and other objects (such as devices) from the local file system. TShellTreeView provides a hierarchical tree view for the file system objects, and is used to navigate between items in the control.
          </p>
          <p>
            TShellTreeView sets the visibility for properties, methods, and events defined in the ancestor class.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView"/>
        </seealso>
      </element>

      <element name="TShellTreeView.Align" link="#lcl.controls.TControl.Align"/>
      <element name="TShellTreeView.Anchors" link="#lcl.controls.TControl.Anchors"/>
      <element name="TShellTreeView.AutoExpand" link="#lcl.comctrls.TCustomTreeView.AutoExpand"/>
      <element name="TShellTreeView.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
      <element name="TShellTreeView.BackgroundColor" link="#lcl.comctrls.TCustomTreeView.BackgroundColor"/>
      <element name="TShellTreeView.BorderStyle" link="#lcl.controls.TWinControl.BorderStyle"/>
      <element name="TShellTreeView.BorderWidth" link="#lcl.controls.TWinControl.BorderWidth"/>
      <element name="TShellTreeView.Color" link="#lcl.controls.TControl.Color"/>
      <element name="TShellTreeView.Constraints" link="#lcl.controls.TControl.Constraints"/>
      <element name="TShellTreeView.Enabled" link="#lcl.controls.TControl.Enabled"/>
      <element name="TShellTreeView.ExpandSignType" link="#lcl.comctrls.TCustomTreeView.ExpandSignType"/>
      <element name="TShellTreeView.Font" link="#lcl.controls.TControl.Font"/>
      <element name="TShellTreeView.FileSortType" link="#lcl.shellctrls.TCustomShellTreeView.FileSortType"/>
      <element name="TShellTreeView.HideSelection" link="#lcl.comctrls.TCustomTreeView.HideSelection"/>
      <element name="TShellTreeView.HotTrack" link="#lcl.comctrls.TCustomTreeView.HotTrack"/>
      <element name="TShellTreeView.Images" link="#lcl.comctrls.TCustomTreeView.Images"/>
      <element name="TShellTreeView.Indent" link="#lcl.comctrls.TCustomTreeView.Indent"/>
      <element name="TShellTreeView.MultiSelectStyle" link="#lcl.comctrls.TCustomTreeView.MultiSelectStyle"/>

      <element name="TShellTreeView.ParentColor">
        <short>
          Uses the Color from the Parent control, when enabled.
        </short>
        <descr>
          <p>
            ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TShellTreeView.
          </p>
          <p>
            When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
          </p>
        </descr>
        <seealso>
          <link id="#lcl.controls.TControl.ParentColor"/>
        </seealso>
      </element>

      <element name="TShellTreeView.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
      <element name="TShellTreeView.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
      <element name="TShellTreeView.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
      <element name="TShellTreeView.ReadOnly" link="#lcl.comctrls.TCustomTreeView.ReadOnly"/>
      <element name="TShellTreeView.RightClickSelect" link="#lcl.comctrls.TCustomTreeView.RightClickSelect"/>
      <element name="TShellTreeView.Root" link="#lcl.shellctrls.TCustomShellTreeView.Root"/>
      <element name="TShellTreeView.RowSelect" link="#lcl.comctrls.TCustomTreeView.RowSelect"/>
      <element name="TShellTreeView.ScrollBars" link="#lcl.comctrls.TCustomTreeView.ScrollBars"/>
      <element name="TShellTreeView.SelectionColor" link="#lcl.comctrls.TCustomTreeView.SelectionColor"/>
      <element name="TShellTreeView.ShowButtons" link="#lcl.comctrls.TCustomTreeView.ShowButtons"/>
      <element name="TShellTreeView.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
      <element name="TShellTreeView.ShowLines" link="#lcl.comctrls.TCustomTreeView.ShowLines"/>
      <element name="TShellTreeView.ShowRoot" link="#lcl.comctrls.TCustomTreeView.ShowRoot"/>
      <element name="TShellTreeView.StateImages" link="#lcl.comctrls.TCustomTreeView.StateImages"/>

      <element name="TShellTreeView.TabStop">
        <short>Enables navigation using the Tab key.</short>
        <descr>
          <p>
            The default value for the properly is True in TShellTreeView.
          </p>
        </descr>
        <seealso>
          <link id="#lcl.controls.TWinControl.TabStop">TWinControl.TabStop</link>
        </seealso>
      </element>

      <element name="TShellTreeView.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>

      <element name="TShellTreeView.Tag">
        <short>Tag value for the component.</short>
        <descr>
          <p>
            <var>Tag</var> can be used to store an integer value in the component. This value is streamed together with all other published properties. It can be used for instance to quickly identify a component in an event handler.
          </p>
        </descr>
        <seealso>
          <link id="#rtl.classes.TComponent">TComponent</link>
        </seealso>
      </element>

      <element name="TShellTreeView.ToolTips" link="#lcl.comctrls.TCustomTreeView.ToolTips"/>
      <element name="TShellTreeView.Visible" link="#lcl.controls.TControl.Visible"/>
      <element name="TShellTreeView.OnAddItem" link="#lcl.shellctrls.TCustomShellTreeView.OnAddItem"/>
      <element name="TShellTreeView.OnAdvancedCustomDraw" link="#lcl.comctrls.TCustomTreeView.OnAdvancedCustomDraw"/>
      <element name="TShellTreeView.OnAdvancedCustomDrawItem" link="#lcl.comctrls.TCustomTreeView.OnAdvancedCustomDrawItem"/>
      <element name="TShellTreeView.OnChange" link="#lcl.comctrls.TCustomTreeView.OnChange"/>
      <element name="TShellTreeView.OnChanging" link="#lcl.comctrls.TCustomTreeView.OnChanging"/>
      <element name="TShellTreeView.OnClick" link="#lcl.controls.TControl.OnClick"/>
      <element name="TShellTreeView.OnCollapsed" link="#lcl.comctrls.TCustomTreeView.OnCollapsed"/>
      <element name="TShellTreeView.OnCollapsing" link="#lcl.comctrls.TCustomTreeView.OnCollapsing"/>
      <element name="TShellTreeView.OnCustomDraw" link="#lcl.comctrls.TCustomTreeView.OnCustomDraw"/>
      <element name="TShellTreeView.OnCustomDrawItem" link="#lcl.comctrls.TCustomTreeView.OnCustomDrawItem"/>
      <element name="TShellTreeView.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
      <element name="TShellTreeView.OnEdited" link="#lcl.comctrls.TCustomTreeView.OnEdited"/>
      <element name="TShellTreeView.OnEditing" link="#lcl.comctrls.TCustomTreeView.OnEditing"/>
      <element name="TShellTreeView.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
      <element name="TShellTreeView.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
      <element name="TShellTreeView.OnExpanded" link="#lcl.comctrls.TCustomTreeView.OnExpanded"/>
      <element name="TShellTreeView.OnExpanding" link="#lcl.comctrls.TCustomTreeView.OnExpanding"/>
      <element name="TShellTreeView.OnGetImageIndex" link="#lcl.comctrls.TCustomTreeView.OnGetImageIndex"/>
      <element name="TShellTreeView.OnGetSelectedIndex" link="#lcl.comctrls.TCustomTreeView.OnGetSelectedIndex"/>
      <element name="TShellTreeView.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
      <element name="TShellTreeView.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
      <element name="TShellTreeView.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
      <element name="TShellTreeView.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
      <element name="TShellTreeView.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
      <element name="TShellTreeView.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
      <element name="TShellTreeView.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
      <element name="TShellTreeView.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
      <element name="TShellTreeView.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
      <element name="TShellTreeView.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
      <element name="TShellTreeView.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
      <element name="TShellTreeView.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
      <element name="TShellTreeView.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
      <element name="TShellTreeView.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
      <element name="TShellTreeView.OnSelectionChanged" link="#lcl.comctrls.TCustomTreeView.OnSelectionChanged"/>
      <element name="TShellTreeView.OnShowHint" link="#lcl.controls.TControl.OnShowHint"/>
      <element name="TShellTreeView.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
      <element name="TShellTreeView.Options" link="#lcl.comctrls.TCustomTreeView.Options"/>
      <element name="TShellTreeView.TreeLineColor" link="#lcl.comctrls.TCustomTreeView.TreeLineColor"/>
      <element name="TShellTreeView.TreeLinePenStyle" link="#lcl.comctrls.TCustomTreeView.TreeLinePenStyle"/>
      <element name="TShellTreeView.ExpandSignColor" link="#lcl.comctrls.TCustomTreeView.ExpandSignColor"/>
      <element name="TShellTreeView.ObjectTypes" link="#lcl.shellctrls.TCustomShellTreeView.ObjectTypes"/>
      <element name="TShellTreeView.ShellListView" link="#lcl.shellctrls.TCustomShellTreeView.ShellListView"/>

      <element name="TCSLVFileAddedEvent">
        <short>
          Specifies an event handler signalled when an item is added to TCustomShellListView.
        </short>
        <descr>
          <p>
            <var>TCSLVFileAddedEvent</var> specifies the interface for an event handler signalled when a <var>TListItem</var> instance is added to <var>TCustomShellListView</var>. TCSLVFileAddedEvent is the type used to implement the <var>OnAddItem</var> property in <var>TCustomShellListView</var>.
          </p>
          <p>
            Applications must implement and assign an object procedure using the event signature to respond to the notification. <var>Sender</var> must be cast to the correct class type to access properties and methods in the control for the notification. Or,  use the <var>ListView</var> property in the <var>Item</var> argument.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.OnAddItem"/>
          <link id="#lcl.comctrls.TListItem">TListItem</link>
        </seealso>
      </element>
      <element name="TCSLVFileAddedEvent.Sender">
        <short>Object (control) generating the event notification.</short>
      </element>
      <element name="TCSLVFileAddedEvent.Item">
        <short>List item for the event notification.</short>
      </element>

      <element name="TCustomShellListView">
        <short>
          The base class that defines a list view control to display the files, directories and other objects (such as devices) from the local file system.
        </short>
        <descr>
          <p>
            <var>TCustomShellListView</var> is a <var>TCustomListView</var> descendant which defines a list view control for file system objects on the local file system. <var>TCustomShellListView</var> extends the ancestor class with properties, methods, and events needed to access and maintain items in the control including:
          </p>
          <ul>
            <li>Mask</li>
            <li>MaskCaseSensitivity</li>
            <li>ObjectTypes</li>
            <li>Root</li>
            <li>ShellTreeView</li>
            <li>Items</li>
            <li>GetPathFromItem</li>
            <li>OnAddItem</li>
            <li>OnFileAdded</li>
          </ul>
          <p>
            Application should not create instance of <var>TCustomShellListView</var>; use the <var>TShellListView</var> descendant which sets the scope for members in the class.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.Mask"/>
          <link id="TCustomShellListView.MaskCaseSensitivity"/>
          <link id="TCustomShellListView.ObjectTypes"/>
          <link id="TCustomShellListView.Root"/>
          <link id="TCustomShellListView.ShellTreeView"/>
          <link id="TCustomShellListView.Items"/>
          <link id="TCustomShellListView.GetPathFromItem"/>
          <link id="TCustomShellListView.OnAddItem"/>
          <link id="TCustomShellListView.OnFileAdded"/>
          <link id="TShellListView"/>
        </seealso>
      </element>

      <element name="TCustomShellListView.FMask"/>
      <element name="TCustomShellListView.FMaskCaseSensitivity"/>
      <element name="TCustomShellListView.FObjectTypes"/>
      <element name="TCustomShellListView.FRoot"/>
      <element name="TCustomShellListView.FShellTreeView"/>
      <element name="TCustomShellListView.FUseBuiltInIcons"/>
      <element name="TCustomShellListView.FOnAddItem"/>
      <element name="TCustomShellListView.FOnFileAdded"/>

      <element name="TCustomShellListView.SetMask">
        <short>Sets the value for the Mask property.</short>
        <descr></descr>
        <seealso>
          <link id="TCustomShellListView.Mask"/>
        </seealso>
      </element>
      <element name="TCustomShellListView.SetMask.AValue">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellListView.SetMaskCaseSensitivity">
        <short>Sets the value for the MaskCaseSensitivity property.</short>
        <descr></descr>
        <seealso>
          <link id="TCustomShellListView.MaskCaseSensitivity"/>
        </seealso>
      </element>
      <element name="TCustomShellListView.SetMaskCaseSensitivity.AValue">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellListView.SetShellTreeView">
        <short>Sets the value for the ShellTreeView property.</short>
        <descr></descr>
        <seealso>
          <link id="TCustomShellListView.ShellTreeView"/>
        </seealso>
      </element>
      <element name="TCustomShellListView.SetShellTreeView.Value">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellListView.SetRoot">
        <short>Sets the value for the Root property.</short>
        <descr>
          <p>
            Calls <var>Clear</var> to remove list items in the control. Calls <var>PopulateWithRoot</var> to load file system entries in the new root directory. Raises an <var>EInvalidPath</var> exception at run-time if Value contains an invalid path name. Does <b>not</b> raise an exception at design-time to prevent crashing the IDE.
          </p>
        </descr>
        <errors>
          Raises an EInvalidPath exception at run-time if Value contains an invalid path name.
        </errors>
        <seealso>
          <link id="TCustomShellListView.Root"/>
        </seealso>
      </element>
      <element name="TCustomShellListView.SetRoot.Value">
        <short>New value for the property.</short>
      </element>

      <element name="TCustomShellListView.WSRegisterClass">
        <short>
          Registers an association between the class type and its widgetset class.
        </short>
        <descr>
          <p>
            <var>WSRegisterClass</var> is an overridden class method in <var>TCustomShellListView</var>. It registers properties that are ignored in the class instance during LCL component streaming, including:
          </p>
          <ul>
            <li>ItemIndex (Used in older LCL versions)</li>
            <li>BevelKind (Provided for Delphi compatibility)</li>
            <li>TListItem.OverlayIndex (Provided for Delphi compatibility)</li>
          </ul>
          <p>
            It calls the inherited method, and registers the companion widgetset class instance.
          </p>
        </descr>
        <seealso>
          <link id="#lcl.controls.TWinControl.WSRegisterClass">TWinControl.WSRegisterClass</link>
        </seealso>
      </element>

      <element name="TCustomShellListView.PopulateWithRoot">
        <short>Fills the list view with file system information for the root directory.</short>
        <descr>
          <p>
            <var>PopulateWithRoot</var> is a procedure used to fill the <var>Items</var> in the list view with file system entries for the <var>Root</var> directory.
          </p>
          <p>
            No actions are performed in the method at design-time, or when <var>Root</var>  contains an empty string (<b>''</b>).
          </p>
          <p>
            <var>PopulateWithRoot</var> calls the internal <var>GetFilesInDir</var> helper to get a list of file system items for the path which match the <var>Mask</var> and <var>ObjectTypes</var> specified for the control. Each of the files in the list are passed to <var>DoAddItem</var> / <var>OnAddItem</var> to determine if they can be added to the <var>Items</var> in the control.
          </p>
          <p>
            A <var>TListItem</var> instance is added to Items to represent the files or directories. The <var>Data</var> property in the list item is used to store a pointer to the file size. Values are added to <var>SubItems</var> with the string representation for the file size, and the file extension.
          </p>
          <p>
            When <var>UseBuiltInIcons</var> is set to <b>True</b>, the <var>GetBuiltInImageIndex</var> method is called to get the <var>ImageIndex</var> for the built-in icon for a list item. This action is performed using the path to the current file name when LargeImages  and/or SmallImages have not been assigned. The value in <var>ViewStyle</var> determines the image size requested. When ViewStyle is <var>vsIcon</var>, LargeImages is checked (when assigned). Otherwise, <var>SmalImages</var> is checked (when assigned). If an imagelist exists in either LargeImages or SmallImages, the existing ImageIndex in the list item is used.
          </p>
          <p>
            The <var>OnFileAdded</var> event handler is signalled (when assigned) for each new entry added to Items.
          </p>
          <p>
            The <var>Sort</var> method is called prior to exit to order the Items in the control using the option specified in the <var>FileSortType</var> property.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.Root"/>
          <link id="TCustomShellListView.Items"/>
          <link id="TCustomShellListView.Mask"/>
          <link id="TCustomShellListView.ObjectTypes"/>
          <link id="TCustomShellListView.UseBuiltInIcons"/>
          <link id="TCustomShellTreeView.FileSortType"/>
          <link id="TCustomShellListView.DoAddItem"/>
          <link id="TCustomShellListView.OnAddItem"/>
          <link id="TCustomShellListView.OnFileAdded"/>
          <link id="TAddItemEvent"/>
          <link id="TCSLVFileAddedEvent"/>
        </seealso>
      </element>

      <element name="TCustomShellListView.Resize">
        <short>Sets the size for Columns in the list view.</short>
        <descr>
          <p>
            <var>Resize</var> is a method used to set the size for <var>Columns</var> in the list view control. <var>Resize</var> calls the inherited method, and checks the <var>Columns</var> defined for the control. The <var>Width</var> property is used to determine the layout sizes applied to the columns for the control.
          </p>
          <p>
            No actions (other than calling the inherited method) are performed if fewer than 3 (three) columns are defined for the control. This is the number of columns defined in the constructor for the <var>vsReport</var> <var>ViewStyle</var>.
          </p>
          <p>
            <var>Resize</var> is used in the implementation of the <var>Create</var> constructor,  and can be called to adjust the layout for the control when the <var>Width</var> property has been changed.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.Create"/>
          <link id="#lcl.comctrls.TCustomListView.ViewStyle">TCustomListView.ViewStyle</link>
          <link id="#lcl.comctrls.TCustomListView.Columns">TCustomListView.Columns</link>
          <link id="#lcl.comctrls.TListColumns">TListColumns</link>
          <link id="#lcl.comctrls.TViewStyle">TViewStyle</link>
          <link id="#lcl.controls.TControl.Width">TControl.Width</link>
        </seealso>
      </element>

      <element name="TCustomShellListView.DoAddItem">
        <short>
          Signals the OnAddItem event handler when an entry is added to the Items in the control.
        </short>
        <descr></descr>
        <seealso></seealso>
      </element>
      <element name="TCustomShellListView.DoAddItem.ABasePath">
        <short>Base path for the list view.</short>
      </element>
      <element name="TCustomShellListView.DoAddItem.AFileInfo">
        <short>TSearchRec with the information for the new entry.</short>
      </element>
      <element name="TCustomShellListView.DoAddItem.CanAdd">
        <short>
          Set the argument to True to allow the item to be added; set to False to prevent adding the item.
        </short>
      </element>

    <element name="TCustomShellListView.GetBuiltinImageIndex">
      <short>
        Gets the index position for the built-in icon used for the specified path or file name.
        </short>
      <descr>
        <p>
          <var>GetBuiltinImageIndex</var> is an <var>Integer</var> function used to get the image index for a built-in icon provided by the operating system or platform.
        </p>
        <p>
          The return value contains the ordinal position for the image used for the file name or path specified in <var>AFilename</var>. The return value is <b>-1</b> if an image could not be selected for the value in AFileName.
        </p>
        <p>
          When <var>ALargeImage</var> is <b>True</b>, the index value refers to a large image as used in the vsIcon view style. When set to <b>False</b>, it refers to a small image as used in the other view styles.
        </p>
        <p>
          GetBuiltinImageIndex calls the GetBuiltInImageIndex method in the widgetset class to get the return value for the method. The widgetset class handles storing the built-in image to the correct image list when the handle for the image list has not already been assigned.
        </p>
        <p>
          GetBuiltinImageIndex is called from the <var>PopulateWithRoot</var> method when <var>UseBuiltInIcons</var> is set to <b>True</b>.
        </p>
        <remark>
          In the current LCL version, GetBuiltinImageIndex is implemented for the Windows platform only.
        </remark>
      </descr>
      <seealso>
        <link id="TCustomShellListView.UseBuiltInIcons"/>
        <link id="TCustomShellListView.PopulateWithRoot"/>
        <link id="#lcl.comctrls.TCustomListView.LargeImages">TCustomListView.LargeImages</link>
        <link id="#lcl.comctrls.TCustomListView.SmallImages">TCustomListView.SmallImages</link>
      </seealso>
    </element>
    <element name="TCustomShellListView.GetBuiltinImageIndex.Result">
      <short>Ordinal position for the built-in image.</short>
    </element>
    <element name="TCustomShellListView.GetBuiltinImageIndex.AFileName">
      <short>File name or path used to find the associated image.</short>
    </element>
    <element name="TCustomShellListView.GetBuiltinImageIndex.ALargeImage">
      <short>True if the large image list is used for the image.</short>
    </element>

      <element name="TCustomShellListView.OnFileAdded">
        <short>
          Event handler signalled when a file is added to the Items in the control.
        </short>
        <descr>
          <p>
            <var>OnFileAdded</var> is a <var>TCSLVFileAddedEvent</var> property representing the event handler signalled when a file is added to the <var>Items</var> in the control. Applications must implement and assign an object procedure to the event handler to respond to the event notification. See <link id="TCSLVFileAddedEvent"/> for information about the arguments passed to the event handler.
          </p>
          <p>
            <var>OnFileAdded</var> is signalled (when assigned) from the <var>PopulateWithRoot</var> method after calling <var>DoAddItem</var> and <var>OnAddItem</var>, and after the list item has been added to the <var>Items</var> property.
          </p>
        </descr>
        <seealso>
          <link id="TCSLVFileAddedEvent"/>
          <link id="TCustomShellListView.PopulateWithRoot"/>
          <link id="TCustomShellListView.DoAddItem"/>
          <link id="TCustomShellListView.OnAddItem"/>
          <link id="TCustomShellListView.Items"/>
        </seealso>
      </element>

      <element name="TCustomShellListView.Create">
        <short>Constructor for the class instance.</short>
        <descr>
          <p>
            <var>Create</var> is the overridden constructor for the class instance. <var>Create</var> calls the inherited method using <var>AOwner</var> as the owner of the class instance. <var>Create</var> sets the default values for properties in the class instance, including:
          </p>
          <dl>
            <dt>UseBuiltInIcons</dt>
            <dd>True</dd>
            <dt>ViewStyle</dt>
            <dd>vsReport view style</dd>
            <dt>ObjectTypes</dt>
            <dd>[otNonFolders]</dd>
            <dt>MaskCaseSensitivity</dt>
            <dd>mcsPlatformDefault</dd>
            <dt>Columns</dt>
            <dd>Creates three columns for File Name, File Size, and File Type</dd>
          </dl>
          <p>
            <var>Create</var> calls the <var>Resize</var> method to adjust the widths for the <var>Columns</var> defined in the method.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.ObjectTypes"/>
          <link id="TCustomShellListView.Resize"/>
          <link id="#lcl.comctrls.TCustomListView.ViewStyle">TCustomListView.ViewStyle</link>
          <link id="#lcl.comctrls.TCustomListView.Columns">TCustomListView.Columns</link>
        </seealso>
      </element>
      <element name="TCustomShellListView.Create.AOwner">
        <short>Owner for the class instance.</short>
      </element>

      <element name="TCustomShellListView.Destroy">
        <short>Destructor for the class instance.</short>
        <descr>
          <p>
            <var>Destroy</var> is the overridden destructor for the class instance. <var>Destroy</var> ensures that a control assigned to the <var>ShellTreeView</var> property is set to <b>Nil</b>. <var>Destroy</var> calls the inherited method.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.ShellTreeView"/>
        </seealso>
      </element>

      <element name="TCustomShellListView.GetPathFromItem">
        <short>Gets the path on the local file system for the specified item.</short>
        <descr>
          <p>
            <var>GetPathFromItem</var> is a <var>String</var> function used to get the path on the local file system for the list item specified in <var>ANode</var>. The return value contains the content from the <var>Root</var> property with a trailing path delimiter, joined with the <var>Caption</var> for the <var>TListItem</var> in <var>ANode</var>.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.Root"/>
          <link id="#lcl.comctrls.TListItem">TListItem</link>
        </seealso>
      </element>
      <element name="TCustomShellListView.GetPathFromItem.Result">
        <short>Complete path to the item.</short>
      </element>
      <element name="TCustomShellListView.GetPathFromItem.ANode">
      <short>List item examined in the method.</short>
      </element>

      <element name="TCustomShellListView.Mask">
        <short>File mask used to select items displayed in the shell control.</short>
        <descr>
          <p>
            <var>Mask</var> is a <var>String</var> property used to supply a mask which determines the file system objects displayed in the shell control. Mask can contain one or more mask values delimited by the Semicolon (<b>';'</b>) character. For example:
          </p>
          <code>*.exe; br*.com; c??.*</code>
          <p>
            Changing the value in Mask causes the <var>Clear</var> method to be called for the shell control. In addition, the <var>Items</var> property calls its <var>Clear</var> method to remove entries stored in the property. The <var>PopulateWithRoot</var> method is called to re-populate the shell control using the new mask value.
          </p>
          <p>
            The value in Mask is passed as an argument to the internal <var>GetFilesInDir</var> helper which gets the file system objects displayed in the List View control.
          </p>
          <p>
            Use <var>MaskCaseSensitivity</var> to specify the case sensitivity option used when matching file masks in the shell control.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.Items"/>
          <link id="TCustomShellListView.PopulateWithRoot"/>
          <link id="TCustomShellListView.MaskCaseSensitivity"/>
          <link id="#lcl.comctrls.TCustomListView.Clear">TCustomListView.Clear</link>
        </seealso>
      </element>

      <element name="TCustomShellListView.MaskCaseSensitivity">
        <short>Case Sensitivity option enabled for file masks in the shell control.</short>
        <descr>
          <p>
            <var>MaskCaseSensitivity</var> is a <var>TMaskCaseSensitivity</var> property which represents the case sensitivity option used for file masks in the shell control. The default value for the property is <var>mcsPlatformDefault</var>. See <var>TMaskCaseSensitivity</var> for a description of the enumeration values and their meanings.
          </p>
          <p>
            Changing the value in <var>MaskCaseSensitivity</var> causes the shell control to re-populate its file Items using the <var>Mask</var> for the control.
          </p>
        </descr>
        <seealso>
          <link id="TMaskCaseSensitivity"/>
          <link id="TCustomShellListView.Mask"/>
        </seealso>
      </element>

      <element name="TCustomShellListView.ObjectTypes">
        <short>
          Indicates which objects are visible in the control (files and/or directories, hidden files, etc.).
        </short>
        <descr>
        </descr>
        <seealso>
          <link id="TObjectTypes"/>
          <link id="TCustomShellTreeView.ObjectTypes"/>
        </seealso>
      </element>

      <element name="TCustomShellListView.Root">
      <short>
        Indicates the initial directory path whose objects are displayed in the control.
        </short>
      <descr>
        <p>
          The most important property of the ShellListView, indicates the directory whose contents will be shown. This property is automatically managed if the property ShellTreeView is filled. If this property is empty, nothing will be shown.
        </p>
      </descr>
      <seealso>
      </seealso>
      </element>

      <element name="TCustomShellListView.ShellTreeView">
        <short>
          Used to connect the ShellListView to a ShellTreeView.
        </short>
        <descr>
          <p>
            <var>ShellTreeView</var> is a <var>TCustomShellTreeView</var> property used to connect the list view control to a shell tree view control. ShellTreeView provides access to the currently selected device, file, or directory in the local file system.
          </p>
          <p>
            Changing the value in ShellTreeView causes the <var>Clear</var> method to be called to refresh the list view control. The path to the <var>Selected</var> item in the tree view is used as the <var>Root</var> property in the list view. The <var>PopulateWithRoot</var> method is called to fill the <var>Items</var> in the list view control.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellListView.Root"/>
          <link id="TCustomShellListView.PopulateWithRoot"/>
          <link id="TCustomShellTreeView.ShellListView"/>
          <link id="TShellTreeView"/>
          <link id="TCustomShellTreeView"/>
          <link id="#lcl.comctrls.TCustomTreeView.Selected">TCustomTreeView.Selected</link>
          <link id="#lcl.comctrls.TCustomListView.Clear">TCustomListView.Clear</link>
        </seealso>
      </element>

      <element name="TCustomShellListView.UseBuiltInIcons">
        <short>
          Indicates if icons provided by the OS or platform are used for items in the list.
        </short>
        <descr>
          <p>
            <var>UseBuiltInIcons</var> is a <var>Boolean</var> property which indicates if icons provided by the OS or platform are used for the <var>Items</var> in the list view control. The default value for the property is <b>True</b>.
          </p>
          <p>
            UseBuiltInIcons is used when the list view control is populated with the names for the file and/or directories on the local file system. When set to <b>True</b>, the <var>GetBuiltInImageIndex</var> method is called to get the image index for a <var>TListItem</var> stored in the <var>Items</var> property.
          </p>
          <p>
            Set UseBuiltInIcons to <b>False</b> to use custom images provided in the <var>LargeImages</var> or <var>SmallImages</var> properties.
          </p>
          <remark>
            UseBuiltInIcons and GetBuiltInImageIndex require support in the widgetset class to use system-provided icons. This support is currently implemented for the Windows platform only.
          </remark>
        </descr>
        <seealso>
          <link id="TCustomShellListView.GetBuiltInImageIndex"/>
          <link id="TCustomShellListView.Items"/>
          <link id="TCustomShellListView.PopulateWithRoot"/>
          <link id="TListItem.ImageIndex"/>
          <link id="#lcl.comctrls.TCustomListView.LargeImages">TCustomListView.LargeImages</link>
          <link id="#lcl.comctrls.TCustomListView.SmallImages">TCustomListView.SmallImages</link>
        </seealso>
      </element>

      <element name="TCustomShellListView.OnAddItem">
        <short>
          Event handler signalled to determine if the specified file information can be added to the Items for the list view.
        </short>
        <descr>
          <p>
            <var>OnAddItem</var> is a <var>TAddItemEvent</var> property used to implement the event handler. It is signalled to determine if the specified file can be added to the <var>Items</var> for the list view.
          </p>
          <p>
            Arguments passed to the event handler identify the base path and file information examined in the procedure. Use the <var>CanAdd</var> argument to indicate if the file information can be added in a calling routine. See <link id="TAddItemEvent"/> for more information about the event handler definition.
          </p>
          <p>
            <var>OnAddItem</var> is signalled from the <var>DoAddItem</var> method (when assigned).
          </p>
        </descr>
        <seealso>
          <link id="TAddItemEvent"/>
          <link id="TCustomShellListView.Items"/>
          <link id="TCustomShellListView.DoAddItem"/>
          <link id="TCustomShellListView.PopulateWithRoot"/>
        </seealso>
      </element>

      <element name="TCustomShellListView.Items" link="#lcl.comctrls.TCustomListView.Items"/>

      <element name="TShellListView">
        <short>
          Implements a list view control to display the files, directories and other objects (such as devices) on the local file system.
        </short>
        <descr>
          <p>
            <var>TShellListView</var> is a <var>TCustomShellListView</var> descendant which implements a list view control for file system objects on the local file system. <var>TShellListView</var> contains properties, methods, and events needed to access and maintain items in the control including:
          </p>
          <ul>
            <li>Mask</li>
            <li>MaskCaseSensitivity</li>
            <li>ObjectTypes</li>
            <li>Root</li>
            <li>ShellTreeView</li>
            <li>Items</li>
            <li>GetPathFromItem</li>
            <li>OnAddItem</li>
            <li>OnFileAdded</li>
          </ul>
        </descr>
        <seealso>
          <link id="TCustomShellListView"/>
          <link id="TCustomShellListView.Mask"/>
          <link id="TCustomShellListView.MaskCaseSensitivity"/>
          <link id="TCustomShellListView.ObjectTypes"/>
          <link id="TCustomShellListView.Root"/>
          <link id="TCustomShellListView.ShellTreeView"/>
          <link id="TCustomShellListView.Items"/>
          <link id="TCustomShellListView.GetPathFromItem"/>
          <link id="TCustomShellListView.OnAddItem"/>
          <link id="TCustomShellListView.OnFileAdded"/>
        </seealso>
      </element>

      <element name="TShellListView.Columns" link="#lcl.comctrls.TCustomListView.Columns"/>

      <element name="TShellListView.Align" link="#lcl.controls.TControl.Align"/>
      <element name="TShellListView.Anchors" link="#lcl.controls.TControl.Anchors"/>
      <element name="TShellListView.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
      <element name="TShellListView.BorderStyle" link="#lcl.comctrls.TCustomListView.BorderStyle"/>
      <element name="TShellListView.BorderWidth" link="#lcl.controls.TWinControl.BorderWidth"/>

      <element name="TShellListView.Color">
        <short>The background color for the control.</short>
        <descr>
          <p>
            The default value for the properly is clWindow in TShellListView.
          </p>
          <p>
             If Color is set to clDefault, it needs to be passed through GetDefaultColor to resolve clDefault to a TColor value. Convenience routines which obtain the color by resolving clDefault and ParentColor are also provided as TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent.
           </p>
        </descr>
        <seealso>
          <link id="#lcl.controls.TControl.Color">TControl.Color</link>
        </seealso>
      </element>

      <element name="TShellListView.Constraints" link="#lcl.controls.TControl.Constraints"/>
      <element name="TShellListView.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
      <element name="TShellListView.DragMode" link="#lcl.controls.TControl.DragMode"/>
      <element name="TShellListView.Enabled" link="#lcl.controls.TControl.Enabled"/>
      <element name="TShellListView.Font" link="#lcl.controls.TControl.Font"/>
      <element name="TShellListView.HideSelection" link="#lcl.comctrls.TCustomListView.HideSelection"/>
      <element name="TShellListView.LargeImages" link="#lcl.comctrls.TCustomListView.LargeImages"/>
      <element name="TShellListView.LargeImagesWidth" link="#lcl.comctrls.TCustomListView.LargeImagesWidth"/>
      <element name="TShellListView.Mask" link="#lcl.shellctrls.TCustomShellListView.Mask"/>
      <element name="TShellListView.MaskCaseSensitivity" link="#lcl.shellctrls.TCustomShellListView.MaskCaseSensitivity"/>
      <element name="TShellListView.MultiSelect" link="#lcl.comctrls.TCustomListView.MultiSelect"/>

      <element name="TShellListView.ParentColor">
        <short>Uses the Color from the Parent control, when enabled.</short>
        <descr>
          <p>
            ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TShellListView.
          </p>
          <p>
            When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
          </p>
          <p>
            Using ParentColor when the Color value is clDefault can cause problems in resolving the actual color value. To obtain the Color property of a control while taking into account clDefault and ParentColor, use the GetColorResolvingParent method. This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use the GetRGBColorResolvingParent method.
          </p>
        </descr>
        <seealso>
          <link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
        </seealso>
      </element>

      <element name="TShellListView.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
      <element name="TShellListView.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
      <element name="TShellListView.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
      <element name="TShellListView.ReadOnly" link="#lcl.comctrls.TCustomListView.ReadOnly"/>
      <element name="TShellListView.RowSelect" link="#lcl.comctrls.TCustomListView.RowSelect"/>
      <element name="TShellListView.ScrollBars" link="#lcl.comctrls.TCustomListView.ScrollBars"/>
      <element name="TShellListView.ShowColumnHeaders" link="#lcl.comctrls.TCustomListView.ShowColumnHeaders"/>
      <element name="TShellListView.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
      <element name="TShellListView.SmallImages" link="#lcl.comctrls.TCustomListView.SmallImages"/>
      <element name="TShellListView.SmallImagesWidth" link="#lcl.comctrls.TCustomListView.SmallImagesWidth"/>
      <element name="TShellListView.SortColumn" link="#lcl.comctrls.TCustomListView.SortColumn"/>
      <element name="TShellListView.SortType" link="#lcl.comctrls.TCustomListView.SortType"/>
      <element name="TShellListView.StateImages" link="#lcl.comctrls.TCustomListView.StateImages"/>
      <element name="TShellListView.TabStop" link="#lcl.comctrls.TCustomListVIew.TabStop"/>
      <element name="TShellListView.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
      <element name="TShellListView.ToolTips" link="#lcl.comctrls.TCustomListView.ToolTips"/>
      <element name="TShellListView.Visible" link="#lcl.controls.TControl.Visible"/>
      <element name="TShellListView.ViewStyle" link="#lcl.comctrls.TCustomListView.ViewStyle"/>
      <element name="TShellListView.OnChange" link="#lcl.comctrls.TCustomListView.OnChange"/>
      <element name="TShellListView.OnClick" link="#lcl.controls.TControl.OnClick"/>
      <element name="TShellListView.OnColumnClick" link="#lcl.comctrls.TCustomListView.OnColumnClick"/>
      <element name="TShellListView.OnCompare" link="#lcl.comctrls.TCustomListView.OnCompare"/>
      <element name="TShellListView.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
      <element name="TShellListView.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
      <element name="TShellListView.OnDeletion" link="#lcl.comctrls.TCustomListView.OnDeletion"/>
      <element name="TShellListView.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
      <element name="TShellListView.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
      <element name="TShellListView.OnEdited" link="#lcl.comctrls.TCustomListView.OnEdited"/>
      <element name="TShellListView.OnEditing" link="#lcl.comctrls.TCustomListView.OnEditing"/>
      <element name="TShellListView.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
      <element name="TShellListView.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
      <element name="TShellListView.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
      <element name="TShellListView.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
      <element name="TShellListView.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
      <element name="TShellListView.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
      <element name="TShellListView.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
      <element name="TShellListView.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
      <element name="TShellListView.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
      <element name="TShellListView.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
      <element name="TShellListView.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
      <element name="TShellListView.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
      <element name="TShellListView.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
      <element name="TShellListView.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
      <element name="TShellListView.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
      <element name="TShellListView.OnResize" link="#lcl.controls.TControl.OnResize"/>
      <element name="TShellListView.OnSelectItem" link="#lcl.comctrls.TCustomListView.OnSelectItem"/>
      <element name="TShellListView.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
      <element name="TShellListView.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
      <element name="TShellListView.OnAddItem" link="#lcl.shellctrls.TCustomShellListView.OnAddItem"/>
      <element name="TShellListView.OnFileAdded" link="#lcl.shellctrls.TCustomShellListView.OnFileAdded"/>
      <element name="TShellListView.ObjectTypes" link="#lcl.shellctrls.TCustomShellListView.ObjectTypes"/>
      <element name="TShellListView.Root" link="#lcl.shellctrls.TCustomShellListView.Root"/>
      <element name="TShellListView.ShellTreeView" link="#lcl.shellctrls.TCustomShellListView.ShellTreeView"/>

      <element name="TShellTreeNode">
        <short>Represents tree nodes in TShellTreeView.</short>
        <descr>
          <p>
            <var>TShellTreeNode</var> is a <var>TTreeNode</var> descendant which represents tree nodes in <var>TShellTreeView</var>. TShellTreeNode extends the ancestor class with properties and methods needed to work with files or directories on the local file system. TShellTreeNode is the class type reference used to create new nodes in  the <var>TCustomShellTreeView.CreateNode</var> method.
          </p>
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.CreateNode"/>
        </seealso>
      </element>

      <element name="TShellTreeNode.FFileInfo"/>
      <element name="TShellTreeNode.FBasePath"/>

      <element name="TShellTreeNode.SetBasePath">
        <short>Sets the value in the BasePath property.</short>
        <descr></descr>
        <seealso>
          <link id="TShellTreeNode.BasePath"/>
        </seealso>
      </element>
      <element name="TShellTreeNode.SetBasePath.ABasePath">
        <short>New value for the property.</short>
      </element>

      <element name="TShellTreeNode.ShortFilename">
        <short>Gets the short file name for the item represented in the tree node.</short>
        <descr>
          <p>
            <var>ShortFilename</var> is a <var>String</var> function used to get the short file name for the item represented in the tree node. ShortFilename tries to get the file name from an internal <var>TSearchRec</var> for the tree node. If the file name is an empty string (<b>''</b>), the name in the search record is used as the return value. ShortFilename <b>does not</b> include path information in the return value.
          </p>
          <p>
            Use <var>FullFilename</var> to get a complete file name which includes path information for the item represented in the tree node.
          </p>
        </descr>
        <seealso>
          <link id="TShellTreeNode.FullFilename"/>
        </seealso>
      </element>
      <element name="TShellTreeNode.ShortFilename.Result">
        <short>Short file name for the item represented in the tree node.</short>
      </element>

      <element name="TShellTreeNode.FullFilename">
        <short>
          Gets the full file name including path for the item represented in the tree node.
        </short>
        <descr>
          <p>
            <var>FullFilename</var> is a <var>String</var> function used to get the full path and name for the file system object represented by the tree node. FullFilename includes the value in <var>BasePath</var> when it is available, and the name from the <var>TSearchRec</var> for the tree node. For directory and/or device nodes, the return value <b>does not</b> include a trailing path delimiter. On Windows platforms (other than WinCE), device identifiers (like 'C:') are modified to include a trailing path delimiter ('C:\').
          </p>
          <p>
            Use <var>ShortFilename</var> to get the name for the tree node without path information.
          </p>
        </descr>
        <seealso>
          <link id="TShellTreeNode.BasePath"/>
          <link id="TShellTreeNode.ShortFilename"/>
          <link id="TShellTreeNode.IsDirectory"/>
        </seealso>
      </element>
      <element name="TShellTreeNode.FullFilename.Result">
        <short>The full path and name for the file system object.</short>
      </element>

      <element name="TShellTreeNode.IsDirectory">
        <short>Indicates if the tree node is a directory on the local file system.</short>
        <descr>
          <p>
            <var>IsDirectory</var> is a <var>Boolean</var> function which indicates if the file system object for the the tree node is a directory on the local file system. The return value is <b>True</b> when the file attributes in the <var>TSearchRec</var> for the tree node includes the <var>faDirectory</var> attribute.
          </p>
          <p>
            Use <var>HasChildren</var> to determine if the shell tree node has child nodes representing sub-directories.
          </p>
        </descr>
        <seealso>
          <link id="TShellTreeNode.SetBasePath"/>
          <link id="TCustomShellTreeView.PopulateTreeNodeWithFiles"/>
          <link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
          <link id="TCustomShellListView.PopulateWithRoot"/>
          <link id="#lcl.comctrls.TTreeNode.HasChildren">TTreeNode.HasChildren</link>
        </seealso>
      </element>
      <element name="TShellTreeNode.IsDirectory.Result">
        <short>True when the tree node represents a directory on the local file system.</short>
      </element>

      <element name="TShellTreeNode.BasePath">
        <short>Contains the path to the file system object in the tree node.</short>
        <descr>
          <p>
            <var>BasePath</var> is a read-only <var>String</var> property which contains the path on the local file system to the object in the tree node. The value for the property is set when the tree node is created in TShellTreeView methods using the SetBasePath method in the class instance.
          </p>
        </descr>
        <seealso>
          <link id="TShellTreeNode.SetBasePath"/>
          <link id="TCustomShellTreeView.PopulateTreeNodeWithFiles"/>
          <link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
          <link id="TCustomShellListView.PopulateWithRoot"/>
        </seealso>
      </element>

      <element name="EShellCtrl">
        <short>Exception raised for errors occurring in shell controls.</short>
        <descr>
          <var>EShellCtrl</var> is a <var>Exception</var> descendant raised when errors occur in shell controls.
        </descr>
        <seealso>
          <link id="TCustomShellTreeView.CreateNode"/>
          <link id="TCustomShellTreeView.DoSelectionChanged"/>
          <link id="EInvalidPath"/>
        </seealso>
      </element>

      <element name="EInvalidPath">
        <short>Exception raised for an invalid path in shell controls.</short>
        <descr>
          <var>EInvalidPath</var> is a <var>EShellCtrl</var> descendant raised for an invalid path in shell controls.
        </descr>
        <seealso>
          <link id="EShellCtrl"/>
          <link id="TCustomShellTreeView.Root"/>
          <link id="TCustomShellTreeView.FileSortType"/>
          <link id="TCustomShellTreeView.ObjectTypes"/>
          <link id="TCustomShellTreeView.Path"/>
          <link id="TCustomShellListView.Root"/>
        </seealso>
      </element>

      <element name="DbgS">
        <short>
          Provides strings values with details about classes used in shell controls for the debugger.
        </short>
        <descr>
          <p>
            <var>DbgS</var> is an overloaded <var>String</var> function used to get a string value with details about classes used in shell controls. The value is intended for use in the debugger. The overloaded variants provide support for the <var>TObjectTypes</var> and <var>TMaskCaseSensitivity</var> class types.
          </p>
          <p>
            For <var>TObjectTypes</var>, a string is built to represents the set type using the format:
          </p>
          <code>[otFolders,otNonFolders,otHidden]</code>
          <p>
            For <var>TMaskCaseSensitivity</var>, a string version of the enumeration value is used as the return value. For example:
          </p>
    <code>
    'mcsPlatformDefault'
    'mcsCaseInsensitive'
    'mcsCaseSensitive'
    </code>
        </descr>
        <seealso>
          <link id="TObjectTypes"/>
          <link id="TMaskCaseSensitivity"/>
        </seealso>
      </element>
      <element name="DbgS.Result">
        <short>Formatted values for the debugger.</short>
      </element>
      <element name="DbgS.OT">
        <short>TObjectTypes examined in the routine.</short>
      </element>
      <element name="DbgS.CS">
        <short>TMaskCaseSensitivity examined in the routine.</short>
      </element>

      <element name="Register">
        <short>Registers components for use in the Lazarus IDE.</short>
        <descr>
          <p>
            The following components are added to the Lazarus IDE component palette:
          </p>
          <p>
            <b>Misc</b> Tab
          </p>
          <ul>
            <li>TShellTreeView</li>
            <li>TShellListView</li>
          </ul>
        </descr>
        <seealso/>
      </element>

    </module>
    <!-- ShellCtrls -->
  </package>
</fpdoc-descriptions>