[r8597]: docs / trunk / oodialog / en-US / listview.xml  Maximize  Restore  History

Download this file

9675 lines (8814 with data), 341.4 kB

   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
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "oodialog.ent">
%BOOK_ENTITIES;
]>
<!--#########################################################################
#
# Description: Open Object Rexx: ooDialog Reference XML file.
#
# Copyright (c) 2005-2012, Rexx Language Association. All rights reserved.
# Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
# distribution. A copy is also available at the following address:
# http://www.oorexx.org/license.html
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the distribution.
#
# Neither the name of Rexx Language Association nor the names
# of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#########################################################################
-->
<chapter id="clsListView" xreflabel="ListView"><title>List View Controls</title>
<indexterm><primary>ListView class</primary></indexterm>
<para>
A list-view control is a window that displays a collection of items, with each item consisting of an icon and a label.
It provides several ways of arranging and displaying items. Refer to the <computeroutput>oodlist.rex</computeroutput>
program in the <computeroutput>samples\oodialog</computeroutput> directory for an example.
</para>
<para>
The <computeroutput>ListView</computeroutput> class is the ooDialog interface to the Windows <emphasis
role="italic">List-View</emphasis> control. This should not be confused with the Windows <emphasis role="italic">List
Box</emphasis> control. The ooDialog <xref linkend="clsListBox"/> class provides the interface to the
Windows List Box control. In general, the List-View control is more powerful than the List Box control.
</para>
<para id="listControlExtendedStyles">
List-View <emphasis role="bold">Extended Styles</emphasis>: The List-View control has been updated by Microsoft to
include a number of <emphasis role="italic">extended</emphasis> styles. These styles are similar to the styles that
can be used to create a ListView, (see the <xref linkend="mthCreateListView"/> method,) like the
<computeroutput>NOHEADER</computeroutput> or <computeroutput>SINGLESEL</computeroutput> styles. However, the way that
they are added or removed from the ListView is different. For instance, the extended styles can not be added to a
ListView at the time of creation. They can only be added after the underlying Windows control has been created. For
all practical purposes this means in the <xref linkend="mthInitDialog"/> method, or at some point in
the life cycle of the dialog after that.
</para>
<para>
Some of the extended styles are only available on later versions of the Windows OS. As an example, the
<computeroutput>LABELTIP</computeroutput> and <computeroutput>SIMPLESELECT</computeroutput> styles are only available
on Windows XP. The documentation on the extended styles will note any requirements for each style. To work with the
extended List-View styles, use the <xref linkend="mthAddExtendedStyle"/>, the
<xref linkend="mthRemoveExtendedStyle"/>, or the
<xref linkend="mthReplaceExtendedStyle"/> methods.
</para>
<para>
There are a number of nuances to the behavior of the different extended styles on the different versions of Windows,
far too many to try and detail in this documentation. The behavior documented here is the general behavior on Windows
XP with service pack 2.
</para>
<para>
If there is a need for detailed information concerning the subtle differences in behavior on earlier versions of
Windows, the programmer should consult the Windows <xref linkend="defWindowsDoc"/>.
</para>
<para>
In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are
needed, or are useful, when working with list-view controls:
<variablelist>
<varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term>
<listitem>
<para>
Use the <xref linkend="mthNewListView"/> method of the
dialog <xref linkend="chpDialogObject"/> to retrieve a list-view object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Dynamic Definition:</emphasis></term>
<listitem>
<para>
To dynamically create a list-view in the dialog template of a <xref linkend="clsUserDialog"/> use
the <xref linkend="mthCreateListView"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Event Notification</emphasis></term>
<listitem>
<para>
To connect the <xref linkend="ovvEvents"/> notifications sent by the underlying list-view control to a
method in the Rexx dialog object use the <xref linkend="mthConnectListViewEvent"/>
method.
</para>
</listitem></varlistentry>
</variablelist>
</para>
<section id="sctMethodsListView"><title>Method Table</title>
<para>
The following table provides links to the documentation for the primary methods and attributes used in working
with list-view objects, including the pertinent methods from other classes:
</para>
<table id="tblListViewMethods" frame="all">
<title>ListView Instance Methods</title>
<tgroup cols="2">
<colspec colwidth="2*" />
<colspec colwidth="7*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Useful</emphasis></entry>
<entry align="center"><emphasis role="bold">External Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="tmthNewListView"/></entry>
<entry>Returns a <computeroutput>ListView</computeroutput> object for the control with the specified ID.</entry>
</row>
<row>
<entry><xref linkend="tmthCreateListView"/></entry>
<entry>Creates a list-view control in the dialog template of a <xref linkend="clsUserDialog"/>.</entry>
</row>
<row>
<entry><xref linkend="tmthConnectListViewEvent"/></entry>
<entry>Connects list-view event notifications to a method in the Rexx dialog object.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">ListView</emphasis></entry>
<entry align="center"><emphasis role="bold">Helper Classes</emphasis></entry>
</row>
<row>
<entry><link linkend="clsLvFullRow">LvFullRow</link></entry>
<entry>The <computeroutput>LvFullRow</computeroutput> class represents a single item and its subitems in a list-view and contains the completed set of data pertaining to that item.</entry>
</row>
<row>
<entry><link linkend="clsLvItem">LvItem</link></entry>
<entry>The <computeroutput>LvItem</computeroutput> class represents a list-view item and the data for that item.</entry>
</row>
<row>
<entry><link linkend="clsLvSubItem">LvSubItem</link></entry>
<entry>The <computeroutput>LvSubItem</computeroutput> class represents a single subitem of a list-view item and the data for that subitem.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthAddClsListview"/></entry>
<entry>Adds a new item to a list-view or defines the text for a subitem.</entry>
</row>
<row>
<entry><xref linkend="mthAddExtendedStyle"/></entry>
<entry>Adds one or more of the extended list-view styles to a list-view control.</entry>
</row>
<row>
<entry><link linkend="mthAddFullRow">addFullRow</link></entry>
<entry>Adds a new item to a list-view at the end of the list using a <link linkend="clsLvFullRow">LvFullRow</link> object.</entry>
</row>
<row>
<entry><xref linkend="mthAddRow"/></entry>
<entry>Adds a new item to a list-view.</entry>
</row>
<row>
<entry><xref linkend="mthAddStyleClsListView"/></entry>
<entry>Adds new window styles to a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthAlignLeft"/></entry>
<entry>Aligns items along the left window border.</entry>
</row>
<row>
<entry><xref linkend="mthAlignTop"/></entry>
<entry>Aligns items along the upper window border.</entry>
</row>
<row>
<entry><xref linkend="mthArrange"/></entry>
<entry>Aligns items according to the current alignment style of the list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthBkColor"/></entry>
<entry>Retrieves the background color for a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthBkColorEquals"/></entry>
<entry>Sets the background color of a list view-control.</entry>
</row>
<row>
<entry><xref linkend="mthCheckClsListControl"/></entry>
<entry>Sets the check mark for a list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthCheckAll"/></entry>
<entry>Sets the check mark for every list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthColumnInfo"/></entry>
<entry>Retrieves information for a column of a list-view control in a <computeroutput>Stem</computeroutput> object. <emphasis role="bold">(Inaccurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthColumnWidth"/></entry>
<entry>Retrieves the width, in dialog units, of a column in a list-view when it is has the list or report view style. <emphasis role="bold">(Inaccurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthColumnWidthPX"/></entry>
<entry>Retrieves the width, in pixels, of a column in a list-view when it is has the list or report view style.</entry>
</row>
<row>
<entry><xref linkend="mthDeleteClsListView"/></entry>
<entry>Removes an item from a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthDeleteAllClsListview"/></entry>
<entry>Removes all times from a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthDeleteColumn"/></entry>
<entry>Removes a column from a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthDeselect"/></entry>
<entry>Deselects an item in the list-view.</entry>
</row>
<row>
<entry><xref linkend="mthDeselectAll"/></entry>
<entry>Deselects all items in the list-view.</entry>
</row>
<row>
<entry><xref linkend="mthDropHighLighted"/></entry>
<entry>Retrieves the item that is highlighted as a drag-and-drop target.</entry>
</row>
<row>
<entry><xref linkend="mthEdit"/></entry>
<entry>Begins the editing of the text of the specified list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthEndEdit"/></entry>
<entry>Cancels the editing of the list-view item being edited.</entry>
</row>
<row>
<entry><xref linkend="mthEnsureVisible"/></entry>
<entry>Ensures that a list-view item is entirely or partially visible by scrolling the list-view control, if necessary.</entry>
</row>
<row>
<entry><xref linkend="mthFindClsListView"/></entry>
<entry>Searches for a list-view item containing the specified text.</entry>
</row>
<row>
<entry><xref linkend="mthFindNearestXY"/></entry>
<entry>Searches, in the specified direction, for the item nearest to the specified position.</entry>
</row>
<row>
<entry><xref linkend="mthFindPartial"/></entry>
<entry>Searches for a list-view item beginning with the specified text.</entry>
</row>
<row>
<entry><xref linkend="mthFirstVisible"/></entry>
<entry>Retrieves the index of the first item visible in list-view control with the report or list style.</entry>
</row>
<row>
<entry><xref linkend="mthFocus"/></entry>
<entry>Assigns the focus to the specified item,</entry>
</row>
<row>
<entry><xref linkend="mthFocused"/></entry>
<entry>Retrieves the index of the item that currently has the focus.</entry>
</row>
<row>
<entry><xref linkend="mthGetCheck"/></entry>
<entry>Determines if the item at the specified index has a checked, check box.</entry>
</row>
<row>
<entry><xref linkend="mthGetColumnInfo"/></entry>
<entry>Retrieves the attributes of a list-view column in a <computeroutput>Directory</computeroutput> object.</entry>
</row>
<row>
<entry><xref linkend="mthGetColumnCount"/></entry>
<entry>Returns the number of columns in the list-view control when it has the report style.</entry>
</row>
<row>
<entry><xref linkend="mthGetColumnOrder"/></entry>
<entry>Retrieves the current column order of the list-view when it has the report style.</entry>
</row>
<row>
<entry><xref linkend="mthGetColumnText"/></entry>
<entry>Retrieves the column header text for a list-view when it is in report view.</entry>
</row>
<row>
<entry><xref linkend="mthGetExtendedStyle"/></entry>
<entry>Returns the extended styles of a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthGetExtendedStyleRaw"/></entry>
<entry>Returns the extended styles of a list-view cont control as the numeric value of the extended style flags.</entry>
</row>
<row>
<entry><xref linkend="mthGetFullRow"/></entry>
<entry>Returns a <link linkend="clsLvFullRow">LvFullRow</link> object for the specified item in this list view.</entry>
</row>
<row>
<entry><xref linkend="mthGetHoverTime"/></entry>
<entry>Retrieves the current hover time in milliseconds.</entry>
</row>
<row>
<entry><xref linkend="mthGetImageList"/></entry>
<entry>Retrieves the current image list for the image list type specified.</entry>
</row>
<row>
<entry><xref linkend="mthGetItem"/></entry>
<entry>Returns a <link linkend="clsLvItem">LvItem</link> object for the item specified.</entry>
</row>
<row>
<entry><xref linkend="mthGetItemDataClsListView"/></entry>
<entry>Retrieves the user data associated with the specified list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthGetItemInfo"/></entry>
<entry>Retrieves the attributes of a list-view item in a <computeroutput>Directory</computeroutput> object.</entry>
</row>
<row>
<entry><xref linkend="mthGetItemPos"/></entry>
<entry>Retrieves the client area coordinates of an item in a list-view control as a <computeroutput>Point</computeroutput> object.</entry>
</row>
<row>
<entry><xref linkend="mthGetToolTipsClsListview"/></entry>
<entry>Retrieves the child <link linkend="clsToolTip">ToolTip</link> control used by this list-view.</entry>
</row>
<row>
<entry><xref linkend="mthHasCheckBoxes"/></entry>
<entry>Determines if a list-view control has the CHECKBOXES extended list-view style.</entry>
</row>
<row>
<entry><xref linkend="mthHitTestInfoClsListView"/></entry>
<entry>Determines which list-view item, if any, is at the specified position.</entry>
</row>
<row>
<entry><xref linkend="mthInsertClsListControl"/></entry>
<entry>Inserts a new item into the list-view, or inserts a new subitem into in an existing list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthInsertColumn"/></entry>
<entry>Inserts a new column into the list-view control using dialog units for the width. <emphasis role="bold">(Inaccurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthInsertColumnPX"/></entry>
<entry>Inserts a new column into a list-view control using pixels for the width</entry>
</row>
<row>
<entry><link linkend="mthInsertFullRow">insertFullRow</link></entry>
<entry>Adds a new item to a list-view at the position specified using a <link linkend="clsLvFullRow">LvFullRow</link> object.</entry>
</row>
<row>
<entry><xref linkend="mthIsCheckedClsListControl"/></entry>
<entry>Determines if a check box for a list-view item is checked or not.</entry>
</row>
<row>
<entry><xref linkend="mthItemInfo"/></entry>
<entry>Retrieves the attributes of a list-view item in a <computeroutput>Stem</computeroutput> object.</entry>
</row>
<row>
<entry><xref linkend="mthItemPos"/></entry>
<entry>Retrieves the client area coordinates of an item in a list-view control as a <computeroutput>String</computeroutput> object.</entry>
</row>
<row>
<entry><xref linkend="mthItemsClsListView"/></entry>
<entry>Retrieves the number of items in a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthItemState"/></entry>
<entry>Retrieves the state of a list-view item, focused, selected, etc.</entry>
</row>
<row>
<entry><xref linkend="mthItemText"/></entry>
<entry>Retrieves the text of a list-view item or subitem.</entry>
</row>
<row>
<entry><xref linkend="mthItemsPerPage"/></entry>
<entry>Calculates the number of items that vertically fit the visible area of a list-view control that has the report or list style.</entry>
</row>
<row>
<entry><xref linkend="mthLast"/></entry>
<entry>Retrieves the index of the last item in a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthLastSelected"/></entry>
<entry>Returns the index of the selected item with the highest index in a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthModify"/></entry>
<entry>Modifies the text or icon for an item, or the text for a subitem, for a list-view item</entry>
</row>
<row>
<entry><xref linkend="mthModifyColumn"/></entry>
<entry>Sets new attributes for a column of a list-view control when it has the report or list style. <emphasis role="bold">(Inaccurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthModifyColumnPX"/></entry>
<entry>Sets new attributes for a column of a list-view control when it has the report or list style.</entry>
</row>
<row>
<entry><xref linkend="mthNext"/></entry>
<entry>Retrieves the item that follows, or is to the right of, the specified item.</entry>
</row>
<row>
<entry><xref linkend="mthNextLeft"/></entry>
<entry>Retrieves the item to the left of the specified item.</entry>
</row>
<row>
<entry><link linkend="mthNextRight">nextRight</link></entry>
<entry>Retrieves the item to the right of the specified item.</entry>
</row>
<row>
<entry><xref linkend="mthNextSelected"/></entry>
<entry>Retrieves the next selected item that follows, or is to the right of, the specified item.</entry>
</row>
<row>
<entry><xref linkend="mthPrepare4nItems"/></entry>
<entry>Informs the list-view control to prepare for the addition of a large number of items.</entry>
</row>
<row>
<entry><link linkend="mthPrependFullRow">prependFullRow</link></entry>
<entry>Adds a new item to a list-view at the beginning of the list using a <link linkend="clsLvFullRow">LvFullRow</link> object.</entry>
</row>
<row>
<entry><xref linkend="mthPrevious"/></entry>
<entry>Retrieves the index of the item that precedes, or is to the left of, the specified item.</entry>
</row>
<row>
<entry><xref linkend="mthPreviousSelected"/></entry>
<entry>Retrieves the first selected item that precedes, or is to the left of, the specified item.</entry>
</row>
<row>
<entry><xref linkend="mthRedrawItems"/></entry>
<entry>Forces a list-view control to redraw a range of items.</entry>
</row>
<row>
<entry><xref linkend="mthRemoveItemDataClsListView"/></entry>
<entry>Removes and returns the user data associated with the specified list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthRemoveExtendedStyle"/></entry>
<entry>Removes one or more extended styles of a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthRemoveStyleClsListView"/></entry>
<entry>Removes one or more window styles of a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthReplaceExtendedStyle"/></entry>
<entry>Removes some or all of the list-view control's extended styles and adds new extended styles</entry>
</row>
<row>
<entry><xref linkend="mthReplaceStyleClsListView"/></entry>
<entry>Removes some of the window styles of a list-view control and sets new styles.</entry>
</row>
<row>
<entry><xref linkend="mthScrollClsListview"/></entry>
<entry>Scrolls the content of a list view control.</entry>
</row>
<row>
<entry><xref linkend="mthSelectClsListView"/></entry>
<entry>Selects an item.</entry>
</row>
<row>
<entry><xref linkend="mthSelectedClsListView"/></entry>
<entry>Returns the index of the first selected item.</entry>
</row>
<row>
<entry><xref linkend="mthSelectedItemsClsListView"/></entry>
<entry>Determines the count of selected items in a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthSetColumnOrder"/></entry>
<entry>Changes the column order of a list-view control to some other order.</entry>
</row>
<row>
<entry><xref linkend="mthSetColumnWidth"/></entry>
<entry>Sets the width, in dialog units, of a column in a list-view control that has the report or list style. <emphasis role="bold">(Inaccurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthSetColumnWidthPX"/></entry>
<entry>Sets the width, in pixels, of a column in a list-view control that has the report or list style.</entry>
</row>
<row>
<entry><xref linkend="mthSetHoverTime"/></entry>
<entry>Used to change the hover time.</entry>
</row>
<row>
<entry><xref linkend="mthSetImageListClsListView"/></entry>
<entry>Assigns, or removes, an image list for the list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthSetItemDataClsListView"/></entry>
<entry>Sets the user data associated for the specified list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthSetItemPos"/></entry>
<entry>Moves an item to a specified position in a list-view control that has the icon or small-icon style.</entry>
</row>
<row>
<entry><xref linkend="mthSetItemState"/></entry>
<entry>Sets the state of a list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthSetItemText"/></entry>
<entry>Changes the text of an item, or the text of a subitem, of a list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthSetToolTipsClsListView"/></entry>
<entry>Sets the child <link linkend="clsToolTip">ToolTip</link> control used by this tree-view.</entry>
</row>
<row>
<entry><xref linkend="mthSmalSpacing"/></entry>
<entry>Determines the spacing between items in a list-view control when it has the small-icon style.</entry>
</row>
<row>
<entry><xref linkend="mthSnapToGrid"/></entry>
<entry>Snaps all icons to the nearest grid position.</entry>
</row>
<row>
<entry><xref linkend="mthSortItems"/></entry>
<entry>The <emphasis role="italic">sortItems</emphasis> method causes the list-view control to sort its items using the specified comparison method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthSpacing"/></entry>
<entry>Determines the spacing between items in an icon list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthStringWidth"/></entry>
<entry>Determines the width, in dialog units, of a specified string using the current font of the list-view control. <emphasis role="bold">(Inaccurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthStringWidthPX"/></entry>
<entry>Determines the width, in pixels, of a specified string using the current font of the list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthTextBkColor"/></entry>
<entry>Retrieves the background color of the text in a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthTextBkColorEquals"/></entry>
<entry>Sets the background color for the text in a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthTextColor"/></entry>
<entry>Retrieves the text color of a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthTextColorEquals"/></entry>
<entry>Sets the text color of a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthUncheckClsListControl"/></entry>
<entry>Removes the check mark for the specified list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthUncheckAll"/></entry>
<entry>Clears the check mark for every list-view item.</entry>
</row>
<row>
<entry><xref linkend="mthUpdateItem"/></entry>
<entry>Updates a list-view item.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="sctViewStyles"><title>View Styles</title>
<indexterm><primary>view styles</primary></indexterm>
<para>
List view controls can display their contents in different views. The current view is specified by the window style of the
control. Additional window styles define the alignment of the items and the functionality of the list-view control. The
different views are:
</para>
<variablelist>
<varlistentry><term>Icon view</term>
<listitem>
<para>
Each item appears as a full-sized icon with a label below it. The user can drag the items to any location in the list
view.
</para>
</listitem></varlistentry>
<varlistentry><term>Small-icon view</term>
<listitem>
<para>
Each item appears as a small icon with a label to the left of it. The user can drag the items to any location.
</para>
</listitem></varlistentry>
<varlistentry><term>List view</term>
<listitem>
<para>
Each item appears as a small icon with a label to the left of it. The user cannot drag the items.
</para>
</listitem></varlistentry>
<varlistentry><term>Report view</term>
<listitem>
<para>
Each item appears on a separate line with information arranged in columns. The leftmost column contains the small icon
and the label. All following columns contain subitems as specified by the application.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="tmthNewListView" xreflabel="newListview"><title>newListView (dialog object method)</title>
<para>
List view objects can not be instantiated by the programmer from Rexx code. Rather a list-view object is obtained
by using the <xref linkend="mthNewListView"/> method of the <xref linkend="chpDialogObject"/> object. The syntax is:
<programlisting>
<![CDATA[
>>--newListView(--id--)--------------------------><
]]>
</programlisting>
</para>
</section> <!-- End newListView() [PlainBaseDialog method] -->
<section id="tmthCreateListView" xreflabel="createListView"><title>createListView (UserDialog method)</title>
<para>
A list-view object can be created in the dialog template for a <xref linkend="clsUserDialog"/>
dialog through the <xref linkend="mthCreateListView"/> method. The basic syntax is:
<programlisting>
<![CDATA[
>>--createListView(-id-,--x-,--y-,--cx-,--cy-+---------+--+------------+--)----><
+-,-style-+ +-,-attrName-+
]]>
</programlisting>
</para>
</section> <!-- End UserDialog::createListView() [UserDialog method] -->
<section id="tmthConnectListViewEvent" xreflabel="connectListViewEvent">
<title>connectListViewEvent (dialog object method)</title>
<para>
To connect event notifications from a list-view object use the <xref linkend="mthConnectListViewEvent"/> method of the
<xref linkend="chpDialogObject"/> object. The basic syntax is:
<programlisting> <![CDATA[
>>-connectListViewEvent(--id--,--event--+---------------+--)-------------------><
+-,--methodName-+
]]>
</programlisting>
</para>
</section> <!-- End connectListViewEvent() [EventNotification method] -->
<section id="mthAddClsListview" xreflabel="add"><title>add</title>
<indexterm><primary>add</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>add</secondary></indexterm>
<programlisting>
<![CDATA[
+-------+
V |
>>--add(----+-----+--text--+--------+--)---------><
+--,--+ +-,-icon-+
]]>
</programlisting>
<para>
The <emphasis role="italic">add</emphasis> method adds a new item to a list-view, or defines the text
for a subitem. It can be used to fill a list-view sequentially.
</para>
<para>
Remember that in a list-view, items and columns use a 0-based index. Subitems use a 1-based index.
</para>
<para>
The number of commas preceding the <emphasis role="italic">text</emphasis> argument determines whether a
new item is added to the list-view or the text for a subitem is being defined. When there is no comma
preceding <emphasis role="italic">text</emphasis> then a new item is added to the list-view.
</para>
<para>
When 1 or more commas precede <emphasis role="italic">text</emphasis>, then no item is added to the
list-view. Rather, the text for a subitem is defined. When 1 comma precedes <emphasis
role="italic">text</emphasis>, then the text for subitem 1 is being defined. When 2 commas precedes the
<emphasis role="italic">text</emphasis> argument, then the text for subitem 2 is being defined, and so
on.
</para>
<para>
When an item is added, it is always added directly <emphasis role="italic">after</emphasis> the last
item to be placed in the list-view. Or as item 0 if the list-view currently has no items. When the text
of a subitem is being defined, then the text is defined for the subitem of last item placed in the
list-view.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>, [optional]</term>
<listitem>
<para>
As explained above, this argument determines if an item is added to the list-view, or if the text of a
subitem is defined.
</para>
</listitem></varlistentry>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text for the item label, or the text for the subitem of a item, depending on whether an item is
being added or the text for a subitem is being defined.
</para>
</listitem></varlistentry>
<varlistentry><term>icon [optional]</term>
<listitem>
<para>
Specifies the index within the image list for the icon for this item. Image lists are assigned to a
list-view by using the <xref linkend="mthSetImageListClsListView"/>() method. With
the <computeroutput>setImageList</computeroutput>() method, use the LVSIL_NORMAL flag for the icon view
icons and the LVSIL_SMALL flag for the list, report, and small-icon view icons.
</para>
<para>
Use -1 or simply omit this argument to indicate there is no icon for the item being added. This
argument is ignored completely when the text for a subitem is being defined.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>
The following example adds three columns and two items to a report list control. To get the following
result:
</para>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>First Name</entry>
<entry>Last Name</entry>
<entry>Age</entry>
</row>
</thead>
<tbody>
<row>
<entry>Mike</entry>
<entry>Miller</entry>
<entry>30</entry>
</row>
<row>
<entry>Sue</entry>
<entry>Thaxtor</entry>
<entry>29</entry>
</row>
</tbody></tgroup>
</informaltable>
<para>
using the <emphasis role="italic">add</emphasis> method you must specify something similar to the following:
</para>
<programlisting>
<![CDATA[
::method initDialog
list = self~newListView(IDC_LIST_REP)
if list \= .nil then do
imageList = .ImageList~create(.Size~new(16), .Image~toID(ILC_COLOR24), 9, 0)
imageList~add(.Image~getImage("E:\oodlist\oodlist.BMP"))
list~setImageList(imageList, .Image~toID(LVSIL_SMALL))
list~insertColumn(0,"First Name",50)
list~insertColumn(1,"Last Name",50)
list~insertColumn(2,"Age",50)
-- 3 is the index in the image list for the icon for item 0
list~add("Mike", 3)
list~add(,"Miller")
list~add(, ,"30")
-- 0 is the index in the image list for the icon for item 1
list~~add("Sue", 0)~~add(,"Thaxton")~~add(, ,"29")
end
]]>
</programlisting>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthAddExtendedStyle" xreflabel="addExtendedStyle"><title>addExtendedStyle</title>
<indexterm><primary>addExtendedStyle</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>addExtendedStyle</secondary></indexterm>
<programlisting>
<![CDATA[
>>-addExtendedStyle(--style--)-------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">addExtendedStyle</emphasis> method adds one or more of the <link
linkend="listControlExtendedStyles">extended</link> list-view styles to a list-view. These styles can not be added until
the underlying Windows list-view control has been created. They can be added in the <xref linkend="mthInitDialog"/>
method, or any time thereafter.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
</para>
<variablelist>
<varlistentry><term>style [required]</term>
<listitem>
<para>
The extended style to be added. A list of 1 or more of the following keywords separated by spaces, case is not
significant. Invalid words in the list are ignored. If there are no valid keywords at all in the list, then an error
is returned:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BORDERSELECT </member>
<member>CHECKBOXES </member>
<member>DOUBLEBUFFER </member>
<member>FLATSB </member>
<member>FULLROWSELECT </member>
<member>GRIDLINES </member>
<member>HEADERDRAGDROP </member>
<member>INFOTIP </member>
<member>LABELTIP </member>
<member>MULTIWORKAREAS </member>
<member>ONECLICKACTIVATE</member>
<member>REGIONAL </member>
<member>SIMPLESELECT </member>
<member>SUBITEMIMAGES </member>
<member>TRACKSELECT </member>
<member>TWOCLICKACTIVATE</member>
<member>UNDERLINECOLD </member>
<member>UNDERLINEHOT </member>
</simplelist>
<variablelist>
<varlistentry><term>BORDERSELECT</term>
<listitem>
<para>
When an item is selected the border color of the item changes rather than the item being highlighted.
</para>
</listitem></varlistentry>
<varlistentry><term>CHECKBOXES</term>
<listitem>
<para>
Check boxes are visible and functional in all list-view modes except tile mode.
</para>
</listitem></varlistentry>
<varlistentry><term>DOUBLEBUFFER</term>
<listitem>
<para>
Windows XP or later only. The list-view control is painted using double buffering. This reduces flicker.
</para>
</listitem></varlistentry>
<varlistentry><term>FLATSB</term>
<listitem>
<para>
Enables flat scroll bars.
</para>
</listitem></varlistentry>
<varlistentry><term>FULLROWSELECT</term>
<listitem>
<para>
Report view only. When a row is selected, the whole row is highlighted rather than just the first column.
</para>
</listitem></varlistentry>
<varlistentry><term>GRIDLINES</term>
<listitem>
<para>
Report view only. Gridlines are drawn around all items and sub-items. This gives a spreadsheet-like appearance to
the list-view control.
</para>
</listitem></varlistentry>
<varlistentry><term>HEADERDRAGDROP</term>
<listitem>
<para>
Report view only. The user can drag and drop the headers to rearrange the columns.
</para>
</listitem></varlistentry>
<varlistentry id='styListViewInfoTip'><term>INFOTIP</term>
<listitem>
<para>
With this style the list-view control sends the <link linkend="kywListViewGETINFOTIP">GETINFOTIP</link>
notification to the dialog before displaying an item's tooltip. This allows the program to add, enhance, or change
the text displayed in the tip.
</para>
</listitem></varlistentry>
<varlistentry><term>LABELTIP</term>
<listitem>
<para>
Windows XP or later only. In any list-view mode, if an item's label is only partially visible, the complete label
will be displayed in a fashion similar to a tool tip.
</para>
</listitem></varlistentry>
<varlistentry><term>MULTIWORKAREAS</term>
<listitem>
<para>
The current version of ooDialog can not take advantage of this style. It is planned for a future enhancement.
</para>
</listitem></varlistentry>
<varlistentry><term>ONECLICKACTIVATE</term>
<listitem>
<para>
Enables the list-view control to send an item activate notification when the user clicks one time on an item. It
also enables hot tracking in the list-view control. Both the underline cold and the underline hot styles need
either one click activate or two click activate styles to be enabled.
</para>
</listitem></varlistentry>
<varlistentry><term>REGIONAL</term>
<listitem>
<para>
Icon view only. Sets the window region to only include an item's icon and text.
</para>
</listitem></varlistentry>
<varlistentry><term>SIMPLESELECT</term>
<listitem>
<para>
Windows XP and later only. Icon view only. Moves the state
image to the top right of the icon image. If the user changes the state using
the space bar, all the selected items cycle, not just the item with the focus.
</para>
</listitem></varlistentry>
<varlistentry><term>SUBITEMIMAGES</term>
<listitem>
<para>
Report view only. Allows images to be displayed for subitems.
</para>
</listitem></varlistentry>
<varlistentry><term>TRACKSELECT</term>
<listitem>
<para>
Enables hot track selection. The user can select an item by leaving the mouse over an item for a certain period of
time, the &quot;hover&quot; time. This period of time can be changed from the default by using the <xref
linkend="mthSetHoverTime"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term>TWOCLICKACTIVATE</term>
<listitem>
<para>
Enables the list-view control to send an item activate notification when the user clicks on an item after it has
been selected. When the user clicks on an item it will be selected. At that point, if the user
clicks on the item a second time, the item will be activated. Note that this is different from double-clicking to
activate. Any amount of time can pass between the click that selects the item and the click that activates the
item. (Provided the item remains selected of course.)
</para>
<para>
It also works with track select. If track select is enabled, the user can select an item by pausing the mouse over
the item. At that point, if the user then clicks on the item it will be activated.
</para>
</listitem></varlistentry>
<varlistentry><term>UNDERLINECOLD</term>
<listitem>
<para>
Underlining gives the user a visual clue that a single click on an item will activate it. Underlining requires
either ONECLICKACTIVATE or TWOCLICKACTIVE to also be enabled. An item becomes hot when the mouse is over it.
Underline cold underlines all the cold items when a single click will activate them. When one click activate is
enabled, this would then be all items. When two click activate is enabled this would then be only those items that
were selected.
</para>
</listitem></varlistentry>
<varlistentry><term>UNDERLINEHOT</term>
<listitem>
<para>
The underline hot style is similar to the underline cold style. See that style above for the explanation of some of
the terms. With underline hot, the item is underlined when the mouse is over it, if one click will activate the
item.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
Success.
</para>
</listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem>
<para>
An (internal) problem with the control's window handle.
</para>
</listitem></varlistentry>
<varlistentry><term>-3</term>
<listitem>
<para>
The style argument did not contain any of the extended style keywords.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example shows how to initially add the extended styles to a list-view control. This is done in the
<xref linkend="mthInitDialog"/> method, which executes after the underlying Windows dialog has been created, but before
it is displayed on the screen. This is the earliest point in time that the extended style methods can be used. The
list-view is in the report view and will have check boxes and grid lines. The user will be able to use drag and drop to
rearrange the columns. When a row is selected, the full row will be highlighted rather than just the first column.
<programlisting>
<![CDATA[
::method initDialog
expose listView
...
listView = self~newListView(IDC_LIST)
if listView == .nil then return
listView~addExtendedStyle("CHECKBOXES GRIDLINES FULLROWSELECT HEADERDRAGDROP")
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthAddFullRow"><title>addFullRow</title>
<indexterm><primary>addFullRow</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>addFullRow</secondary></indexterm>
<programlisting>
<![CDATA[
>>--addFullRow(--row--)--------------------------><
]]>
</programlisting>
<para>
Add an item to the list-view at the end of the list using a <link linkend="clsLvFullRow">LvFullRow</link> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>row [required]</term>
<listitem>
<para>
A <link linkend="clsLvFullRow">LvFullRow</link> object that specifies the item to be added to the list-view.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
On success, returns the zero-based index of the added row. On error, -1 is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When a full row object is used to add an item to the list view, all the subitems are also added. The item is always
added as the last item in the list. Because of this, the item index and subitem index values in the full row object
are ignored. After the item is added, the item and subitem index are updated to the correct value of the newly added
item.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows part of an initDialog() method. The private method createRows() returns an array of
<computeroutput>LvFullRow</computeroutput> objects, which are then used to populoate the list-view:
<programlisting>
<![CDATA[
::method initDialog
expose list
list = self~newListView(IDC_LV_EMPLOYEES)
...
rows = self~createRows
do r over rows
list~addFullRow(r)
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::addFullRow() -->
<section id="mthAddRow" xreflabel="addRow"><title>addRow</title>
<indexterm><primary>addRow</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>addRow</secondary></indexterm>
<programlisting>
<![CDATA[
+-,----+
V |
>>--addRow(--+------+--,--------+--+--------+--)---><
+-item-+ +-,-icon-+ +-,-text-+
]]>
</programlisting>
<para>
The <emphasis role="italic">addRow</emphasis> method adds a new item to a list-view. This method is
most useful when adding items that have subitems to the list-view. But, despite its name, it can be
used to add any item, with or without subitems, to a list-view.
</para>
<para>
Remember that in a list-view, items and columns use a 0-based index. Subitems use a 1-based index.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>item [optional]</term>
<listitem>
<para>
The index of the item. If you omit this argument, the item is added immediately after the last item added or inserted
in the list-view. That is, the index defaults to the index of the last item added plus 1. If there are no items in the
list-view then the item is added at index 0.
</para>
</listitem></varlistentry>
<varlistentry><term>icon [optional]</term>
<listitem>
<para>
The index within the image list for the icon for this item. Image lists are assigned to a list-view by
using the <xref linkend="mthSetImageListClsListView"/>() method. With the <emphasis
role="italic">setImageList</emphasis> method, use the LVSIL_NORMAL flag for the icon view icons and the LVSIL_SMALL
flag for the list, report, and small-icon views icons. If this argument is omitted, no icon index is assigned to the
itme
</para>
</listitem></varlistentry>
<varlistentry><term>text [optional]</term>
<listitem>
<para>
Any number of text strings. The first text string is used for the label of the item. Successive strings are used for
the text of subitems of the item. For example, the text of the second string is used for the text of subitem 1. The
text of the third string is used for the text of subitem 2, and so on. If the first string is omitted, then the empty
string is used for the item label. If other strings are omitted, than no text is set for the corresponding subitem. If
you specify more text entries than there are columns, the extra entries are ignored.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The index of the new item, or -1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example adds three items to a report list with two columns:
<programlisting>
<![CDATA[
::method InitList
lv = self~newListView(IDC_LV_CONTACTS)
lv~addRow(, ,"Mike","Miller")
lv~addRow(, ,"Sue","Muller")
lv~addRow(, ,"Chris","Watson")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthAddStyleClsListView" xreflabel="addStyle"><title>addStyle</title>
<indexterm><primary>addStyle</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
+-------------------+
V |
>>-aListControl~addStyle(--"----+-ICON----------+-+--"--)------><
+-SMALLICON-----+
+-LIST----------+
+-REPORT--------+
+-ALIGNLEFT-----+
+-ALIGNTOP------+
+-AUTOARRANGE---+
+-ASCENDING-----+
+-DESCENDING----+
+-EDIT----------+
+-HSCROLL-------+
+-VSCROLL-------+
+-NOSCROLL------+
+-NOHEADER------+
+-NOSORTHEADER--+
+-NOWRAP--------+
+-SINGLESEL-----+
+-SHOWSELALWAYS-+
+-SHAREIMAGES---+
+-GROUP---------+
+-HIDDEN--------+
+-NOTAB---------+
+-NOBORDER------+
]]>
</programlisting>
<para>The addStyle method adds new window styles to a
list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>style</term>
<listitem><para>The window styles to be added, which is one or more of the styles listed
in the syntax diagram, separated by blanks. For an explanation of the different
styles, refer to <xref linkend="mthCreateListView"/>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>0 if this method fails.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthAlignLeft" xreflabel="alignLeft"><title>alignLeft</title>
<indexterm><primary>alignLeft</primary></indexterm>
<programlisting>
<![CDATA[
>>--alignLeft------------------------------------><
]]>
</programlisting>
<para>The alignLeft method aligns items along the left
window border.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The items were aligned.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthAlignTop" xreflabel="alignTop"><title>alignTop</title>
<indexterm><primary>alignTop</primary></indexterm>
<programlisting>
<![CDATA[
>>--alignTop-------------------------------------><
]]>
</programlisting>
<para>The alignTop method aligns items along the upper
window border.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The items were aligned.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthArrange" xreflabel="arrange"><title>arrange</title>
<indexterm><primary>arrange</primary></indexterm>
<programlisting>
<![CDATA[
>>--arrange--------------------------------------><
]]>
</programlisting>
<para>The arrange method aligns items according to the
current alignment style of the list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The items were aligned.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthBkColor" xreflabel="bkColor"><title>bkColor</title>
<indexterm><primary>bkColor</primary></indexterm>
<programlisting>
<![CDATA[
>>--bkColor--------------------------------------><
]]>
</programlisting>
<para>The bkColor method retrieves the background color
for a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The <xref linkend="defColorPalette"/> index specifier (0 to 18).
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthBkColorEquals" xreflabel="bkColor="><title>bkColor=</title>
<indexterm><primary>bkColor=</primary></indexterm>
<programlisting>
<![CDATA[
>>--bkColor = color------------------------------><
]]>
</programlisting>
<para>The bkColor= method sets the background color of
a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>color</term>
<listitem>
<para>
The new background color. Specify the <xref linkend="defColorPalette"/> index specifier (0 to 18).
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example sets the background color of a list control to
yellow:
<programlisting>
<![CDATA[
::method Yellow
curList = self~newListView(104)
curList~bkColor = 15
curList~update
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthCheckClsListControl" xreflabel="check"><title>check</title>
<indexterm><primary>check</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~check(--index--)--------------------------------------------><
]]>
</programlisting>
<para>The <computeroutput>check</computeroutput> method sets the check mark for
a list-view item. This method is only valid for list-view controls that have
the check boxes extended style. (See the
<xref linkend="mthAddExtendedStyle"/> method for a description
of the check boxes extended style.)
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>index</term>
<listitem><para>The index of the item for which to set the check mark.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>Success.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>An (internal) problem with the control's window handle.
</para></listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem><para>The list-view control does not have the check boxes extended
style.
</para></listitem></varlistentry>
<varlistentry><term>-3</term>
<listitem><para>The index is invalid.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example is from a mailing list application. The
user selects which entries to include in any mailing. All items in a list-view
that have their check boxes checked are included in the mailing. The
application has a feature that allows the user to automatically select all items
with a specified zip code.
<programlisting>
<![CDATA[
::method onUseZip
text = self~newEdit(IDC_EDIT_ZIPCODE)~getText
if self~validateZip(text) then do
list = self~newListView(IDC_LIST)
do i = 0 to addresses~items - 1
infoTable = address[i + 1]
if infoTable['zip'] == text then list~check(i)
end
end
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthCheckAll" xreflabel="checkAll"><title>checkAll</title>
<indexterm><primary>checkAll</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~CheckAll----------------------------------------------------><
]]>
</programlisting>
<para>The <computeroutput>checkAll</computeroutput> method sets the check mark
for every list-view item. This method is only valid for list-view controls that
have the check boxes extended style. (See the
<xref linkend="mthAddExtendedStyle"/> method for a description
of the check boxes extended style.)
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>This method takes no arguments.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>Success.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>An (internal) problem with the control's window handle.
</para></listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem><para>The list-view control does not have the check boxes extended
style.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example is from a program that has a push button
that allows the user to check all the check boxes:
<programlisting>
<![CDATA[
::method onCheckAll
list = self~newListView(IDC_LIST_REPUBLICANS)
list~checkAll
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthColumnInfo" xreflabel="columnInfo"><title>columnInfo</title>
<indexterm><primary>columnInfo</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~columnInfo(--column--)-------------------------><
]]>
</programlisting>
<para>The columnInfo method retrieves the attributes
of a column of a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>column</term>
<listitem><para>The number of the column of which the attributes are to be retrieved.
0 is the first column.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>A compound variable that stores the attributes of the item.
If attributes for a column are not available or an error occurs, then the
RetStem.!WIDTH variable will be set to 0.
<variablelist>
<varlistentry><term>RetStem.!TEXT</term>
<listitem><para>The heading of the column.
</para></listitem></varlistentry>
<varlistentry><term>RetStem.!COLUMN</term>
<listitem><para>The column number.
</para></listitem></varlistentry>
<varlistentry><term>RetStem.!WIDTH</term>
<listitem><para>The width of the column.
</para></listitem></varlistentry>
<varlistentry><term>RetStem.!ALIGN</term>
<listitem><para>The alignment of the column: &quot;LEFT&quot;, &quot;RIGHT&quot;, or &quot;CENTER&quot;.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthColumnWidth" xreflabel="columnWidth"><title>columnWidth</title>
<indexterm><primary>columnWidth</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~columnWidth(--column--)------------------------><
]]>
</programlisting>
<para>The columnWidth method retrieves the width of a
column in a report or list view.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>column</term>
<listitem><para>The number of the column of which the width is to be retrieved. 0 is
the first column.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The column width, or -1 if you did not specify <emphasis role="italic">column</emphasis>,
or 0 in all other cases.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example displays the column width in an information box
when the column is clicked on:
<programlisting>
<![CDATA[
::method onColumnClick
use arg id, column
listView = self~newListView(102)
call infoDialog listView~columnWidth(column)
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthColumnWidthPX" xreflabel="columnWidthPX"><title>columnWidthPX</title>
<indexterm><primary>columnWidthPX</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>columnWidthPX</secondary></indexterm>
<programlisting>
<![CDATA[
>>--columnWidthPX(--colIndex--)------------------><
]]>
</programlisting>
<para>
Gets the width, in pixels, of the specified column in a list-view control when it has the list or report view styles.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>colIndex [required]</term>
<listitem>
<para>
The zero-based index of the column to query.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The width of the column, in pixels, on success or zero on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">colIndex</emphasis> argument is ignored when the list-view has the list style.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::columnWidthPX() -->
<section id="mthDeleteClsListView" xreflabel="delete"><title>delete</title>
<indexterm><primary>delete</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>delete</secondary></indexterm>
<programlisting>
<![CDATA[
>>--delete(--index--)----------------------------><
]]>
</programlisting>
<para>
Deletes the specified item from the list-view control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The zero-based index of the item to delete.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0 on success, 1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example deletes the seleceted item.
<programlisting>
<![CDATA[
::method deleteSelectedItem
list = self~newListView(IDC_LV_RACECARS)
index = list~selected
if index <> -1 then
list~delete(index)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::delete() -->
<section id="mthDeleteAllClsListview" xreflabel="deleteAll"><title>deleteAll</title>
<indexterm><primary>deleteAll</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>deleteAll</secondary></indexterm>
<programlisting>
<![CDATA[
>>--deleteAll------------------------------------><
]]>
</programlisting>
<para>
Deletes all items from the list-view control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0 on success, 1 on error.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::deleteAll() -->
<section id="mthDeleteColumn" xreflabel="deleteColumn"><title>deleteColumn</title>
<indexterm><primary>deleteColumn</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~deleteColumn(--column--)-----------------------><
]]>
</programlisting>
<para>The deleteColumn method removes a column from a
list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>column</term>
<listitem><para>The number of the column to be deleted. The first column must be deleted
last.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The column was deleted.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">column</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthDeselect" xreflabel="deselect"><title>deselect</title>
<indexterm><primary>deselect</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~deselect(--item--)-----------------------------><
]]>
</programlisting>
<para>The deselect method deselects an item.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The item was selected.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthDeselectAll" xreflabel="deselectAll"><title>deselectAll</title>
<indexterm><primary>deselectAll</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>deselectAll</secondary></indexterm>
<programlisting>
<![CDATA[
>>--deselectAll----------------------------------><
]]>
</programlisting>
<para>
Deselects all items in the list-view.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has not arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the number of items deselected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example deselects any selected items in the list-view.
<programlisting>
<![CDATA[
self~newListView(IDC_LV_ADDRESSES)~deselectAll
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::deselectAll() -->
<section id="mthDropHighLighted" xreflabel="dropHighlighted"><title>dropHighlighted</title>
<indexterm><primary>dropHighlighted</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~DropHighlighted--------------------------------><
]]>
</programlisting>
<para>The dropHighlighted method retrieves the item that
is highlighted as a drag-and-drop target.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the selected item, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthEdit" xreflabel="edit"><title>edit</title>
<indexterm><primary>edit</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~edit(--item--)---------------------------------><
]]>
</programlisting>
<para>The edit method begins editing of the text of the
specified list-view item.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The handle of the edit control used to edit the item text, or 0 in all
other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthEndEdit" xreflabel="endEdit"><title>endEdit</title>
<indexterm><primary>endEdit</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~EndEdit----------------------------------------><
]]>
</programlisting>
<para>The endEdit method cancels editing of the list
view item that is being edited.</para>
</section>
<section id="mthEnsureVisible" xreflabel="ensureVisible"><title>ensureVisible</title>
<indexterm><primary>ensureVisible</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
+-0-+
>>-aListControl~ensureVisible(--item--,--+---+--)--------------><
+-1-+
]]>
</programlisting>
<para>The ensureVisible method ensures that a list-view
item is entirely or partially visible by scrolling the list-view control,
if necessary.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item visible.
</para></listitem></varlistentry>
<varlistentry><term>partial</term>
<listitem><para>Specifies whether the item must be entirely visible:
<variablelist>
<varlistentry><term>1</term>
<listitem><para>The list-view control is not scrolled if the item is at least partially
visible.
</para></listitem></varlistentry>
<varlistentry><term>0</term>
<listitem><para>The list-view control is scrolled if the item is only partially visible.
This is the default.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The item is visible.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthFindClsListView" xreflabel="find"><title>find</title>
<indexterm><primary>find</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
+- -1--+ +-0-+
>>-aListControl~find(--text--,--+------+--,--+---+--)----------><
+-item-+ +-1-+
]]>
</programlisting>
<para>The find method searches for a list-view item containing <emphasis role="italic">text</emphasis>. The text of this item must exactly match <emphasis role="italic">text</emphasis>.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>text</term>
<listitem><para>The text of the item to be searched for.
</para></listitem></varlistentry>
<varlistentry><term>item</term>
<listitem><para>Specify the number of the item at which the search is to be started.
Specify -1 or omit this argument to start the search at the beginning.
</para></listitem></varlistentry>
<varlistentry><term>wrap</term>
<listitem><para>Specify 1 if the search is to be continued at the beginning if no match
is found. Specify 0 or omit this argument if the search is to stop at the
end of the list.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the item, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthFindNearestXY" xreflabel="findNearestXY"><title>findNearestXY</title>
<indexterm><primary>findNearestXY</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~findNearestXY(--x--,--y--+--------------------+--)-><
| +-DOWN--+ |
+-,--"--+-UP----+--"-+
+-LEFT--+
+-RIGHT-+
]]>
</programlisting>
<para>The findNearestXY method searches, in the specified
direction, for the item nearest to the specified position.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>x</term>
<listitem><para>The x-coordinate of the position at which the search is to be started.
</para></listitem></varlistentry>
<varlistentry><term>y</term>
<listitem><para>The y-coordinate of the position at which the search is to be started.
</para></listitem></varlistentry>
<varlistentry><term>direction</term>
<listitem><para>The direction in which the search should proceed.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The index of the item, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthFindPartial" xreflabel="findPartial"><title>findPartial</title>
<indexterm><primary>findPartial</primary></indexterm>
<programlisting>
<![CDATA[
+- -1--+ +-0-+
>>-aListControl~findPartial(--text--,--+------+--,--+---+--)---><
+-item-+ +-1-+
]]>
</programlisting>
<para>The findPartial method searches for a list-view
item containing <emphasis role="italic">text</emphasis>. An item matches if its text begins with <emphasis role="italic">text</emphasis>.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>text</term>
<listitem><para>The text of the item to be searched for.
</para></listitem></varlistentry>
<varlistentry><term>item</term>
<listitem><para>Specify the number of the item at which the search is to be started.
Specify -1 or omit this argument to start the search at the beginning.
</para></listitem></varlistentry>
<varlistentry><term>wrap</term>
<listitem><para>Specify 1 if the search is to be continued at the beginning if no match
is found. Specify 0 or omit this argument if the search is to stop at the
end of the list.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the item, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthFirstVisible" xreflabel="firstVisible"><title>firstVisible</title>
<indexterm><primary>firstVisible</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~FirstVisible-----------------------------------><
]]>
</programlisting>
<para>The firstVisible method retrieves the number of
the first item visible in a list or report view.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the first item visible, or 0 if the list-view control
is in icon or small-icon view.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthFocus" xreflabel="focus"><title>focus</title>
<indexterm><primary>focus</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~focus(--item--)--------------------------------><
]]>
</programlisting>
<para>The focus method assigns the focus to the specified
item, which is then surrounded by the standard focus rectangle. Although more
than one item can be selected, only one item can have the focus.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item to receive the focus.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The specified item received the focus.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthFocused" xreflabel="focused"><title>focused</title>
<indexterm><primary>focused</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~Focused----------------------------------------><
]]>
</programlisting>
<para>The focused method retrieves the number of the
item that has currently the focus.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the item with the focus, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetCheck" xreflabel="getCheck"><title>getCheck</title>
<indexterm><primary>getCheck</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~getCheck(--index--)-----------------------------------------><
]]>
</programlisting>
<para>The <computeroutput>getCheck</computeroutput> method determines if the
item at the specified list index has a checked check box. This method will
return a code indicating that the list-view control does not have the check
boxes extended style, if appropriate. (See the
<xref linkend="mthAddExtendedStyle"/> method for a description
of the check boxes extended style.)
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>index</term>
<listitem><para>The index of the item to query.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return values are:
<variablelist>
<varlistentry><term>1</term>
<listitem><para>The item has a check box that is checked.
</para></listitem></varlistentry>
<varlistentry><term>0</term>
<listitem><para>The item has a check box, and it is not checked.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>An (internal) problem with the control's window handle.
</para></listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem><para>The list-view control does not have the check boxes extended
style.
</para></listitem></varlistentry>
<varlistentry><term>-3</term>
<listitem><para>The index is invalid.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example could be used as a shortcut method to
determine if a list-view control currently has the check box extended style.
<programlisting>
<![CDATA[
...
list = self~newListView(IDC_LV_DOCTORS)
if list~getCheck(0) == -2 then
return -- The list-view does not currently have the check box style in effect
do i = 0 to list~items - 1
...
end
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetColumnCount" xreflabel="getColumnCount"><title>getColumnCount</title>
<indexterm><primary>getColumnCount</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getColumnCount----------------------------------------------------><
]]>
</programlisting>
<para>
This method returns the number of columns in the list-view control when it is in report view.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method returns the number of columns, or -1 on some error. An error is unlikely.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This method is straight forward to use:
<programlisting>
<![CDATA[
colCount = list~getColumnCount
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListControl::getColumnCount() -->
<section id="mthGetColumnInfo" xreflabel="getColumnInfo"><title>getColumnInfo</title>
<indexterm><primary>getColumnInfo</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getColumnInfo</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getColumnInfo(--index--,--directory--)-------><
]]>
</programlisting>
<para>
Retrieves information for the column specified in a <computeroutput>Directory</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The zero-based index of the column to retrieve information for. Columns are numbered from the left to the right.
</para>
</listitem></varlistentry>
<varlistentry><term>directory [required]</term>
<listitem>
<para>
A <computeroutput>Directory</computeroutput> object whose indexes will be filled with the returned column
information. On success, the <computeroutput>Directory</computeroutput> object will have the following indexes
with the corresponding information:
<variablelist>
<varlistentry><term><emphasis role="bold">text</emphasis></term>
<listitem>
<para>
The text (label) for the column.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">subitem</emphasis></term>
<listitem>
<para>
The index of the subitem associated with the column.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">width</emphasis></term>
<listitem>
<para>
The width, in pixels, of the column.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">fmt</emphasis></term>
<listitem>
<para>
A series of blank separated key words specifying the format for the column. See the remarks.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns <computeroutput>.true</computeroutput> on success and <computeroutput>.false</computeroutput> on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
No other indexes in the <emphasis role="italic">directory</emphasis> object will be touched other than those noted.
On error, the value of the noted indexes is undefined.
</para>
<para>
The <computeroutput>fmt</computeroutput> index, at this time, will contain exactly one keyword, either LEFT, RIGHT,
or CENTER denoting the alignment of the text for the column. However, the underlying list-view control has a number
of other format attributes. These other attributes are currently ignored by the ooDialog framework. Future versions
of ooDialog may be enhanced to include more keywords.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example displays information about the column when the user clicks on it:
<programlisting>
<![CDATA[
::method onColumnClick
use arg id, column
listView = self~newListView(IDC_LV_PROPERTIES)
d = .Directory~new
if listView~getColumnInfo(column, d) then do
msg = "Column Title : " d~text || .endOfLine || -
"Column Number: " d~subitem || .endOfLine || -
"Column Width : " d~width || .endOfLine || -
"Alignment : " d~fmt
j = MessageDialog(msg, self~hwnd, "List View Column Information")
end
else do
j = MessageDialog("Failed to get column information.", self~hwnd, "Windows API Error")
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getColumnInfo() -->
<section id="mthGetColumnOrder" xreflabel="getColumnOrder"><title>getColumnOrder</title>
<indexterm><primary>getColumnOrder</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getColumnOrder----------------------------------------------------><
]]>
</programlisting>
<para>
Retrieves the current column order of the list-view when in report view. The order of the columns can
be changed programmatically by using the <xref linkend="mthSetColumnOrder"/>()
method. In XP and later there is also an <xref linkend="mthAddExtendedStyle"/> style
which lets the user rearrange the order of the columns. If the list-view control has not had the
columns rearranged, then the column order will always be 0, 1, 2, ... of course.
</para>
<para>
One practical use of this method would be in conjunction with the
<xref linkend="mthSetColumnOrder"/>() method. In an application where the user can
rearrange the column order, the programmer could get the order when a dialog closes, save it, and then
restore the order to the user's preference when the application is restarted.
</para>
<para>
Note that the list-view control does not have to have the HEADERDRAGDROP style for the get and set
column order methods to work. That style is only needed to allow the user to rearrange the columns
using drag and drop. The programmer can use <xref linkend="mthSetColumnOrder"/>()
to change the order of the columns whether or not the list-view has the HEADERDRAGDROP style, or not.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return values are:
<variablelist>
<varlistentry><term>an <computeroutput>.Array</computeroutput> object</term>
<listitem>
<para>
An array is returned with the index numbers of the columns. The number at the first position
in the array is the column index of the left-most column. The number in the second position
in the array is the index of the second left-most column, etc..
</para>
</listitem></varlistentry>
<varlistentry><term><computeroutput>.nil</computeroutput></term>
<listitem>
<para>
<computeroutput>.nil</computeroutput> is returned for some unexpected error. This is
unlikely.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example prints out the column order when the dialog is first initialized, and then prints out
the order when the dialog closes.
<programlisting>
<![CDATA[
...
list = self~newListView(100)
columnNames = .array~of("Occupation", "Name", "Age", "Sex")
list~addExtendedStyle("FULLROWSELECT GRIDLINES CHECKBOXES HEADERDRAGDROP")
list~insertColumn(0, columnNames[1], 95)
list~insertColumn(1, columnNames[2], 95)
list~insertColumn(2, columnNames[3], 95)
list~insertColumn(3, columnNames[4], 35)
self~printColumnOrder
...
::method close
self~printColumnOrder
return self~ok:super
::method printColumnOrder private
expose list columnNames
cols = list~getColumnOrder
say 'cols:' cols
say 'Column count: ' list~getColumnCount
say 'Current order:'
if cols~isA(.array) then do c over cols
-- Column indexes are zero-based
c += 1
say " " columnNames[c]
end
/* Output might be, (assuming the user changed the order):
cols: an Array
Column count: 4
Current order:
Occupation
Name
Age
Sex
cols: an Array
Column count:
Current order:
Age
Name
Sex
Occupation
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListControl::getColumnOrder() -->
<section id="mthGetColumnText" xreflabel="getColumnText"><title>getColumnText</title>
<indexterm><primary>getColumnText</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getColumnText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getColumnText(--index--)---------------------><
]]>
</programlisting>
<para>
Retrieves the column header text for a list-view when it is in report view.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The zero-based column index for which to get the text.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the text for the specified column, or the empty string on error.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getColumnText() -->
<section id="mthGetExtendedStyle" xreflabel="getExtendedStyle"><title>getExtendedStyle</title>
<indexterm><primary>getExtendedStyle</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~GetExtendedStyle---------------------------------------------><
]]>
</programlisting>
<para>The <computeroutput>getExtendedStyle</computeroutput> method returns
the extended <link linkend="listControlExtendedStyles">styles</link> of a
<computeroutput>ListView</computeroutput>. The styles are returned as a
string of blank delimited style keywords. These are the same keywords as those
used to set the styles.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>This method takes no arguments.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The returned string can contain one or more of the following
style keywords. See the <xref linkend="mthAddExtendedStyle"/>
method for the style descriptions:
<itemizedlist>
<listitem><para>BORDERSELECT</para></listitem>
<listitem><para>CHECKBOXES</para></listitem>
<listitem><para>DOUBLEBUFFER</para></listitem>
<listitem><para>FLATSB</para></listitem>
<listitem><para>FULLROWSELECT</para></listitem>
<listitem><para>GRIDLINES</para></listitem>
<listitem><para>HEADERDRAGDROP</para></listitem>
<listitem><para>INFOTIP</para></listitem>
<listitem><para>LABELTIP</para></listitem>
<listitem><para>MULTIWORKAREAS</para></listitem>
<listitem><para>ONECLICKACTIVATE</para></listitem>
<listitem><para>REGIONAL</para></listitem>
<listitem><para>SIMPLESELECT</para></listitem>
<listitem><para>SUBITEMIMAGES</para></listitem>
<listitem><para>TRACKSELECT</para></listitem>
<listitem><para>TWOCLICKACTIVATE</para></listitem>
<listitem><para>UNDERLINECOLD</para></listitem>
<listitem><para>UNDERLINEHOT</para></listitem>
</itemizedlist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example comes from a fictious application where
the user can elect to use the track select style, or not. With this style, an
item can be selected by pausing the mouse over it for a period of time specified
by the hover time. The application also allows the user to increase or decrease
the hover time. In this example when the methods to increment or decrement the
hover time are invoked, the application first checks to see if the list-view
control has the track select style. Then the change is only made if the list
view control does have the style.
<programlisting> <![CDATA[
::method initDialog
expose listView
...
listView = self~newListView(IDC_LIST)
if listView == .nil then return
listView~addExtendedStyle("CHECKBOXES FULLROWSELECT TRACKSELECT")
...
::method onCheckboxClick
expose listView
chkBox = self~newCheckBox(IDC_CHECK_USETRACKSELECT)
if chkBox~checked then
listView~addExtendedStyle("TRACKSELECT")
else
listView~removeExtendedStyle("TRACKSELECT")
::method onDecrement
expose listView
styles = listView~getExtendedStyle
if styles~wordpos("TRACKSELECT") == 0 then return
time = listView~getHoverTime - 100
if time > 0 then listView~setHoverTime(time)
::method onIncrement
expose listView
styles = listView~getExtendedStyle
if styles~wordpos("TRACKSELECT") == 0 then return
-- Let the user increase the hover time to any length they want.
listView~setHoverTime(list~getHoverTime + 100)
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetExtendedStyleRaw" xreflabel="getExtendedStyleRaw"><title>getExtendedStyleRaw</title>
<indexterm><primary>getExtendedStyleRaw</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~GetExtendedStyleRaw------------------------------------------><
]]>
</programlisting>
<para>The <computeroutput>getExtendedStyleRaw</computeroutput> method returns
the extended <link linkend="listControlExtendedStyles">styles</link> of a
<computeroutput>ListView</computeroutput> as the numeric value of the
extended style flags. This method is provided for programmers familiar with the
Windows API who may wish to know, or to work with, the actual value of the
flags.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>This method takes no arguments.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The returned value is the numeric value of the extended style
flags currently in effect for the list-view control.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example is the same example as the
<xref linkend="mthGetExtendedStyle"/> example. It simply
replaces the <computeroutput>getExtendedStyle</computeroutput> invocation with a
<computeroutput>getExtendedStyleRaw</computeroutput> invocation.
<programlisting> <![CDATA[
::method initDialog
expose listView
...
listView = self~newListView(IDC_LIST)
if listView == .nil then return
listView~addExtendedStyle("CHECKBOXES FULLROWSELECT TRACKSELECT")
...
::method onCheckboxClick
expose listView
chkBox = self~newCheckBox(IDC_CHECK_USETRACKSELECT)
if chkBox~checked then
listView~addExtendedStyle("TRACKSELECT")
else
listView~removeExtendedStyle("TRACKSELECT")
::method onDecrement
expose listView
if .DlgUtil~and(listView~getExtendedStyleRaw, "0x00000008") == 0 then return
time = listView~getHoverTime - 100
if time > 0 then listView~setHoverTime(time)
::method onIncrement
expose listView
if .DlgUtil~and(listView~getExtendedStyleRaw, "0x00000008") == 0 then return
-- Let the user increase the hover time to any length they want.
listView~setHoverTime(list~getHoverTime + 100)
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetFullRow" xreflabel="getFullRow"><title>getFullRow</title>
<indexterm><primary>getFullRow</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getFullRow</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getFullRow(--itemIndex--+-----------------+--)--------------><
+-,-useForSorting-+
]]>
</programlisting>
<para>
Returns a <link linkend="clsLvFullRow">LvFullRow</link> object for the specified item in this list view.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>itemIndex [required]</term>
<listitem>
<para>
The index of the list-view item to get the full row for.
</para>
</listitem></varlistentry>
<varlistentry><term>sortable [optional]</term>
<listitem>
<para>
The <emphasis role="italic">sortable</emphasis> argument must be true or false. If true, the ooDialog framework sets
up some internal housekeeping that allows internal sorting of list-view items. If <emphasis
role="italic">sortable</emphasis> is false, this internal housekeeping is skipped. The default if <emphasis
role="italic">sortable</emphasis> is omitted is false. See the remarks section for more details.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
On success, returns a <computeroutput>LvFullRow</computeroutput> object whose attributes are the attributes of the
list-view item specified. On error the <computeroutput>.nil</computeroutput> object is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
<computeroutput>LvFullRow</computeroutput> objects reflect the attributes of a list-view item and all the subitems of
that item. It is common to think of a row when the list-view is in report view. However, once the subitems are added to a
list-view item, they exist even when the view of the list-view is changed to one of the other views, like icon, or small
icon.
</para>
<para>
The <xref linkend="mthSortItems"/> method is used to do custom sorting of list-view items. The sorting is dependent on
the user data <link linkend="mthSetItemDataClsListView">item</link> being set for each list-view item. In addition, the
<emphasis role="italic">sortItems</emphasis> method can be used to signal the ooDialog framework to use native internal
code for the sorting. For the internal sort to work, the user data item must be a
<computeroutput>LvFullRow</computeroutput> object. The returned object from <emphasis role="italic">getFullRow</emphasis>
can be set as the user data item to allow the interanl sorting. When invoking <emphasis
role="italic">setItemData</emphasis> with a <computeroutput>LvFullRow</computeroutput> object as the argument, the
internal house keeping that the ooDialog framework needs to do for internal sorts is done automatically. However, if the
returned full row object is instead used to insert or add a new item into the list-view, this internal house keeping may
be bypassed. For this case, the <emphasis role="italic">sortable</emphasis> argument should be used and set to true.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example loops through all the items in a list-view, gets a full row for each item, and uses the full row as the user
item data. Once this is done, the list-view items can be sorted using ooDialog's internal method. <emphasis
role="bold">Note</emphasis> that the <emphasis role="italic">sortable</emphasis> argument is not used here. Invoking
<emphasis role="italic">setItemData</emphasis> using the full row object is sufficient:
<programlisting>
<![CDATA[
list = self~newListView(IDC_LV_CONTACTS)
do i = 1 to list~items
j = i - 1
row = list~getFullRow(j)
list~setItemData(j, row)
end
]]>
</programlisting>
</para>
<para>
This example is similar to the first example, however in addition to setting the item data, the full row object is used
to insert a new item into the list-view. <emphasis role="bold">Note</emphasis> that the <emphasis
role="italic">sortable</emphasis> argument is used here. Once the loop finishes, the entire list can be sorted using the
ooDialog internal sort.
<programlisting>
<![CDATA[
list = self~newListView(IDC_LV_CONTACTS)
do i = 1 to list~items
j = i - 1
row = list~getFullRow(j, .true)
list~setItemData(j, row)
list~addFullRow(row)
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getFullRow() -->
<section id="mthGetHoverTime" xreflabel="getHoverTime"><title>getHoverTime</title>
<indexterm><primary>getHoverTime</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getFullRow</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getHoverTime---------------------------------><
]]>
</programlisting>
<para>
This method retrieves the current hover time. The hover time is expressed as milliseconds. The hover time only affects
list-view controls that have the track select, one click activate, or two click activate extended list-view
styles. See the <xref linkend="mthAddExtendedStyle"/> method for a description of these styles.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method takes no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The hover time for the list-view. A value of -1 indicates the hover time is the system default hover time.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example comes from a program where the one click activate and track select styles are enabled. Originally
the hover time is set to .4 seconds. However the application allows the users to increase or decrease this time to match
their preference. A menu item (or a button could be used) is connected to the
<computeroutput>onIncrement</computeroutput> and <computeroutput>onDecrement</computeroutput> methods. When either of
the methods is invoked, the current hover time is examined and then either incremented or decremented by .1 of a second.
<programlisting>
<![CDATA[
::method initDilaog
expose list
...
list = self~newListView(IDC_LIST)
list~addExtendedStyle("ONECLICKACTIVATE TRACKSELECT FULLROWSELECT")
list~setHoverTime(400)
...
::method onDecrement
expose list
time = list~getHoverTime - 100
if time > 0 then list~setHoverTime(time)
::method onIncrement
expose list
-- Let the user increase the hover time to any length they want.
list~setHoverTime(list~getHoverTime + 100)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getHoverTime() -->
<section id="mthGetImageListClsListView" xreflabel="getImageList"><title>getImageList</title>
<indexterm><primary>getImageList</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getImageList(--+--------+--)------------------------------------><
+--type--+
]]>
</programlisting>
<para>
Retrieves the current image list for the type specified. The default is to retrieve the image list for
the normal icons. See the <xref linkend="mthSetImageListClsListView"/> method for information
on assigning an image list to a list-view control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>The single optional argument is:
<variablelist>
<varlistentry><term>type</term>
<listitem>
<para>
Optional. Specifies which image list to retrieve. You can use the <xref linkend="mthToIDClsImage"/> method of the
<xref linkend="clsImage"/> class to get the correct numeric value for one of the following symbols:
<simplelist type='horiz' columns='2'>
<member>LVSIL_NORMAL</member>
<member>LVSIL_SMALL </member>
<member>LVSIL_STATE </member>
</simplelist>
or use the correct numeric value itself. Note that there is also a LVSIL_GROUPHEADER symbol,
but ooDialog does not yet support it.
</para>
<para>
The default is LVSIL_NORMAL.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method returns the current image <xref linkend="clsImageList"/>, if there is one.
<computeroutput>.nil</computeroutput> is returned if there is no current image list of the type
specified.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from a complex application that opens and closes a large number of dialogs and
uses many list-view controls. All the list-view controls share the same image lists. When the last
dialog is closed, the shared image lists are released to free up system resources as the
application enters its next phase.
<programlisting>
<![CDATA[
::method ok
self~checkImageLists
return self~ok:super
::method cancel
self~checkImageLists
return self~cancel:super
::method checkImageLists
expose list
if self~amLastDialog then do
types = .array~of(LVSIL_NORMAL, LVSIL_SMALL, LVSIL_STATE)
do type over types
il = list~getImageList(type)
if il \== .nil then il~release
end
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListControl::getImageList() -->
<section id="mthGetItem" xreflabel="getItem"><title>getItem</title>
<indexterm><primary>getItem</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getItem</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getItem(--itemIndex--)-----------------------><
]]>
</programlisting>
<para>
Returns a <link linkend="clsLvItem">LvItem</link> object for the item specified.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>itemIndex [required]</term>
<listitem>
<para>
Specifies which list-view item to get.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
On success, returns a <computeroutput>LvItem</computeroutput> object whose attributes represent the attributes of the
list-view item. On error, the <computeroutput>.nil</computeroutput> object is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getItem() -->
<section id="mthGetItemDataClsListView" xreflabel="getItemData"><title>getItemData</title>
<indexterm><primary>getItemData</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getItemData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getItemData(--index--)-----------------------><
]]>
</programlisting>
<para>
Gets the user data associated with the specified list-view item.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The zero-based index of the item to retrieve the user data from.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the user data associated with the specified item, or the <computeroutput>.nil</computeroutput> object if
there is no data associated with the item.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The list-view control allows the user (the Rexx programmer) to associate a data value with any, or all, of the
list-view items. The data value can be any ooRexx object. The data value is set using the
<xref linkend="mthSetItemDataClsListView"/> method. If needed the data value can be removed from a list-view item
through the <xref linkend="mthRemoveItemDataClsListView"/> method. Storing a user value for each item can
be useful in any number of ways. One specific use is in the <xref linkend="mthSortItems"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example uses the data value stored for each item to display extra employee information when the user double
clicks on an item in a list-view that displays each employee. Note that the Rexx object stored for each list-view
item is a <computeroutput>Directory</computeroutput> object:
<programlisting>
<![CDATA[
::method onDoubleClick
expose list
use arg id, index, subitem, flags
tab = '9'x
if index <> -1 then do
data = list~getItemData(index)
msg = 'Extra Information for' data~fName data~lName || .endOfLine~copies(2)
select
when subItem == 0 then do
msg ||= 'Employee ID:' || tab || data~ID || .endOfLine
msg ||= 'Manager:' || tab~copies(2) || data~manager || .endOfLine
end
when subitem == 1 then do
msg ||= 'Telephone:' || tab || data~telephone || .endOfLine
msg ||= 'Cellphone:' || tab || data~cell || .endOfLine
end
when subitem == 2 then do
msg ||= 'Pay scale:' || tab || data~scale || .endOfLine
msg ||= 'Status:' || tab || data~empStatus || .endOfLine
end
otherwise do
-- insurance, can't happen
nop
end
end
-- End select
title = 'Acme Plumbing Employee Statistics'
z = MessageDialog(msg, self~hwnd, title, 'OK')
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getItemData() -->
<section id="mthGetItemInfo" xreflabel="getItemInfo"><title>getItemInfo</title>
<indexterm><primary>getItemInfo</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getItemInfo</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getItemInfo(--index--,--directory--+------------+--)--------><
+-,-subItem--+
]]>
</programlisting>
<para>
Returns the attributes of an item, or one of its subitems, in a <computeroutput>Directory</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>index</term>
<listitem>
<para>
The zero-based index of the item whose information is to be retrieved. If the <emphasis
role="italic">subItem</emphasis> argument is specified, then the information for the subitem of this item is
returned.
</para>
</listitem></varlistentry>
<varlistentry><term>directory [required]</term>
<listitem>
<para>
A <computeroutput>Directory</computeroutput> object whose indexes will be filled with the returned item
information. On success, the <computeroutput>Directory</computeroutput> object will have the following
indexes with the corresponding information:
<variablelist>
<varlistentry><term><emphasis role="bold">text</emphasis></term>
<listitem>
<para>
The text of the item, or subitem.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">image</emphasis></term>
<listitem>
<para>
The index in the image list for the icon, (both big and small,) for the item. If the item does not have an
icon in image list, the value will be -1.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">state</emphasis></term>
<listitem>
<para>
Zero or more blank separated keywords indicating the state of the item. The possible state keywords are:
<variablelist>
<varlistentry><term><emphasis role="bold">CUT</emphasis></term>
<listitem>
<para>
The item is marked for a cut-and-paste operation.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">DROP</emphasis></term>
<listitem>
<para>
The item is highlighted as a drag-and-drop target.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">FOCUSED</emphasis></term>
<listitem>
<para>
The item has the focus, so it is surrounded by a standard focus rectangle. Although more than one item
may be selected, only one item can have the focus.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">SELECTED</emphasis></term>
<listitem>
<para>
The item is selected. The appearance of a selected item depends on whether it has the focus and also on
the system colors used for selection.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>subitem [optional]</term>
<listitem>
<para>
The one-based index of a subitem. If <emphasis role="italic">subitem</emphasis> is omitted, or zero, the
information for the item with the <emphasis role="italic">index</emphasis> specified is retrieved. If a subitem
index is specified, the information for the item's specified subitem is retrieved instead.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns <computeroutput>.true</computeroutput> on success and <computeroutput>.false</computeroutput> on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example displays information on a selected item in the list-view:
<programlisting>
<![CDATA[
::method displayItemInfo
listView = self~newListView(IDC_LV_JOBS_PER_STATE)
title = "Selected Item Information"
buttons = "ok"
icon = "information"
item = listView~selected
if item == -1 then do
msg = "No item is selected."
buttons = "cancelTryContinue"
end
else do
d = .Directory~new
if listView~getItemInfo(item, d) then do
msg = "Item Text : "d~text || .endOfLine || -
"Image Index: "d~image || .endOfLine || -
"Item State : "d~state
end
else do
msg = "Windows API error. No information available."
buttons = "abortRetryIgnore"
icon = "error"
end
end
return MessageDialog(msg, self~hwnd, title, buttons, icon)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getItemInfo() -->
<section id="mthGetItemPos" xreflabel="getItemPos"><title>getItemPos</title>
<indexterm><primary>getItemPos</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getItemPos</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getItemPos(--index--)------------------------><
]]>
</programlisting>
<para>
Retrieves the <xref linkend="defClientArea"/> coordinates of an item in a list-view control as a
<computeroutput>Point</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single arguments is:
<variablelist>
<varlistentry><term>index</term>
<listitem>
<para>
The zero-based index of the item whose position is needed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
On success, returns a <xref linkend="clsPoint"/> object containing the position of the upper left corner
of the item specified, relative to the client area of the list-view.
</para>
<para>
On error, 0 is returned. See the remarks
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Since quite often list-view controls contain more items than can fit in the client area of the list-view, the
position returned by <emphasis role="italic">getItemPos</emphasis> may be outside of the client area rectangle. This
implies that both the x and y coordinates in the returned position may be negative. For instance, take a list-view
that has 400 items and more columns than fit in the list-view. If the user has scrolled the list-view all the way
to the bottom right and <emphasis role="italic">getItemPos</emphasis> is used to get the position of item 5, both
the x and y position will be negative.
</para>
<para>
Experimentation has shown that if the <emphasis role="italic">index</emphasis> specified is larger than the actual
number items in the list-view, the list-view still returns a position. The position seems to be correct for the
<emphasis role="italic">index</emphasis>, if the list-view did have that item. Because of this, it seems unlikely
this method will ever fail.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getItemPos() -->
<section id="mthGetSubitemClsListView" xreflabel="getSubitem"><title>getSubitem</title>
<indexterm><primary>getSubitem</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getSubitem</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getSubitem(--itemIndex--,--subitemIndex--)---><
]]>
</programlisting>
<para>
Retrieves the specified subitem as a <link linkend="clsLvSubItem">LvSubItem</link> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>itemIndex [required]</term>
<listitem>
<para>
Specifies the item index whose subitem is to be retrieved.
</para>
</listitem></varlistentry>
<varlistentry><term>subitemIndex</term>
<listitem>
<para>
Specifies the index of the subitem.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
On success, returns a <computeroutput>LvItem</computeroutput> object whose attributes represent the attributes of the
list-view item. On error, the <computeroutput>.nil</computeroutput> object is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getSubitem() -->
<section id="mthGetToolTipsClsListview" xreflabel="getToolTips"><title>getToolTips</title>
<indexterm><primary>getToolTips</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>getToolTips</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getToolTips----------------------------------><
]]>
</programlisting>
<para>
Retrieves the child <link linkend="clsToolTip">ToolTip</link> control used by this list-view.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the child Rexx <computeroutput>ToolTip</computeroutput> object, or the <computeroutput>.nil</computeroutput>
object if the list-view does not have a child tool tip control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::getToolTips() -->
<section id="mthHasCheckBoxes" xreflabel="hasCheckBoxes"><title>hasCheckBoxes</title>
<indexterm><primary>hasCheckBoxes</primary></indexterm>
<indexterm><primary>Listview class</primary><secondary>hasCheckBoxes</secondary></indexterm>
<programlisting>
<![CDATA[
>>--hasCheckBoxes--------------------------------><
]]>
</programlisting>
<para>
Determines if the list-view has the CHECKBOXES extended style.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns <computeroutput>.true</computeroutput> if the list-view has the CHECKBOXES extended style, otherwise
<computeroutput>.false</computeroutput> .
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Listview::hasCheckBoxes() -->
<section id="mthHitTestInfoClsListView" xreflabel="hitTestInfo"><title>hitTestInfo</title>
<indexterm><primary>hitTestInfo</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>hitTestInfo</secondary></indexterm>
<programlisting>
<![CDATA[
Form 1:
>>--hitTestInfo(--pos--+---------+--)------------><
+-,-info--+
Form 2:
>>--hitTestInfo(--x--,--y--+---------+--)--------><
+-,-info--+
Generic Form:
>>--hitTestInfo(--hitPoint--+---------+--)-------><
+-,-info--+
]]>
</programlisting>
<para>
Determines which list-view item, if any, is at the specified position.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>hitPoint [required]</term>
<listitem>
<para>
The point, in <xref linkend="defScreenCoordinates"/> area coordinates, to test.
</para>
</listitem></varlistentry>
<varlistentry><term>info [optional in / out]</term>
<listitem>
<para>
A <computeroutput>.Directory</computeroutput> object in which additional information concerning the hit test
will be returned. This argument can be omitted if the additional information is not needed. When the argument is
used, on return <emphasis role="italic">info</emphasis> will contain some, or all, of the following indexes,
depending on the version of Windows:
</para>
<variablelist>
<varlistentry><term>INFO</term>
<listitem>
<para>
A string of keywords containing information about the hit test. One or more of the following keywords will be
present:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>Above </member>
<member>Below </member>
<member>ToRight </member>
<member>ToLeft </member>
<member>Nowhere </member>
<member>OnIcon </member>
<member>OnLabel </member>
<member>OnStateIcon</member>
<member>OnItem </member>
</simplelist>
<variablelist>
<varlistentry><term>Above</term>
<listitem>
<para>
The position is above the list-view's client area.
</para>
</listitem></varlistentry>
<varlistentry><term>Below</term>
<listitem>
<para>
The position is below the list-view's client area.
</para>
</listitem></varlistentry>
<varlistentry><term>ToRight</term>
<listitem>
<para>
The position is to the right of the list-view's client area.
</para>
</listitem></varlistentry>
<varlistentry><term>ToLeft</term>
<listitem>
<para>
The position is to the left of the list-view's client area.
</para>
</listitem></varlistentry>
<varlistentry><term>Nowhere</term>
<listitem>
<para>
The position is inside the list-view control's client window, but it is not over a list item.
</para>
</listitem></varlistentry>
<varlistentry><term>OnIcon</term>
<listitem>
<para>
The position is over a list-view item's icon.
</para>
</listitem></varlistentry>
<varlistentry><term>OnLabel</term>
<listitem>
<para>
The position is over a list-view item's text.
</para>
</listitem></varlistentry>
<varlistentry><term>OnStateIcon</term>
<listitem>
<para>
The position is over the state image of a list-view item.
</para>
</listitem></varlistentry>
<varlistentry><term>OnItem</term>
<listitem>
<para>
The position is over a list-view item. This is a combination of <emphasis role="italic">OnIcon</emphasis>,
or <emphasis role="italic">OnLabel</emphasis>, or <emphasis role="italic">OnStateIcon</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>INFOEX</term>
<listitem>
<para>
This index will only be present on Vista or later and is a string of keywords containing extended information
about the hit test. The index may contain one or more of the following keywords:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>Footer </member>
<member>Group </member>
<member>GroupBackground</member>
<member>GroupCollapse </member>
<member>GroupFooter </member>
<member>GroupHeader </member>
<member>GroupStateIcon </member>
<member>GroupSubsetLink</member>
<member>OnContents </member>
</simplelist>
<variablelist>
<varlistentry><term>Footer</term>
<listitem>
<para>
The point is within the footer of the list-view control.
</para>
</listitem></varlistentry>
<varlistentry><term>Group</term>
<listitem>
<para>
The point is within a group. This is a combination of <emphasis role="italic">GroupBackground</emphasis>,
or <emphasis role="italic">GroupCollapse</emphasis>, or <emphasis
role="italic">GroupFooter</emphasis>, or <emphasis role="italic">GroupHeader</emphasis>, or <emphasis
role="italic">GroupStateIcon</emphasis>, or <emphasis role="italic">GroupSubsetLink</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>GroupBackground</term>
<listitem>
<para>
The point is within the area of the group where items are displayed.
</para>
</listitem></varlistentry>
<varlistentry><term>GroupCollapse</term>
<listitem>
<para>
The point is within the collapse/expand button of the group.
</para>
</listitem></varlistentry>
<varlistentry><term>GroupFooter</term>
<listitem>
<para>
The point is within the group footer.
</para>
</listitem></varlistentry>
<varlistentry><term>GroupHeader</term>
<listitem>
<para>
The point is within the group header.
</para>
</listitem></varlistentry>
<varlistentry><term>GroupStatIcon</term>
<listitem>
<para>
The point is within the state icon of the group.
</para>
</listitem></varlistentry>
<varlistentry><term>GroupSubsetLink</term>
<listitem>
<para>
The point is within the subset link of the group.
</para>
</listitem></varlistentry>
<varlistentry><term>OnContents</term>
<listitem>
<para>
The point is within the icon or text content of the item and not on the background.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>ITEM</term>
<listitem>
<para>
The index of the item if the point hits an item or subitem. -1 if the point did not hit an item or subitem.
</para>
</listitem></varlistentry>
<varlistentry><term>SUBITEM</term>
<listitem>
<para>
The subitem index if the point hits a subitem, otherwise 0.
</para>
</listitem></varlistentry>
<varlistentry><term>GROUP</term>
<listitem>
<para>
Vista or later only. The group index of the item hit. This is valid only for owner data. If the point is
within an item that is displayed in multiple groups then GROUP will specify the group index of the item.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The index of the list-view item hit, or -1 if the point does not hit an item.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Sometimes the returned index of the hit spot is all that is needed. In these cases, there is no need to supply the
optional <computeroutput>.Directory</computeroutput> object. However, other times the complete hit test information
may be desired.
</para>
<para>
Any x, y coordinates will work. I.e. -6000, -7000 will work. The item index will be -1 and location will be
<emphasis role="italic">Above ToLeft</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example is from a program that allows the user to edit the text of subitems. The code snippet checks if the
point p is over an item's subitem and if so invokes the editing method:
<programlisting>
<![CDATA[
listView = self~newListView(IDC_LV_PLAYERS)
d = .Directory~new
index = listView~hitTestInfo(p, d)
if index <> -1 & d~subItem <> 0 then do
self~subItemEdit(index, d~subItem)
...
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::hitTestInfo() -->
<section id="mthInsertClsListControl" xreflabel="insert"><title>insert</title>
<indexterm><primary>insert</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--insert(--+------+--,--+---------+--,--text--+--------+--)------------------><
+-item-+ +-subitem-+ +-,-icon-+
]]>
</programlisting>
<para>
The <computeroutput>insert</computeroutput> method inserts a new item into the list-view control, or
inserts the text of a subitem.
</para>
<para>
Remember that in a list-view, items and columns use a 0-based index. Subitems use a 1-based index.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>item</term>
<listitem>
<para>
The index of the item to insert or the item whose subitem text is inserted.
</para>
<para>
When this argument is omitted <emphasis role="bold">and</emphasis> <emphasis
role="italic">subitem</emphasis> is omitted or 0, ooDialog uses the index of the last item added to the
list-view control, plus 1, as the item index. If the argument is omitted and <emphasis
role="italic">subitem</emphasis> is greater than 0, then the index of the last item added is used. If
no items have yet been added, then 0 is used.
</para>
</listitem></varlistentry>
<varlistentry><term>subitem</term>
<listitem>
<para>
The subitem number. This argument is used to insert the text for a subitem of the item. In report view,
the label (text) for the item is placed in column 0. The text for subitem 1 is placed in column 1, the
text for subitem 2 is placed in column 2, and so on. If you omit this argument, or use 0, the the
<emphasis role="italic">text</emphasis> argument is assigned as the label (text) of the item. If you
use this argument and it is greater than 0, then the <emphasis role="italic">text</emphasis> argument
is assigned as the text of that subitem. <emphasis role="bold">Note</emphasis> that when this argument
is greater than 0, no new item is inserted into the list-view. Rather, the text of the subitem is
inserted into an existing list-view item.
</para>
</listitem></varlistentry>
<varlistentry><term>text</term>
<listitem>
<para>
The text of the item, or of the subitem, depending on the <emphasis role="italic">subitem</emphasis>
argument.
</para>
</listitem></varlistentry>
<varlistentry><term>icon</term>
<listitem>
<para>
The index of the icon within the image list for this item. Use the
<xref linkend="mthSetImageListClsListView"/>() method to assign an image list to the
list-view control. With <computeroutput>setImageList</computeroutput>(), use the LVSIL_SMALL type to
set the image list for the small icons and the LVSIL_NORMAL type for the normal size icon image list.
</para>
<para>
The normal size icons are used for the icon view and the small icons are used for the list, report, and
small-icon views. Note that there is only one index for each list-view item. This implies that the
normal icon for an item must be at the same index in the normal image list as the small icon is at in
the small icon image list.
</para>
<para>
Use -1 or simply omit this argument to indicate there is no icon for the item being inserted. This
argument is ignored completely if <emphasis role="italic">subitem</emphasis> is greater than 0.
</para>
</listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The index of the new item, or -1 in all other cases.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example inserts items in a list:
<programlisting>
<![CDATA[
::method initReport
curList = self~newListView(102)
if curList \= .nil then
do
curList~insert(, ,"First")
curList~insert(, ,"Second")
curList~insert(, ,"Third")
end
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthInsertColumn" xreflabel="insertColumn"><title>insertColumn</title>
<indexterm><primary>insertColumn</primary></indexterm>
<programlisting>
<![CDATA[
+-0------+
>>-aListControl~insertColumn(--+--------+--,--text--,-->
+-column-+
>--,--width--+---------------------+--)---------------><
| +-LEFT---+ |
+-,--"--+-CENTER-+--"-+
+-RIGHT--+
]]>
</programlisting>
<para>The insertColumn method sets the attributes of
a report list-view column.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>column</term>
<listitem><para>The number of the column. 0 is the first column and the default.
</para></listitem></varlistentry>
<varlistentry><term>text</term>
<listitem><para>The text of the column heading.
</para></listitem></varlistentry>
<varlistentry><term>width</term>
<listitem><para>The width of the column, in dialog units.
</para></listitem></varlistentry>
<varlistentry><term>align</term>
<listitem><para>The alignment of the column heading and the subitem text within the
column. It can be one of the following values:
<variablelist>
<varlistentry><term>CENTER</term>
<listitem><para>The text is centered.
</para></listitem></varlistentry>
<varlistentry><term>LEFT</term>
<listitem><para>The text is left-aligned, which is the default.
</para></listitem></varlistentry>
<varlistentry><term>RIGHT</term>
<listitem><para>The text is right-aligned.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the new column, or 0 if this method fails.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthInsertColumnPX" xreflabel="insertColumnPX"><title>insertColumnPX</title>
<indexterm><primary>insertColumnPX</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>insertColumnPX</secondary></indexterm>
<programlisting>
<![CDATA[
>>--insertColumnPX(--+----------+--,--text--,--width--+--------+--)------------><
+--colNum--+ +-,-fmt--+
]]>
</programlisting>
<para>
Inserts a new column into the list-view.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>colNum [optional]</term>
<listitem>
<para>
The zero-based index for the column being inserted. Columns are numbered from the left to the right. The default
if this argument is omitted is column 0.
</para>
</listitem></varlistentry>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text (label) for the column.
</para>
</listitem></varlistentry>
<varlistentry><term>width [required]</term>
<listitem>
<para>
The width of the column being inserted, specified in pixels.
</para>
</listitem></varlistentry>
<varlistentry><term>fmt [optional]</term>
<listitem>
<para>
One of the following keywords, case is not significant. The keyword specifies the format for the column being
inserted. At this time not all formats for the column are recognized. Other format keywords may be added in the
future.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>LEFT </member>
<member>CENTER</member>
<member>RIGHT </member>
</simplelist>
<variablelist>
<varlistentry><term>LEFT</term>
<listitem>
<para>
Text in the column is aligned to the left. This is the default if this argument is omitted.
</para>
</listitem></varlistentry>
<varlistentry><term>CENTER</term>
<listitem>
<para>
The text for the column is centered.
</para>
</listitem></varlistentry>
<varlistentry><term>RIGHT</term>
<listitem>
<para>
The text for the column is aligned right.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the index of the newly inserted column on success, otherwise -1.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The text for the column must be less than 256 characters long. The inserted columns are only visible when the
list-view is in report view, but, columns can be inserted into the list-view control when it is in any view.
</para>
<para>
This method and the <xref linkend="mthInsertColumn"/> method are virtually the same, except that
in this method the width of the column is specified in pixels. The <emphasis role="italic">insertColumn</emphasis>
method takes dialog units for the width and then converts them to pixels using
<xref linkend="ovvInaccurate"/>. This makes the width used by the <emphasis
role="italic">insertColumn</emphasis> method inaccurate.
</para>
<para>
<emphasis role="bold">Note</emphasis> that previous versions of this documentation incorrectly stated that the
<emphasis role="italic">insertColumn</emphasis> used pixels to specify the width.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example inserts 3 columns into the list-view control. Each column will be 50 pixels wide and left aligned.
<programlisting>
<![CDATA[
::method initReportView
lv = self~newListView(IDC_LV_STATS)
lv~insertColumnPX(0, "First Name", 50)
lv~insertColumnPX(1, "Last Name", 50)
lv~insertColumnPX(2, "Age", 50)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::insertColumnPX() -->
<section id="mthInsertFullRow"><title>insertFullRow</title>
<indexterm><primary>insertFullRow</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>insertFullRow</secondary></indexterm>
<programlisting>
<![CDATA[
>>--insertFullRow(--row--)-----------------------><
]]>
</programlisting>
<para>
Adds an item to the list-view by inserting it into the list at the position specified by the <emphasis
role="italic">row</emphasis> argument.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>row [required]</term>
<listitem>
<para>
A <link linkend="clsLvFullRow">LvFullRow</link> object that specifies the item to be added to the list-view.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
On success, returns the zero-based index of the added row. On error, -1 is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When a full row object is used to add an item to the list view, all the subitems are also added. The <emphasis
role="italic">insertFullRow</emphasis> method always inserts the item into the list at the position specified in the
full row object. The item index in the subitems in the full row object are ignored. After the item is inserted, the
item index in the subitems is updated to the correct value of the newly added item.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::insertFullRow() -->
<section id="mthIsCheckedClsListControl" xreflabel="isChecked"><title>isChecked</title>
<indexterm><primary>isChecked</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~isChecked(--index--)----------------------------------------><
]]>
</programlisting>
<para>The <computeroutput>isChecked</computeroutput> method determines if a
check box for a list-view item is checked or not. This method will always
return true or false. It can be used if the list-view control has or does not
have the check boxes extended style. (See the
<xref linkend="mthAddExtendedStyle"/> method for a description
of the check boxes extended style.)
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>index</term>
<listitem><para>The index of the item to query.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return values are:
<variablelist>
<varlistentry><term>true</term>
<listitem><para>The list-view item has a check box and it is checked.
</para></listitem></varlistentry>
<varlistentry><term>false</term>
<listitem><para>There is no check mark for the list-view item. Either the list
view has check boxes and the check box is not checked, the index is out of range
or not valid, or the list-view does not have the check box extended style.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example is from a doctor's office custom
accounting application. A list box is filled with information for every
patient. After the office manager has finished working with the accounts a
mail merge is done to produce statements for all patients that are to receive
statements for the month. For every patient item in the list-view, if the item
has a check mark, then that patient is mailed a statement.
<programlisting> <![CDATA[
::method onCreateMailMerge
expose patientList
do i = 0 to patientList~items
if billingList~isChecked(i) then do
self~addToMailMerge(billingList, i)
end
end
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthItemInfo" xreflabel="itemInfo"><title>itemInfo</title>
<indexterm><primary>itemInfo</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--itemInfo(--item--,--+--------+--)------------><
+-column-+
]]>
</programlisting>
<para>
The itemInfo method retrieves the attributes of a list-view item as a <computeroutput>Stem</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
<varlistentry><term>column</term>
<listitem><para>The number of the column. If you omit this argument, 0 is assumed.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
A compound variable that stores the attributes of the item, or -1 in all other cases. The compound
variable can be:
<variablelist>
<varlistentry><term>RetStem.!TEXT</term>
<listitem><para>The item text.
</para></listitem></varlistentry>
<varlistentry><term>RetStem.!IMAGE</term>
<listitem><para>
The index of the icon in the image list this for item. Image lists are assigned to list-views using the
<xref linkend="mthSetImageListClsListView"/>() method.
</para>
<para>
In report view, this index is only used for the icon for the first column. ooDialog does not yet
support setting the icon index for the other columns in a report view.
</para>
</listitem></varlistentry>
<varlistentry><term>RetStem.!STATE</term>
<listitem><para>One or more of the following values:
<variablelist>
<varlistentry><term>CUT</term>
<listitem><para>The item is marked for a cut-and-paste operation.
</para></listitem></varlistentry>
<varlistentry><term>DROPPED</term>
<listitem><para>The item is highlighted as a drag-and-drop target.
</para></listitem></varlistentry>
<varlistentry><term>FOCUSED</term>
<listitem><para>The item has the focus and is therefore surrounded by the standard focus
rectangle. Only one item can have the focus.
</para></listitem></varlistentry>
<varlistentry><term>SELECTED</term>
<listitem><para>The item is selected. Its appearance depends on whether it has the focus
and on the system colors used for a selection.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthItemPos" xreflabel="itemPos"><title>itemPos</title>
<indexterm><primary>itemPos</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~itemPos(--item--)------------------------------><
]]>
</programlisting>
<para>The itemPos method retrieves the position of the
upper left corner of the item.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The x- and y-coordinates of the upper left corner of the item, or -1
if you did not specify <emphasis role="italic">item</emphasis>, or 0 in all other cases.
</para></listitem></varlistentry>
</variablelist>
<note><title>Note</title><para>
Use <xref linkend="mthDefListDragHandler"/> to support default dragging:
</para></note>
<programlisting>
<![CDATA[
self~connectListViewEvent(104,"BEGINDRAG","mthDefListDragHandler")
]]>
</programlisting>
</section>
<section id="mthItemsClsListView" xreflabel="items"><title>items</title>
<indexterm><primary>items</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~Items------------------------------------------><
]]>
</programlisting>
<para>The items method retrieves the number of items
in a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of items.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthItemsPerPage" xreflabel="itemsPerPage"><title>itemsPerPage</title>
<indexterm><primary>itemsPerPage</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~ItemsPerPage-----------------------------------><
]]>
</programlisting>
<para>The itemsPerPage method calculates the number of
items that vertically fit the visible area of a list-view control that is
in list or report view. Only fully visible items are counted.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of fully visible items. If the current view is an icon or
small-icon view, the return value is the total number of items in the list
view control.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthItemState" xreflabel="itemState"><title>itemState</title>
<indexterm><primary>itemState</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~itemState(--item--)----------------------------><
]]>
</programlisting>
<para>The itemState method retrieves the state of a list
view item.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The state of the item, which can be one or more of the following values:
<variablelist>
<varlistentry><term>CUT</term>
<listitem><para>The item can be used in a cut-and-paste operation.
</para></listitem></varlistentry>
<varlistentry><term>DROPPED</term>
<listitem><para>The item is highlighted as a drag-and-drop target.
</para></listitem></varlistentry>
<varlistentry><term>FOCUSED</term>
<listitem><para>The item has the focus and is therefore surrounded by the standard focus
rectangle. Only one item can have the focus.
</para></listitem></varlistentry>
<varlistentry><term>SELECTED</term>
<listitem><para>The item is selected. Its appearance depends on whether it has the focus
and on the system colors used for a selection.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthItemText" xreflabel="itemText"><title>itemText</title>
<indexterm><primary>itemText</primary></indexterm>
<programlisting>
<![CDATA[
+-0------+
>>-aListControl~itemText(--item--,--+--------+--)--------------><
+-column-+
]]>
</programlisting>
<para>The itemText method retrieves the text of a list
view item or a column.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
<varlistentry><term>column</term>
<listitem><para>The number of the column. If you omit this argument, 0 is assumed.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The item or column text, or -1 if you did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthLast" xreflabel="last"><title>last</title>
<indexterm><primary>last</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~Last-------------------------------------------><
]]>
</programlisting>
<para>The last method retrieves the number of the last
item in a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the last item.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthLastSelected" xreflabel="lastSelected"><title>lastSelected</title>
<indexterm><primary>lastSelected</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~LastSelected-----------------------------------><
]]>
</programlisting>
<para>The lastSelected method returns the number of the
item selected last.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the item selected last, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthModify" xreflabel="modify"><title>modify</title>
<indexterm><primary>modify</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--modify(--+------+--,--+---------+--,--text--+--------+--)------------------><
+-item-+ +-subitem-+ +-,-icon-+
]]>
</programlisting>
<para>
The <emphasis role="italic">modify</emphasis> method modifies or sets the text for the item label, or
the text for a subitem, for a list-view item. Optionally, it sets or modifies the icon index for a
list-view item.
</para>
<para>
Remember that in a list-view, items and columns use a 0-based index. Subitems use a 1-based index.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>
The index of the item to be modified. If you omit this argument, the selected item is used.
</para></listitem></varlistentry>
<varlistentry><term>subitem</term>
<listitem><para>
This method works in a similar manner as the <xref linkend="mthInsertClsListControl"/>()
method. The use of the <emphasis role="italic">subitem</emphasis> argument controls whether the
<emphasis role="italic">text</emphasis> argument applies to the label of the item or the text of a
subitem. When <emphasis role="italic">subitem</emphasis> is omitted or 0, then the label of the item is
set to <emphasis role="italic">text</emphasis>. When <emphasis role="italic">subitem</emphasis> is
greater than 0, then the text of that subitem is set to <emphasis role="italic">text</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>text</term>
<listitem><para>
The new text for the item label, or the new text for the subitem of the item, depending on the value of
<emphasis role="italic">subitem</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>icon</term>
<listitem><para>
The new index of the icon for the item within the image list assigned to the list-view. Image lists are
assigned with the <xref linkend="mthSetImageListClsListView"/>() method. When
assigning the image list with <computeroutput>setImageList</computeroutput>(), use the LVSIL_NORMAL
flag for the icon view icons and the LVSIL_SMALL flag for the list, report, and small-icon view icons.
</para>
<para>
Use -1 or simply omit this argument to leave the icon index unchanged. If <emphasis
role="italic">subitem</emphasis> is greater than 0, this argument is ignored.
</para>
</listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The modification was successful.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>
The following example modifies the icon for an item when it is activated. A method,
<computeroutput>onActivate</computeroutput>, is connected to the ACTIVATE notification. When an item is
activated it also gains the focus. The <computeroutput>onActivate</computeroutput>() method is invoked
when an item is activated, and the example determines which item was activated by seeing which item has
the focus.
<programlisting>
<![CDATA[
::method initDialog
expose list
list = self~newListView(IDC_LV_VIEWS)
self~connectListViewEvent(IDC_LV_VIEWS, 'ACTIVATE', 'onActivate')
...
::method onActivate
expose list
focusedItem = list~focused
text = list~itemText(focusedItem)
list~modify(focusedItem, , text, 2)
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthModifyColumn" xreflabel="modifyColumn"><title>modifyColumn</title>
<indexterm><primary>modifyColumn</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~modifyColumn(--column--,--+------+--,--width---->
+-text-+
>--+---------------------+--)----------------------------------><
| +-LEFT---+ |
+-,--"--+-CENTER-+--"-+
+-RIGHT--+
]]>
</programlisting>
<para>The modifyColumn method sets new attributes for
a column of a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>column</term>
<listitem><para>The number of the column. 0 is the first column.
</para></listitem></varlistentry>
<varlistentry><term>text</term>
<listitem><para>The text of the column heading. If you omit this argument, the heading
is not changed.
</para></listitem></varlistentry>
<varlistentry><term>width</term>
<listitem><para>The width of the column, in pixels.
</para></listitem></varlistentry>
<varlistentry><term>align</term>
<listitem><para>The alignment of the column heading and the subitem text within the
column. It can be one of the following values:
<variablelist>
<varlistentry><term>CENTER</term>
<listitem><para>The text is centered.
</para></listitem></varlistentry>
<varlistentry><term>LEFT</term>
<listitem><para>The text is left-aligned, which is the default.
</para></listitem></varlistentry>
<varlistentry><term>RIGHT</term>
<listitem><para>The text is right-aligned.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The column was modified.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">column</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthModifyColumnPX" xreflabel="modifyColumnPX"><title>modifyColumnPX</title>
<indexterm><primary>modifyColumnPX</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>modifyColumnPX</secondary></indexterm>
<programlisting>
<![CDATA[
>>--modifyColumnPX(--index--+---------+--+----------+--+--------+--)-----------><
+-,-text--+ +-,-width--+ +-,-fmt--+
]]>
</programlisting>
<para>
Modifies some, or all, of the attributes of an existing column in a list-view control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The zero-based index for the column being modified. Columns are numbered from the left to the right.
</para>
</listitem></varlistentry>
<varlistentry><term>text [optional]</term>
<listitem>
<para>
If this argument is included, the text for the column is changed to the text specified.
</para>
</listitem></varlistentry>
<varlistentry><term>width [optional]</term>
<listitem>
<para>
The new width of the column, in pixels. If the argument is omitted, the width is left unchanged.
</para>
</listitem></varlistentry>
<varlistentry><term>fmt [optional]</term>
<listitem>
<para>
One of the following keywords separated by spaces, case is not significant. The keyword specifies the new format
for the column being modified. If the <emphasis role="italic">fmt</emphasis> argument is omitted, the alignment
is left unchanged. At this time not all formats for the column are recognized. Other format keywords may be
added in the future.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>LEFT </member>
<member>CENTER</member>
<member>RIGHT </member>
</simplelist>
<variablelist>
<varlistentry><term>LEFT</term>
<listitem>
<para>
Text in the column is aligned to the left.
</para>
</listitem></varlistentry>
<varlistentry><term>CENTER</term>
<listitem>
<para>
The text for the column is centered.
</para>
</listitem></varlistentry>
<varlistentry><term>RIGHT</term>
<listitem>
<para>
The text for the column is aligned right.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
0 is returned on success, 1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example changes the title, size, and alignment of the first three columns in a list-view control. The columns
are only visible when the list-view is in report view.
<programlisting>
<![CDATA[
::method changeColumn
lv = self~newListView(IDC_LV_AVAILABLE_AUTOS)
lv~modifyColumn(0, "Make", 100, "RIGHT")
lv~modifyColumn(1, "Model", 150, "RIGHT")
lv~modifyColumn(1, "Color", 80, "CENTER")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::modifyColumnPX() -->
<section id="mthNext" xreflabel="next"><title>next</title>
<indexterm><primary>next</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~next(--item--)---------------------------------><
]]>
</programlisting>
<para>The next method retrieves the item that follows,
or is to the right of, <emphasis role="italic">item</emphasis>.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item at which the search is to start.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the following item, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthNextLeft" xreflabel="nextLeft"><title>nextLeft</title>
<indexterm><primary>nextLeft</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~nextLeft(--item--)-----------------------------><
]]>
</programlisting>
<para>The nextLeft method retrieves the item left to <emphasis role="italic">item</emphasis>.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item at which the search is to start. The specified
item itself is excluded from the search.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the next item to the left, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthNextRight" xreflabel="nextRight"><title>nextRight</title>
<indexterm><primary>nextRight</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~nextRight(--item--)----------------------------><
]]>
</programlisting>
<para>The nextRight method retrieves the item right to <emphasis role="italic">item</emphasis>.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item at which the search is to start. The specified
item itself is excluded from the search.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the next item to the right, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthNextSelected" xreflabel="nextSelected"><title>nextSelected</title>
<indexterm><primary>nextSelected</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~nextSelected(--item--)-------------------------><
]]>
</programlisting>
<para>The nextSelected method retrieves the selected
item that follows, or is to the right of, <emphasis role="italic">item</emphasis>.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item at which the search is to start. The specified
item itself is excluded from the search.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the selected item, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthPrepare4nItems" xreflabel="prepare4nItems"><title>prepare4nItems</title>
<indexterm><primary>prepare4nItems</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~prepare4nItems(--items--)----------------------><
]]>
</programlisting>
<para>The prepare4nItems method prepares a list-view
control for adding a large number of items.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>items</term>
<listitem><para>The number of the items to be added later.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The list-view control was prepared.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">items</emphasis>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthPrependFullRow"><title>prependFullRow</title>
<indexterm><primary>prependFullRow</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>prependFullRow</secondary></indexterm>
<programlisting>
<![CDATA[
>>--prependFullRow(--row--)----------------------><
]]>
</programlisting>
<para>
Adds an item to the list-view at the first position in the list using a <link linkend="clsLvFullRow">LvFullRows</link>
object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>row [required]</term>
<listitem>
<para>
A <link linkend="clsLvFullRow">LvFullRow</link> object that specifies the item to be added to the list-view.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
On success, returns the zero-based index of the added row. On error, -1 is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When a full row object is used to add an item to the list view, all the subitems are also added. The <emphasis
role="italic">prependFullRow</emphasis> method always as the first item in the list. Because of this, the item index
in the item and in the subitems in the full row object are ignored. After the item is inserted, the item index is
updated in the item and in the subitems is updated to the correct value of the newly added item.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::prependFullRow() -->
<section id="mthPrevious" xreflabel="previous"><title>previous</title>
<indexterm><primary>previous</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~previous(--item--)-----------------------------><
]]>
</programlisting>
<para>The previous method retrieves the item that precedes,
or is to the left of, <emphasis role="italic">item</emphasis>.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item at which the search is to start.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the previous item, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthPreviousSelected" xreflabel="previousSelected"><title>previousSelected</title>
<indexterm><primary>previousSelected</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~previousSelected(--item--)---------------------><
]]>
</programlisting>
<para>The previousSelected method retrieves the selected
item that precedes, or is to the left of, <emphasis role="italic">item</emphasis>.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item at which the search is to start. The specified
item itself is excluded from the search.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the selected item, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthRedrawItems" xreflabel="redrawItems"><title>redrawItems</title>
<indexterm><primary>redrawItems</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~RedrawItems--+--------------------------+------><
+-(--first--+---------+--)-+
+-,--last-+
]]>
</programlisting>
<para>The redrawItems method forces a list-view control
to redraw a range of items.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>first</term>
<listitem><para>The number of the first item to be redrawn. The default is 0.
</para></listitem></varlistentry>
<varlistentry><term>last</term>
<listitem><para>The number of the last item to be redrawn. The default is 0.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The specified range of items was redrawn.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthRemoveItemDataClsListView" xreflabel="removeItemData"><title>removeItemData</title>
<indexterm><primary>removeItemData</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>removeItemData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--removeItemData(--index--)--------------------><
]]>
</programlisting>
<para>
Removes and returns the user data associated with the specified list-view item.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The zero-based index of the item whose data value is being removed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the user data value associated with the specified item, or <computeroutput>.nil</computeroutput> if there is
no data associated with the item.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The list-view control allows the user (the Rexx programmer) to associate a data value with any, or all, of the
list-view items. The data value can be any ooRexx object. The data value is set using the
<xref linkend="mthSetItemDataClsListView"/> method. The data value can be retrieved without removing it from a
list-view item through the <xref linkend="mthGetItemDataClsListView"/> method. Storing a user value for each
item can be useful in any number of ways. One specific use is in the <xref linkend="mthSortItems"/>
method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from a program where the user can add items to a list-view and rearrange the items in any she
wants. The user can also reset the order of the items to its original order when the program started up. To do that,
the original index of each item is stored in the data value for each item when it is added to the list-view
</para>
<para>
Since the list-view control associates the data value with the index of an item, when the items are reset to their
original order, the data value is removed from the index it is currently at. When the items are added back to the
list-view in their original order the data value is then associated with the new item index.
<programlisting> <![CDATA[
::method initDialog
expose list
list = self~newListView(IDC_LV)
...
items = self~getItems
index = 0
do item over items
list~addRow(index, , item~text, item~fName, item~lName)
item~origIndex = index
list~setItemData(index, item)
index += 1
end
::method onReset
expose list
countItems = list~items
items = .array~new(countItems)
do i = 1 to countItems
data = list~removeItemData(i - 1)
items[data~origIndex + 1] = data
end
list~deleteAll
do i = 1 to countItems
data = items[i]
list~addRow(i - 1, , data~text, data~fName, data~lName)
list~setItemData(i - 1, data)
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::removeItemData() -->
<section id="mthRemoveExtendedStyle" xreflabel="removeExtendedStyle"><title>removeExtendedStyle</title>
<indexterm><primary>removeExtendedStyle</primary></indexterm>
<programlisting>
<![CDATA[
+--------------------+
V |
>>-aListControl~removeExtendedStyle(--"----+-BORDERSELECT-----+--"--)-------><
+-CHECKBOXES-------+
+-DOUBLEBUFFER-----+
+-FLATSB-----------+
+-FULLROWSELECT----+
+-GRIDLINES--------+
+-HEADERDRAGDROP---+
+-INFOTIP----------+
+-LABELTIP---------+
+-MULTIWORKAREAS---+
+-ONECLICKACTIVATE-+
+-REGIONAL---------+
+-SIMPLESELECT-----+
+-SUBITEMIMAGES----+
+-TRACKSELECT------+
+-TWOCLICKACTIVATE-+
+-UNDERLINECOLD----+
+-UNDERLINEHOT-----+
]]>
</programlisting>
<para>The <computeroutput>removeExtendedStyle</computeroutput> method removes
one or more extended <link linkend="listControlExtendedStyles">styles</link> of
a List-View control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>style</term>
<listitem><para>The extended style(s) to be removed. This is one or more of the
styles listed in the syntax diagram, separated by blanks. For an explanation
of the different styles, refer to the
<xref linkend="mthAddExtendedStyle"/> method.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>Success.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>An (internal) problem with the control's window handle.
</para></listitem></varlistentry>
<varlistentry><term>-3</term>
<listitem><para>The style argument did not contain any of the extended style
keywords.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example removes the check box style from the list
view.
<programlisting>
<![CDATA[
listView = self~newListView(IDC_LIST)
if listView == .nil then return
listView~removeExtendedStyle("CHECKBOXES")
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthRemoveStyleClsListView" xreflabel="removeStyle"><title>removeStyle</title>
<indexterm><primary>removeStyle</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
+-------------------+
V |
>>-aListControl~removeStyle(--"----+-ICON----------+-+--"--)---><
+-SMALLICON-----+
+-LIST----------+
+-REPORT--------+
+-ALIGNLEFT-----+
+-ALIGNTOP------+
+-AUTOARRANGE---+
+-ASCENDING-----+
+-DESCENDING----+
+-EDIT----------+
+-HSCROLL-------+
+-VSCROLL-------+
+-NOSCROLL------+
+-NOHEADER------+
+-NOSORTHEADER--+
+-NOWRAP--------+
+-SINGLESEL-----+
+-SHOWSELALWAYS-+
+-SHAREIMAGES---+
+-GROUP---------+
+-HIDDEN--------+
+-NOTAB---------+
+-NOBORDER------+
]]>
</programlisting>
<para>The removeStyle method removes one or more window
styles of a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>style</term>
<listitem><para>The window styles to be removed, which is one or more of the styles
listed in the syntax diagram, separated by blanks. For an explanation of the
different styles, refer to <xref linkend="mthCreateListView"/>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>0 if this method fails.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthReplaceExtendedStyle" xreflabel="replaceExtendedStyle"><title>replaceExtendedStyle</title>
<indexterm><primary>replaceExtendedStyle</primary></indexterm>
<programlisting>
<![CDATA[
+--------------------+
V |
>>-aListControl~replaceExtendedStyle(-oldStyle--,--"---+-BORDERSELECT-----+--"-)-><
+-CHECKBOXES-------+
+-DOUBLEBUFFER-----+
+-FLATSB-----------+
+-FULLROWSELECT----+
+-GRIDLINES--------+
+-HEADERDRAGDROP---+
+-INFOTIP----------+
+-LABELTIP---------+
+-MULTIWORKAREAS---+
+-ONECLICKACTIVATE-+
+-REGIONAL---------+
+-SIMPLESELECT-----+
+-SUBITEMIMAGES----+
+-TRACKSELECT------+
+-TWOCLICKACTIVATE-+
+-UNDERLINECOLD----+
+-UNDERLINEHOT-----+
]]>
</programlisting>
<para>The <computeroutput>replaceExtendedStyle</computeroutput> method removes
some of the List-View control's
extended <link linkend="listControlExtendedStyles">styles</link> and adds new
extended styles. This is the equivalent of first
using the <computeroutput>RemoveExtendeStyle</computeroutput> method and then
using the <computeroutput>addExtendedStyle</computeroutput> method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>oldStyle</term>
<listitem><para>The extended style(s) to be removed. This is one or more of the
styles listed in the syntax diagram, separated by blanks. For an explanation
of the different styles, refer to the
<xref linkend="mthAddExtendedStyle"/> method.
</para></listitem></varlistentry>
<varlistentry><term>newStyle</term>
<listitem><para>The extended style(s) to be added. Again, this is one or more
of the styles listed in the syntax diagram, separated by blanks. See the
<xref linkend="mthAddExtendedStyle"/> method for the style
descriptions.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>Success.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>An (internal) problem with the control's window handle.
</para></listitem></varlistentry>
<varlistentry><term>-3</term>
<listitem><para>One, or both, of the style arguments had none of the extended
style keywords.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example removes the cold and hot underlining and
adds check boxes to the list view.
<programlisting>
<![CDATA[
listView = self~newListView(IDC_LIST)
if listView == .nil then return
removeStyle = "UNDERLINECOLD UNDERLINEHOT"
addStyle = "CHECKBOXES"
listView~replaceExtendedStyle(removeStyle, addStyle)
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthReplaceStyleClsListView" xreflabel="replaceStyle"><title>replaceStyle</title>
<indexterm><primary>replaceStyle</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
+-------------------+
V |
>>-aListControl~replaceStyle(--oldStyle--,--"----+-ICON----------+-+--"--)-><
+-SMALLICON-----+
+-LIST----------+
+-REPORT--------+
+-ALIGNLEFT-----+
+-ALIGNTOP------+
+-AUTOARRANGE---+
+-ASCENDING-----+
+-DESCENDING----+
+-EDIT----------+
+-HSCROLL-------+
+-VSCROLL-------+
+-NOSCROLL------+
+-NOHEADER------+
+-NOSORTHEADER--+
+-NOWRAP--------+
+-SINGLESEL-----+
+-SHOWSELALWAYS-+
+-SHAREIMAGES---+
+-GROUP---------+
+-HIDDEN--------+
+-NOTAB---------+
+-NOBORDER------+
]]>
</programlisting>
<para>The replaceStyle method removes a window style
of a list-view control and sets new styles.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>oldStyle</term>
<listitem><para>The window style to be removed.
</para></listitem></varlistentry>
<varlistentry><term>newStyle</term>
<listitem><para>The new window styles to be set, which is one or more of the styles
listed in the syntax diagram, separated by blanks. For an explanation
of the different styles, refer to <xref linkend="mthCreateListView"/>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>0 if this method fails.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>
The following example comes from a program where the user can switch between the different view styles
in a list-view. The list-view is assigned an image list for both the small and normal icons. Radio
buttons for the different views are connected to methods. When the user clicks one of the radio
buttons, the method for that radio button uses <computeroutput>replaceStyle</computeroutput>() to
remove all of the other view styles and add the specified style.
<programlisting>
<![CDATA[
::method initDialog
expose list
self~newRadioButton(IDC_RB_ICON)~check
self~connectButtonEvent(IDC_RB_REPORT, "CLICKED", onReport)
self~connectButtonEvent(IDC_RB_LIST, "CLICKED", onList)
self~connectButtonEvent(IDC_RB_ICON, "CLICKED", onIcon)
self~connectButtonEvent(IDC_RB_SMALL_ICON, "CLICKED", onSmallIcon)
list = self~newListView(IDC_LV_VIEWS)
flags = .Image~toID(ILC_COLOR24)
imageList = .ImageList~create(.Size~new(16), flags, 7, 0)
imageList~add(.Image~getImage("iconList_16.bmp"))
list~setImageList(imageList, .Image~toID(LVSIL_SMALL))
imageList = .ImageList~create(.Size~new(32), flags, 7, 0)
imageList~add(.Image~getImage("iconList_32.bmp"))
list~setImageList(imageList, .Image~toID(LVSIL_NORMAL))
self~populateList(list)
::method onReport
expose list
list~replaceStyle("LIST ICON SMALLICON", "REPORT")
::method onList
expose list
list~replaceStyle("REPORT ICON SMALLICON", "LIST")
::method onIcon
expose list
list~replaceStyle("LIST REPORT SMALLICON", "ICON")
::method onSmallIcon
expose list
list~replaceStyle("LIST ICON REPORT", "SMALLICON")
::method populateList private
use strict arg list
list~InsertColumnEx(0, "Title", 150)
...
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthScrollClsListview" xreflabel="scroll"><title>scroll</title>
<indexterm><primary>scroll</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
+-0-+ +-0-+
>>-aListControl~scroll(--+---+--,--+---+--)--------------------><
+-x-+ +-y-+
]]>
</programlisting>
<para>The Scroll method scrolls the content of a list
view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>x</term>
<listitem><para>An integer value specifying the amount of horizontal scrolling. If the
control is in icon, small-icon, or report view, this value specifies the number
of pixels to be scrolled. If it is in list-view, this value specifies the
number of columns to be scrolled. The default value is 0.
</para></listitem></varlistentry>
<varlistentry><term>y</term>
<listitem><para>An integer value specifying the amount of vertical scrolling. If the
control is in icon, small-icon, or report view, this value specifies the number
of pixels to be scrolled. If it is in list-view, this value specifies the
number of lines to be scrolled. The default value is 0.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>Scrolling was successful.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>Scrolling failed.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSelectClsListView" xreflabel="select"><title>select</title>
<indexterm><primary>select</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~select(--item--)-------------------------------><
]]>
</programlisting>
<para>The select method selects an item.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The item was selected.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSelectedClsListView" xreflabel="selected"><title>selected</title>
<indexterm><primary>selected</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~Selected---------------------------------------><
]]>
</programlisting>
<para>The selected method returns the number of the selected
item.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of the item selected last, or -1 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSelectedItemsClsListView" xreflabel="selectedItems"><title>selectedItems</title>
<indexterm><primary>selectedItems</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~SelectedItems----------------------------------><
]]>
</programlisting>
<para>The selectedItems method determines the number
of selected items in a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The number of selected items.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetColumnOrder" xreflabel="setColumnOrder"><title>setColumnOrder</title>
<indexterm><primary>setColumnOrder</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setColumnOrder(--order--)-----------------------------------------><
]]>
</programlisting>
<para>
Changes the column order of a list-view control to some other order. Typically this method might be
used along with the <xref linkend="mthGetColumnOrder"/>() method to save and
restore the user's column order. But, it can also be used to programmatically change the column order
for any reason.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single required argument is:
<variablelist>
<varlistentry><term>order</term>
<listitem>
<para>
An array containing the index numbers of the columns in their new order. The number at the
first position in the array is the column index of the column that should be the left-most. The
number at the second position in the array, and so on.
</para>
<para>
The array has to contain the same number of items as the number of columns with no empty
indexes.
</para>
<para>
If non-valid column indexes are intermingled with valid column indexes, then the columns are
re-ordered, but with no easily predictable pattern. If all the number are invalid column
indexes, then the order of the columns remains unchanged. This behavior is the behavior of the
underlying control, ooDialog has no control over it.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return values are:
<variablelist>
<varlistentry><term><computeroutput>.true</computeroutput></term>
<listitem>
<para>
The method succeeded.
</para>
</listitem></varlistentry>
<varlistentry><term><computeroutput>.false</computeroutput></term>
<listitem>
<para>
Some error occurred. This is unlikely.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
In this example an application has two modes. One mode emphasizes the occupation of the people in a
database, the other mode emphasizes the people. The order of the columns is occupation, name, ...
for the first mode and name, occupation, ... for the second mode. When the mode of the application
changes, the order of the columns also changes.
<programlisting>
<![CDATA[
...
list = self~newListView(100)
columnNames = .array~of("Occupation", "Name", "Age", "Sex")
list~addExtendedStyle("FULLROWSELECT GRIDLINES CHECKBOXES")
list~insertColumn(0, columnNames[1], 95)
list~insertColumn(1, columnNames[2], 95)
list~insertColumn(2, columnNames[3], 95)
list~insertColumn(3, columnNames[4], 35)
...
::method toggleColumnOrder private
expose list
order = list~getColumnOrder
tmp = order[1]
order[1] = order[2]
order[2] = tmp
list~setColumnOrder(order)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListControl::setColumnOrder() -->
<section id="mthSetColumnWidth" xreflabel="setColumnWidth"><title>setColumnWidth</title>
<indexterm><primary>setColumnWidth</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~setColumnWidth(--column--+----------+--)-------><
+-,--width-+
]]>
</programlisting>
<para>The setColumnWidth method sets the width of a column
in a report or list view.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>column</term>
<listitem><para>The number of the column of which the width is to be set. 0 is the first
column.
</para></listitem></varlistentry>
<varlistentry><term>width</term>
<listitem><para>The width of the column, in pixels. If you omit this argument, the column
is sized automatically to the widest item in the list.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The column width was set.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">column</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example enlarges the selected column by 10:
<programlisting>
<![CDATA[
::method OnColumnClick
use arg id, column
curList = self~newListView(102)
curList~setColumnWidth(column,curList~columnWidth(column)+10)
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetColumnWidthPX" xreflabel="setColumnWidthPX"><title>setColumnWidthPX</title>
<indexterm><primary>setColumnWidth</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>setColumnWidth</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setColumnWidthPX(--colIndex--+-----------+--)---------------><
+--,-width--+
]]>
</programlisting>
<para>
Sets the width, in pixels, of a column in a list-view control that has the report or list style.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>colIndex [required]</term>
<listitem>
<para>
The zero-based index of the column whose width is to be set.
</para>
</listitem></varlistentry>
<varlistentry><term>width [optional]</term>
<listitem>
<para>
A positive whole number specifying the width in pixels for the column. If, the list-view is in report view, one
of the following keywords are also valid:
<variablelist>
<varlistentry><term><emphasis role="bold">AUTO:</emphasis></term>
<listitem>
<para>
The list-view will automatically size the column.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">AUTOHEADER:</emphasis></term>
<listitem>
<para>
Automatically sizes the column to fit the column text. When this value for the last column, its width is set
to fill the remaining width of the list-view control.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0 on success and 1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
Provided that the list-view is in report view, this example has the list-view automatically size the first two
columns, and then size the last column to take up all the rest of the width in the control.
<programlisting>
<![CDATA[
list = self~newListView(IDC_LV_SALES)
list~setColumnWidthPX(0, "AUTO")
list~setColumnWidthPX(1, "AUTO")
list~setColumnWidthPX(2, "AUTOHEADER")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::setColumnWidthPX() -->
<section id="mthSetHoverTime" xreflabel="setHoverTime"><title>setHoverTime</title>
<indexterm><primary>setHoverTime</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~setHoverTime(--+------+--)---------------------><
+-time-+
]]>
</programlisting>
<para>This method is used to change the <emphasis role="italic">hover</emphasis>
time. The hover time only affects list-view controls that have the track
select, one click activate, or two click activate extended list-view styles. See
the <xref linkend="mthAddExtendedStyle"/> for a
description of these styles.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only optional argument is:
<variablelist>
<varlistentry><term>time</term>
<listitem><para>Specify the hover time in milliseconds. If this argument is
omitted, the hover time is set to the system default. A negative number will
also set the hover time back to the system default.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The previous hover time. A value of -1 indicates the previous
hover time was the system default.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example adds the one click activate, the track
select, and the full row select extended list-view styles to a
<computeroutput>ListView</computeroutput>. The hover time is set to .4
seconds. If the user pauses his mouse over a row in the list-view for .4 of a
second the row is automatically selected.
<programlisting> <![CDATA[
::method initDilaog
...
list = self~newListView(IDC_LIST)
list~addExtendedStyle("ONECLICKACTIVATE FULLROWSELECT TRACKSELECT")
oldTime = list~setHoverTime(400)
...
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetImageListClsListView" xreflabel="setImageList"><title>setImageList</title>
<indexterm><primary>setImageList</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setImageList(--src-+---------------+-+----------+-+----------+-)-----------><
+-,-typeOrWidth-+ +-,-height-+ +-,-ilType-+
]]>
</programlisting>
<para>
Assigns, or removes, an image list for the list-view control. Using
<computeroutput>.nil</computeroutput> for the first argument removes the current image list.
</para>
<para>
The list-view control uses image lists for a number of things, the large icons, the small icons, the
state images, and the group header images. (ooDialog does not yet support list-view groups.) The
<emphasis role="italic">src</emphasis> argument can be either an
<xref linkend="clsImageList"/> object, or a single bitmap.
</para>
<para>
Using an image list object is the most flexible option. The programmer creates the image list in the
manner most suitable to the program. When the program is enhanced or changed it is easy to change the
image list.
</para>
<para>
When <emphasis role="italic">src</emphasis> is a single bitmap it is used in this way: A single bitmap
is created that consists of all the images for the image list. All the images must be the same width
and height. The images are arranged in the bitmap in a row, side-by-side, in the order they should
appear in the image list. ooDialog uses this bitmap to create a <emphasis
role="italic">.ImageList</emphasis> object and assigns it to the list-view. The <emphasis
role="italic">src</emphasis> argument can be either the file name of the bitmap or a bitmap
<xref linkend="clsImage"/> object.
</para>
<para>
Although using a single bitmap will allow the programmer to save a couple of lines of code, it has a
number of disadvantages. The image list is created with the exact number of images in the bitmap and no
extra room to add images. The image list is created as an unmasked image list, with a color of 8 bit
per pixel. If the program is enhanced or changed in a way that requires even a slight change
to the image list, the single bitmap would need to be re-created.
</para>
<para>
When using a single bitmap, if the system fails to create the image list from the details supplied by
ooDialog, the method of informing the programmer of the error is not as robust as it is when the
programmer creates the image list herself. However, ooDialog will set the
<xref linkend="dotSystemErrorCode"/> for any cases where the operating system
reports an error. Also note that when using a single bitmap, ooDialog will instantiate a <emphasis
role="italic">.ImageList</emphasis> object. The programmer can retrieve this object using the
<xref linkend="mthGetImageListClsListView"/>() method and then manipulate it using the
methods of the <xref linkend="clsImageList"/> class.
</para>
<para>
Unless a list-view has the LVS_SHAREIMAGELISTS style, (corresponds to the SHAREIMAGES style in the
<xref linkend="mthCreateListView"/>() method,) the list-view control will handle
releasing the image list(s). When the share image lists style is used, ownership of the image list
remains with the programmer. The <xref linkend="clsImageList"/> and
<xref linkend="clsImage"/> classes are used to manage image lists and images in ooDialog. The
documentation on both classes discusses when and why the programmer may want to release image lists.
The Image class documentation has the most detail on this subject.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>The arguments are:
<variablelist>
<varlistentry><term>src</term>
<listitem>
<para>
The source for the image list. The most flexible way to use this method is to provide an
image <xref linkend="clsImageList"/> object to assign to the list-view.
</para>
<para>
However, as explained above, this argument can also be a single bitmap from which the image
list is to be created. In this case, the argument can be either the file name of the bitmap or
a bitmap <xref linkend="clsImage"/> object.
</para>
<para>
If this argument is <computeroutput>.nil</computeroutput> the existing image list, if any, is
removed.
</para>
</listitem></varlistentry>
<varlistentry><term>typeOrWidth</term>
<listitem>
<para>
Optional.
</para>
<para>
<emphasis role="bold">type</emphasis>: When <emphasis role="italic">src</emphasis> is an
<computeroutput>ImageList</computeroutput> object, this argument specifies which image list to
assign, (or remove.) You can use the <xref linkend="mthToIDClsImage"/> method of the <xref linkend="clsImage"/>
class to get the correct numeric value for one of the following symbols:
<simplelist type='horiz' columns='2'>
<member>LVSIL_NORMAL</member>
<member>LVSIL_SMALL </member>
<member>LVSIL_STATE </member>
</simplelist>
or use the correct numeric value itself. Note that there is also a LVSIL_GROUPHEADER symbol,
but ooDialog does not yet support it. The default is LVSIL_NORMAL.
</para>
<para>
<emphasis role="bold">width</emphasis>: When <emphasis role="italic">src</emphasis> is a
single bitmap, this argument can be used to specify the width of a single image in the bitmap.
The default is the actual height of the bitmap.
</para>
</listitem></varlistentry>
<varlistentry><term>height</term>
<listitem>
<para>
Optional. This argument is only used when <emphasis role="italic">src</emphasis> is a single
bitmap. In that case <emphasis role="italic">height</emphasis> specifies the height of an image
in the bitmap. The default is to use the actual height of the bitmap.
</para>
</listitem></varlistentry>
<varlistentry><term>ilType</term>
<listitem>
<para>
Optional. This argument is only used when <emphasis role="italic">src</emphasis> is a single
bitmap. It is used to specify which image list is being assigned. Its usage is exactly the same
as is documented for the <emphasis role="italic">type</emphasis> role of the <emphasis
role="italic">typeOrWidth</emphasis> argument above. If omitted, the default is LVSIL_NORMAL.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The existing image list is returned, if there is one. Otherwise,
<computeroutput>.nil</computeroutput> is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This is a complete working example. It creates an image list using the application icons that
ooDialog makes available for general use. The image list is assigned as the normal icon image list.
<programlisting>
<![CDATA[
dlg = .ImageDisplay~new
if dlg~initCode = 0 then do
dlg~constDir[IDC_LV_IMAGES] = 100
dlg~create(30, 30, 320, 155, "ooDialog Icon Resources", , , "Tahoma")
dlg~execute("SHOWTOP", IDI_DLG_OOREXX)
end
::requires "ooDialog.cls"
::class 'ImageDisplay' subclass UserDialog inherit AdvancedControls
::method defineDialog
self~addListControl(IDC_LV_IMAGES, , 10, 10, 300, 135, "ICON SINGLESEL");
::method initDialog
names = .array~new()
names[1] = "IDI_DLG_OODIALOG"
names[2] = "IDI_DLG_APPICON"
names[3] = "IDI_DLG_APPICON2"
names[4] = "IDI_DLG_OOREXX"
ids = .array~new()
ids[1] = self~constDir[IDI_DLG_OODIALOG]
ids[2] = self~constDir[IDI_DLG_APPICON]
ids[3] = self~constDir[IDI_DLG_APPICON2]
ids[4] = self~constDir[IDI_DLG_OOREXX]
SM_CXICON = 11
SM_CYICON = 12
size = .Size~new(.DlgUtil~getSystemMetrics(SM_CXICON), .DlgUtil~getSystemMetrics(SM_CYICON))
oodModule = .ResourceImage~new("oodialog.dll", self)
icons = oodModule~getImages(ids, .Image~toID(IMAGE_ICON), size)
flags = .DlgUtil~or(.Image~toID(ILC_COLOR24), .Image~toID(ILC_MASK))
imageList = .ImageList~create(size, flags, 4, 0)
imageList~addImages(icons)
list = self~newListView(IDC_LV_IMAGES)
list~setImageList(imageList, .Image~toID(LVSIL_NORMAL))
do i = 1 to ids~items
list~add(names[i] '('ids[i]')', i - 1)
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::setImageList() -->
<section id="mthSetItemDataClsListView" xreflabel="setItemData"><title>setItemData</title>
<indexterm><primary>setItemData</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>setItemData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setItemData(--index--,--data--)--------------><
]]>
</programlisting>
<para>
Sets the user data associated with the specified list-view item.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The zero-based index of the item the data value is associated with.
</para>
</listitem></varlistentry>
<varlistentry><term>data [required]</term>
<listitem>
<para>
The data value to store for the list-view item. This can be any Rexx object. (Recall that in ooRexx numbers and
strings are also objects.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, false on error. An error is unlikely.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The list-view control allows the user (the Rexx programmer) to associate a data value with any, or all, of the
list-view items. The data value can be any ooRexx object. The data value can be retrieved without removing it from a
list-view item through the <xref linkend="mthGetItemDataClsListView"/> method, or it can be retrieved and removed through
the <xref linkend="mthRemoveItemDataClsListView"/>. Storing a user value for each item can be useful in any
number of ways. One specific use is in the <xref linkend="mthSortItems"/> method.
</para>
<para>
For the <emphasis role="italic">sortItems</emphasis> method to work, every list-view item must have the user data item
set. When <emphasis role="italic">sortItems</emphasis> is invoked to use the internal ooDialog framework to do the
sorting, the user data item must be a <xref linkend="clsLvFullRow"/> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example stores a <computeroutput>.Directory</computeroutput> object with each list-view item when the item is
added to the list-view. The <computeroutput>.Directory</computeroutput> object contains the text for the item and
its subitems and additional information not shown in the code snippet:
<programlisting>
<![CDATA[
::method initDialog
expose list
list = self~newListView(IDC_LV)
...
items = self~getItems
do item over items
index = list~addRow(, , item~text, item~fName, item~lName)
if index == -1 then do
-- do some error routine
return 0
end
list~setItemData(index, item)
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::setItemData() -->
<section id="mthSetItemPos" xreflabel="setItemPos"><title>setItemPos</title>
<indexterm><primary>setItemPos</primary></indexterm>
<programlisting>
<![CDATA[
+-0-+ +-0-+
>>-aListControl~setItemPos(--item--,--+---+--,--+---+--)-------><
+-x-+ +-y-+
]]>
</programlisting>
<para>The setItemPos method moves an item to a specified
position in a list-view control, which must be in icon or small-icon view.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
<varlistentry><term>x</term>
<listitem><para>The x-coordinate of the new position of the upper left corner of the
item, in view coordinates. The default is 0.
</para></listitem></varlistentry>
<varlistentry><term>y</term>
<listitem><para>The y-coordinate of the new position of the upper left corner of the
item, in view coordinates. The default is 0.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The item was moved.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
<note><title>Note</title><para>
Use <xref linkend="mthDefListDragHandler"/> to support default dragging:
</para></note>
<programlisting>
<![CDATA[
self~connectListViewEvent(104,"BEGINDRAG","mthDefListDragHandler")
]]>
</programlisting>
</section>
<section id="mthSetItemState" xreflabel="setItemState"><title>setItemState</title>
<indexterm><primary>setItemState</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~setItemState(--item--+------------------------------+--)-><
| +-----------------+ |
| V | |
+-,--"----+-CUT---------+-+--"-+
+-NOTCUT------+
+-DROP--------+
+-NOTDROP-----+
+-FOCUSED-----+
+-NOTFOCUSED--+
+-SELECTED----+
+-NOTSELECTED-+
]]>
</programlisting>
<para>The setItemState method sets the state of a list
view item.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item.
</para></listitem></varlistentry>
<varlistentry><term>state</term>
<listitem><para>The state of the item, which can be one or more of the following values,
separated by blanks:
<variablelist>
<varlistentry><term>CUT</term>
<listitem><para>The item is marked for a cut-and-paste operation.
</para></listitem></varlistentry>
<varlistentry><term>NOTCUT</term>
<listitem><para>The item cannot be used for a cut-and-paste operation.
</para></listitem></varlistentry>
<varlistentry><term>DROP</term>
<listitem><para>The item is highlighted as a drag-and-drop target.
</para></listitem></varlistentry>
<varlistentry><term>NOTDROP</term>
<listitem><para>The item is not highlighted as a drag-and-drop target.
</para></listitem></varlistentry>
<varlistentry><term>FOCUSED</term>
<listitem><para>The item has the focus and is therefore surrounded by the standard focus
rectangle. Only one item can have the focus.
</para></listitem></varlistentry>
<varlistentry><term>NOTFOCUSED</term>
<listitem><para>The item does not have the focus.
</para></listitem></varlistentry>
<varlistentry><term>SELECTED</term>
<listitem><para>The item is selected. Its appearance depends on whether it has the focus
and on the system colors used for a selection.
</para></listitem></varlistentry>
<varlistentry><term>NOTSELECTED</term>
<listitem><para>The item is not selected.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The state was set successfully.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetItemText" xreflabel="setItemText"><title>setItemText</title>
<indexterm><primary>setItemText</primary></indexterm>
<programlisting>
<![CDATA[
>>--setItemText(--item--,--+-----------+--,--text--)--><
+--subitem--+
]]>
</programlisting>
<para>
The setItemText method changes the text of a label, or the text of a subitem, of a list-view item.
</para>
<para>
Remember that in a list-view, items and columns use a 0-based index. Subitems use a 1-based index.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The index of the item.
</para></listitem></varlistentry>
<varlistentry><term>subitem</term>
<listitem><para>
This method works in a similar manner as the <xref linkend="mthInsertClsListControl"/>()
method. The use of the <emphasis role="italic">subitem</emphasis> argument controls whether the
<emphasis role="italic">text</emphasis> argument applies to the label of the item or the text of a
subitem. When <emphasis role="italic">subitem</emphasis> is omitted or 0, then the label of the item is
set to <emphasis role="italic">text</emphasis>. When <emphasis role="italic">subitem</emphasis> is
greater than 0, then the text of that subitem is set to <emphasis role="italic">text</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>text</term>
<listitem><para>
The text for the item or a subitem, depending on the value of <emphasis
role="italic">subitem</emphasis>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The change was successful.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetToolTipsClsListView" xreflabel="setToolTips"><title>setToolTips</title>
<indexterm><primary>setToolTips</primary><secondary>ListView class</secondary></indexterm>
<indexterm><primary>ListView class</primary><secondary>setToolTips</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setToolTips(--toolTip--)---------------------><
]]>
</programlisting>
<para>
Sets the child <link linkend="clsToolTip">ToolTip</link> control used by this list-view.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolTip [required]</term>
<listitem>
<para>
The Rexx <computeroutput>ToolTip</computeroutput> object that represents the tool tip control the list-view should
use.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the previous tool tip, as a Rexx <computeroutput>ToolTip</computeroutput> object, or the
<computeroutput>.nil</computeroutput> object if there is no previous tool tip.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::setToolTips() -->
<section id="mthSmalSpacing" xreflabel="smallSpacing"><title>smallSpacing</title>
<indexterm><primary>smallSpacing</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~SmallSpacing-----------------------------------><
]]>
</programlisting>
<para>The smallSpacing method determines the spacing
between items in a small-icon list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The amount of spacing between the items.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSnapToGrid" xreflabel="snapToGrid"><title>snapToGrid</title>
<indexterm><primary>snapToGrid</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~SnapToGrid-------------------------------------><
]]>
</programlisting>
<para>The snapToGrid method snaps all icons to the nearest
grid position.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The items were snapped.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthSortItems" xreflabel="sortItems"><title>sortItems</title>
<indexterm><primary>sortItems</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>sortItems</secondary></indexterm>
<programlisting>
<![CDATA[
>>--sortItems(--methodName--+----------+--)------><
+-,-param--+
]]>
</programlisting>
<para>
The <emphasis role="italic">sortItems</emphasis> method causes the list-view control to sort its items using the
specified comparison method. The comparison method can be a method in the Rexx dialog, or a method name that signals the
ooDialog framework to use an internal comparison method written in the native API.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>methodName [required]</term>
<listitem>
<para>
<emphasis role="italic">methodName</emphasis> is either the name of a method in the Rexx dialog, (referred to as a
Rexx sort,) or the special method name of: <emphasis role="italic">InternalListViewSort</emphasis>, (referred to as
an internal sort.)
</para>
<para>
When <emphasis role="italic">methodName</emphasis> is <emphasis role="italic">InternalListViewSort</emphasis> then
the ooDialog framework performs the sorting work internally. This can be significantly faster, for very large lists,
but there are a number of restrictions to this sort. See the remarks section for the details.
</para>
<para>
When <emphasis role="italic">methodName</emphasis> is not <emphasis role="italic">InternalListViewSort</emphasis>,
then it names a comparison method in the Rexx dialog that is used by the list-view to sort its items. The details of
how the Rexx method is implemented are in the remarks section.
</para>
</listitem></varlistentry>
<varlistentry><term>param [optional]</term>
<listitem>
<para>
For the <emphasis role="bold">Rexx sort</emphasis>, the <emphasis role="italic">param</emphasis> argument can be any object the programmer
wants to use. If the argument exists, it is passed as the third argument to the <emphasis
role="italic">methodName</emphasis> comparison method. If it is not specified,
<computeroutput>.nil</computeroutput> is passed as the third argument.
</para>
<para>
For the <emphasis role="bold">internal sort</emphasis>, the <emphasis role="italic">param</emphasis> argument can be a
<computeroutput>Directory</computeroutput> object that is used to change the internal sort parameters. If <emphasis
role="italic">param</emphasis> is omitted in this case, the sort is performed on the list-view item text, as a
case-sensitive ascending sort. If not omitted, the following indexes in the
<computeroutput>Directory</computeroutput> object are checked and alter the sort as described:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">ASCENDING:</emphasis></term>
<listitem>
<para>
If present, the index must be true or false. When true, the sort is an ascending sort, if false the sort is a
descending sort. The default if the index is missing, is true.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">CASELESS:</emphasis></term>
<listitem>
<para>
If present, the index must be true or false. When true, the sort is case-insensitive, if false the sort is
case-sensitive. The default if the index is missing, is false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">COLUMN:</emphasis></term>
<listitem>
<para>
If present, the index must be a non-negative number, within the range of 0 to the number of subitem columns
in the list-view. Recall that the first subitem is in column 1, the second subitem is in column 2, and so
on. The value of the COLUMN index specifies which text the sort is performed on. A value of 0 specifies that
the sort is performed on the item text. Non-zero values specify that the sort is performed on the text of
the subitem specified. I.e., a value of 2 specifies the the sort is performed on the text of subitem 2. If
omitted, the default value is 0.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, false on error. An error is unlikely.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The list-view control allows the user (the Rexx programmer) to associate a user
<link linkend="mthSetItemDataClsListView">data</link> value with any, or all, of the list-view items. The data value can be any
ooRexx object. For the <emphasis role="italic">sortItems</emphasis> method to work correctly, the programmer must
associate a data value with each list-view item.
</para>
<para>
The specifics on the user data value and what the programmer needs to do are dependent on the type of sort specified. See
the relevant section below for a Rexx sort or an internal sort.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Rexx Sort</emphasis></term>
<listitem>
<para>
When the Rexx sort is performed, as the list-view control needs to compare two items it will invoke, through the
ooDialog framework, the comparison method named by the <emphasis role="italic">methodName</emphasis> argument in the
Rexx dialog. The return from the Rexx method determines how the items are sorted.
</para>
<para>
The comparison method must return a whole number and this value is passed on to the list-view control. While the
list-view is sorting, the list is not stable and the comparison method must not invoke any
<computeroutput>ListView</computeroutput> methods. If methods of the <computeroutput>ListView</computeroutput> object are
invoked, the results of the sort are unpredictable. The comparison method should be coded as follows:
</para>
<programlisting>
<![CDATA[
::method compare
use arg data1, data2, param
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The comparison method receives 3 arguments:
</para>
<variablelist>
<varlistentry><term>data1</term>
<listitem>
<para>
The <emphasis role="italic">data value</emphasis> assigned to the first list-view item to be compared. This data
value is the value the programmer assigned to the item using the <xref linkend="mthSetItemDataClsListView"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term>data2</term>
<listitem>
<para>
The <emphasis role="italic">data value</emphasis> assigned to the second list-view item to be compared.
</para>
</listitem></varlistentry>
<varlistentry><term>param</term>
<listitem>
<para>
The <emphasis role="italic">param</emphasis> argument passed to the <emphasis role="italic">sortItems</emphasis>
method, if it exists. If it was omitted, the param argument will be the <computeroutput>.nil</computeroutput>
object.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The return must be a whole number. Less than 0 places the first list item before the second item, greater than 0
places the first item after the second. Return 0 if the two items are equivalent. The programmer determines what number
to return based on the 2 user data values passed to the method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Intenal Sort</emphasis></term>
<listitem>
<para>
When an internal sort is used, the work of the sort is done in the native API implementation code. In essence, within
the ooDialog framework. To use this sort, the user data assigned to each list-view item must be a <xref
linkend="clsLvFullRow"/> object. The user data can be assigned to each item either through the <xref
linkend="mthSetItemDataClsListView"/> method, or during the <link linkend="mthNewClsLvFullRow">instantiation</link> of the
<computeroutput>LvFullRow</computeroutput> object. The sort will not work correctly if any item in the list-view does not
have a <computeroutput>LvFullRow</computeroutput> object assigned as its user data value.
</para>
<para>
The sort is performed on the text of the item, or the text of the subitems of the item. By default, the sort is an
ascending, case-sensitive, sort of the text of the item. The <emphasis role="italic">param</emphasis> argument can be
used to change this to a sort on the text of any of the subitems of the item, as explained above. Ascending or
descending sorts, as well as case-sensitive or case-insensitive sorts can also be specified using the <emphasis
role="italic">param</emphasis> argument.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Rexx Sort Example:</emphasis></term>
<listitem>
<para>
This example shows one approach to sorting the list items on either a first name or last name, and either ascending
or descending using the Rexx sort:
<programlisting>
<![CDATA[
::method initDialog
...
-- Get the list-view object
list = self~newListView(IDC_LV)
-- Get the data value for each list item.
-- names is an array of .directory objects.
-- Each .directory object has a fName and a
-- lName index
names = self~getFirstLastNames
do i = 1 to names~items
list~setItemData(i - 0, names[i])
end
...
::method sortList unguarded
use strict arg ascending, column, list
-- column is the column to sort on. Column 1 is
-- the first name, column 2 is the last name.
if ascending then list~sortItems(sortUp, column)
else list~sortItems(sortDown, column)
::method sortUp unguarded
use arg data1, data2, param
if param == 1 then return data1~fName~compareTo(data2~fName)
else return data1~lName~compareTo(data2~lName)
::method sortDown unguarded
expose field
use arg data1, data2, param
if param == 1 then return data2~fName~compareTo(data1~fName)
else return data2~lName~compareTo(data1~lName)
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Internal Sort Example:</emphasis></term>
<listitem>
<para>
This example shows the basic steps needed to set up an internal sort. In the example, a descending, case-insensitive sort
is done on the text of subitem 3:
<programlisting>
<![CDATA[
::method createRows private
...
-- As each full row object is instantiated, the last argument
-- is set to .true to indicate the full row object should be
-- set as the user data of the list-view item:
rows[i] = .LvFullRow~new(lvi, lvsi1, lvsi2, lvsi3, .true)
return rows
-- The onSort() method is connected to a 'Sort' push button
::method onSort unguarded
expose list
d = .directory~new
d~column = 3
d~ascending = .false
d~caseless = .true
list~sortItems('InternalListViewSort', d)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::sortItems() -->
<section id="mthSpacing" xreflabel="spacing"><title>spacing</title>
<indexterm><primary>spacing</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~Spacing----------------------------------------><
]]>
</programlisting>
<para>The spacing method determines the spacing between
items in an icon list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The amount of spacing between the items.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthStringWidth" xreflabel="stringWidth"><title>stringWidth</title>
<indexterm><primary>stringWidth</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~stringWidth(--text--)--------------------------><
]]>
</programlisting>
<para>The stringWidth method determines the width of
a specified string using the current font of the list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>text</term>
<listitem><para>The text string of which the width is to be determined.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The string width, or -1 if you did not specify a <emphasis role="italic">text</emphasis>,
or 0 in all other cases.
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthStringWidthPX" xreflabel="stringWidthPX"><title>stringWidthPX</title>
<indexterm><primary>stringWidthPX</primary></indexterm>
<indexterm><primary>ListView class</primary><secondary>stringWidthPX</secondary></indexterm>
<programlisting>
<![CDATA[
>>--stringWidthPX(--text--)----------------------><
]]>
</programlisting>
<para>
Determines the width, in pixels, of the specified string using the list-view's current font.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single arguments is:
<variablelist>
<varlistentry><term>text</term>
<listitem>
<para>
The text whose width is desired.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the exact width of the text in pixels, or 0 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">stringWidthPx</emphasis> method returns the exact width, in pixels, of the specified
string. If the returned width is used as the column width in the
<xref linkend="mthSetColumnWidthPX"/> method, the string will be truncated. To get the column width
that can contain the string without truncating it, the programmer must add padding to the returned width.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ListView::stringWidthPX() -->
<section id="mthTextBkColor" xreflabel="textBkColor"><title>textBkColor</title>
<indexterm><primary>textBkColor</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~TextBkColor------------------------------------><
]]>
</programlisting>
<para>The textBkColor method retrieves the background
color of the text in a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The <xref linkend="defColorPalette"/> index specifier (0 to 18).
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthTextBkColorEquals" xreflabel="textBkColor="><title>textBkColor=</title>
<indexterm><primary>textBkColor=</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~textBkColor=(--color--)------------------------><
]]>
</programlisting>
<para>The textBkColor= method sets the background color
for the text in a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>color</term>
<listitem><para>
The new background color for text. Specify the <xref linkend="defColorPalette"/> index specifier (0 to 18).
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthTextColor" xreflabel="textColor"><title>textColor</title>
<indexterm><primary>textColor</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~TextColor--------------------------------------><
]]>
</programlisting>
<para>The textColor method retrieves the text color of
a list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
The <xref linkend="defColorPalette"/> index specifier (0 to 18).
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthTextColorEquals" xreflabel="textColor"><title>textColor=</title>
<indexterm><primary>textColor=</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~textColor=(--color--)--------------------------><
]]>
</programlisting>
<para>The textColor= method sets the text color of a
list-view control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>color</term>
<listitem><para>
The new text color. Specify the <xref linkend="defColorPalette"/> index specifier (0 to 18).
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example sets the text color of a list control to light
blue:
<programlisting>
<![CDATA[
::method LightBlue
curList = self~newListView(104)
curList~bkColor = 9
curList~update
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthUncheckClsListControl" xreflabel="uncheck"><title>uncheck</title>
<indexterm><primary>uncheck</primary>
<secondary>ListView class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~uncheck(--index--)------------------------------------------><
]]>
</programlisting>
<para>The <computeroutput>uncheck</computeroutput> method removes the check mark
for a list-view item. This method is only valid for list-view controls that
have the check boxes extended style. (See the
<xref linkend="mthAddExtendedStyle"/> method for a description
of the check boxes extended style.)
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>index</term>
<listitem><para>The index of the item where the check box check is to be
removed.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>Success.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>An (internal) problem with the control's window handle.
</para></listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem><para>The list-view control does not have the check boxes extended
style.
</para></listitem></varlistentry>
<varlistentry><term>-3</term>
<listitem><para>The index is invalid.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example is from a doctor's office custom
accounting application. A list box is filled with information for every
patient. One button in the application checks every patient with an outstanding
balance, they will be mailed a statement for that balance. The doctor does not
believe in sending billing statements to patients that have a very low balance.
However what a &quot;low&quot; balance is depends on how he is feeling at
statement time. Therefore the application allows the office manager to
dynamically remove some patients from the statement list.
<programlisting>
<![CDATA[
::method onDeferBilling
expose billingList
text = self~newEdit(IDC_EDIT_MINAMOUNT)~getText
minimun = self~decimalNumber(text)
if minimum > 0 then do i = 0 to billingList~items
if billingList~isChecked(i) then do
-- Column 6 in the list is the patient's current balance.
owes = billingList~itemText(i, 6)
if self~decimalNumber(owes) <= minimum then billingList~uncheck(i)
end
end
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthUncheckAll" xreflabel="uncheckAll"><title>uncheckAll</title>
<indexterm><primary>uncheckAll</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~UncheckAll--------------------------------------------------><
]]>
</programlisting>
<para>The <computeroutput>uncheckAll</computeroutput> method clears the check
mark for every list-view item. This method is only valid for list-view controls
that have the check boxes extended style. (See the
<xref linkend="mthAddExtendedStyle"/> method for a description
of the check boxes extended style.)
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>This method takes no arguments.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>Success.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>An (internal) problem with the control's window handle.
</para></listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem><para>The list-view control does not have the check boxes extended
style.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example is from a program that has a push button
that allows the user to remove the check mark from all the check boxes:
<programlisting>
<![CDATA[
::method onUncheckAll
list = self~newListView(IDC_LIST_REPUBLICANS)
list~uncheckAll
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthUpdateItem" xreflabel="updateItem"><title>updateItem</title>
<indexterm><primary>updateItem</primary></indexterm>
<programlisting>
<![CDATA[
>>-aListControl~updateItem(--item--)---------------------------><
]]>
</programlisting>
<para>The updateItem method updates a list-view item.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>item</term>
<listitem><para>The number of the item to be updated.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The item was updated.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>You did not specify <emphasis role="italic">item</emphasis>.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>For all other cases.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="clsLvFullRow" xreflabel="LvFullRow"><title>LvFullRow Class</title>
<indexterm><primary>LvFullRow class</primary></indexterm>
<para>
A <computeroutput>LvFullRow</computeroutput> object is used in ooDialog to represent a list-view item and all subitems
of that item. A <computeroutput>LvFullRow</computeroutput> object is composed of a <xref linkend="clsLvItem"/> object whose
attributes reflect the list-view item and zero or more <xref linkend="clsLvSubItem"/> objects that reflect the subitems of
the list-view item in the <link linkend="ovvUnderlying">underlying</link> list-view.
</para>
<para>
Normally, the subitems of a list-view item are only thought about when the list-view is in report view. However, once added
to an item, the subitems exist whatever view the list-view is in. A full row object can be used to add or insert items
along with all the subitems of the item, or to query information about an item and its subitems.
</para>
<section id="sctMethodsLvFullRow"><title>Method Table</title>
<para>
The following table lists the class and instance methods of the <computeroutput>LvFullRow</computeroutput> class:
<table id="tblMethodsLvFullRow" frame="all"> <title>LvFullRow Class Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class</emphasis></entry>
<entry align="center"><emphasis role="bold">Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthNewClsLvFullRow"/></entry>
<entry>Instantiates a new <computeroutput>LvFullRow</computeroutput> object.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance</emphasis></entry>
<entry align="center"><emphasis role="bold">Methods</emphasis></entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="mthNewClsLvFullRow" xreflabel="new"><title>new (Class Method)</title>
<indexterm><primary>new</primary><secondary>LvFullRow class</secondary></indexterm>
<indexterm><primary>LvFullRow class</primary><secondary>new</secondary></indexterm>
<programlisting>
<![CDATA[
+--------------+
V |
>>--new(--item--+--------------+--)--------------><
+--,--subItem--+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>LvFullRow</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>item [required]</term>
<listitem>
<para>
A <link linkend="clsLvItem">LvItem</link> object that specifies the attributes of the list-view item being added.
</para>
</listitem></varlistentry>
<varlistentry><term>subItem [optional]</term>
<listitem>
<para>
A <link linkend="clsLvSubItem">LvSubItem</link> object that specifies the attributes of a subitem of the list-view
item being added. The argument can repeat has many times as needed to specify all the subitems of the item. The
subitems are added to the item in the order of the arguments to the <emphasis role="italic">new</emphasis> method.
</para>
<para>
<emphasis role="bold">Note:</emphasis> The very last argument can optionally be <computeroutput>.true</computeroutput>
or <computeroutput>.false</computeroutput> to signal that the <computeroutput>LvFullRow</computeroutput> object
itself is to be assigned as the user data value of the list-view items. This usage is explained in the remarks
section.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the new <computeroutput>LvFullRow</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Each subitem argument must be specified. If a subitem is omitted and a subitem argument follows it, a syntax
condition is raised. That is, if a subitem is specified, its preceding subitem must not have been omitted. These
statements are acceptable:
<programlisting>
<![CDATA[
row = .LvFullRow~new(item)
row = .LvFullRow~new(item, si1, si2)
row = .LvFullRow~new(item, si1, si2, si3)
]]>
</programlisting>
These statements will raise a syntax codition:
<programlisting>
<![CDATA[
row = .LvFullRow~new(item, , si2)
row = .LvFullRow~new(item, si1, , si3)
]]>
</programlisting>
</para>
<para>
In addition to specifying <computeroutput>LvSubItem</computeroutput> objects, the last argument can be either true or
false. Recall that the list-view control allows the programmer to attach a user data value to any or all of the list-view
items. The last argument can be true to specify that the <computeroutput>LvFullRow</computeroutput> object being
instantiated should be set as the user data value for the list-view item the <computeroutput>LvFullRow</computeroutput>
object represents.
</para>
<para>
This feature is really only of use if the full row object is used to add or insert an item into the list-view. If the
full row object is not to be used to add an item to the list-view, then there is no reason to use the last argument of
true or false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows a method that creates an array of list-view full rows from NFL football player data. The array is
later used to insert the rows into a list-view control.
<programlisting>
<![CDATA[
::method getPlayers private
players = .NFLPlayer~playersFromDataSource("nflPlayers.txt")
self~masterList = .MasterPlayerList~new(players)
playerRows = .array~new(players~items)
do i = 1 to players~items
j = i - 1
p = players[i]
lvi = .LvItem~new(j, , p~name, , p)
lvsi1 = .LvSubItem~new(j, 1, p~team)
lvsi2 = .LvSubItem~new(j, 2, p~position)
lvsi3 = .LvSubItem~new(j, 3, p~rating)
r = .LvFullRow~new(lvi, lvsi1, lvsi2, lvsi3)
playerRows[i] = r
end
return playerRows
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvFullRow::new() -->
<section id="mthAddSubItem" xreflabel="addSubItem"><title>addSubItem</title>
<indexterm><primary>addSubItem</primary></indexterm>
<indexterm><primary>LvFullRow class</primary><secondary>addSubItem</secondary></indexterm>
<programlisting>
<![CDATA[
>>--addSubItem(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvFullRow::addSubItem() -->
<section id="mthItem" xreflabel="item"><title>item</title>
<indexterm><primary>item</primary></indexterm>
<indexterm><primary>LvFullRow class</primary><secondary>item</secondary></indexterm>
<programlisting>
<![CDATA[
>>--item(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvFullRow::item() -->
<section id="mthRemoveSubItem" xreflabel="removeSubItem"><title>removeSubItem</title>
<indexterm><primary>removeSubItem</primary></indexterm>
<indexterm><primary>LvFullRow class</primary><secondary>removeSubItem</secondary></indexterm>
<programlisting>
<![CDATA[
>>--removeSubItem(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvFullRow::removeSubItem() -->
<section id="mthSubItem" xreflabel="subItem"><title>subItem</title>
<indexterm><primary>subItem</primary></indexterm>
<indexterm><primary>LvFullRow class</primary><secondary>subItem</secondary></indexterm>
<programlisting>
<![CDATA[
>>--subItem(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvFullRow::subItem() -->
<section id="mthSubItems" xreflabel="subItems"><title>subItems</title>
<indexterm><primary>subItems</primary></indexterm>
<indexterm><primary>LvFullRow class</primary><secondary>subItems</secondary></indexterm>
<programlisting>
<![CDATA[
>>--subItems(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvFullRow::subItems() -->
</section> <!-- End LvFullRow Class -->
<section id="clsLvItem" xreflabel="LvItem"><title>LvItem Class</title>
<indexterm><primary>LvItem class</primary></indexterm>
<para>
A <computeroutput>LvItem</computeroutput> object represents a single item in a list-view control. List-view items have
an icon, a label, a current state, and an application-defined value. The attributes of the
<computeroutput>LvItem</computeroutput> object reflect the values the icon, label, state, etc., for the list-view
item.
</para>
<section id="sctMethodsLvItem"><title>Method Table</title>
<para>
The following table lists the class and instance methods of the <computeroutput>LvItem</computeroutput> class:
<table id="tblMethodsLvItem" frame="all"> <title>LvItem Class Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
</row>
<row>
<entry><link linkend="mthNewClsLvItem">new</link></entry>
<entry>Instantiates a new <computeroutput>LvItem</computeroutput> object.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="mthNewClsLvItem" xreflabel="new"><title>new (Class Method)</title>
<indexterm><primary>new</primary><secondary>LvItem class</secondary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>new</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(--+--------+--+-------+--+-------------+--+-------+--+---------+-------->
+--indx--+ +-,-txt-+ +-,-imageIndx-+ +-,-msk-+ +-,-user-+
>---+------------+-+---------------+-+----------+-+-----------+-+--------+--)---><
+-,-itmState-+ +-,-itmStateMsk-+ +-,-indent-+ +-,-groupID-+ +-,-cols-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>LvItem</computeroutput> object. <computeroutput>LvItem</computeroutput> objects are
used in some <link linkend="clsListView">Listview</link> methods such as <link
linkend="mthAddFullRow">addFullRow</link>. It is anticipated that future versions of ooDialog will make more use of
<computeroutput>LvItem</computeroutput> objects.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
xx
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::new() -->
<section id="atrColumnFormatsClsLvi" xreflabel="columnFormats"><title>columnFormats (Attribute)</title>
<indexterm><primary>columnFormats</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>columnFormats</secondary></indexterm>
<programlisting>
<![CDATA[
>>--columnFormats-----------------------------------------------------><
>>--columnFormats-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">columnFormats get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">columnFormats set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::columnFormats() [attribute] -->
<section id="atrColumnsClsLvi" xreflabel="columns"><title>columns (Attribute)</title>
<indexterm><primary>columns</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>columns</secondary></indexterm>
<programlisting>
<![CDATA[
>>--columns-----------------------------------------------------><
>>--columns-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">columns get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">columns set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::columns() [attribute] -->
<section id="atrGroupIDClsLvi" xreflabel="groupID"><title>groupID (Attribute)</title>
<indexterm><primary>groupID</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>groupID</secondary></indexterm>
<programlisting>
<![CDATA[
>>--groupID-----------------------------------------------------><
>>--groupID-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">groupID get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">groupID set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::groupID() [attribute] -->
<section id="atrImageIndexClsLvi" xreflabel="imageIndex"><title>imageIndex (Attribute)</title>
<indexterm><primary>imageIndex</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>imageIndex</secondary></indexterm>
<programlisting>
<![CDATA[
>>--imageIndex-----------------------------------------------------><
>>--imageIndex-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">imageIndex get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">imageIndex set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::imageIndex() [attribute] -->
<section id="atrIndentClsLvi" xreflabel="indent"><title>indent (Attribute)</title>
<indexterm><primary>indent</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>indent</secondary></indexterm>
<programlisting>
<![CDATA[
>>--indent-----------------------------------------------------><
>>--indent-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">indent get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">indent set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::indent() [attribute] -->
<section id="atrIndexClsLvi" xreflabel="index"><title>index (Attribute)</title>
<indexterm><primary>index</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>index</secondary></indexterm>
<programlisting>
<![CDATA[
>>--index-----------------------------------------------------><
>>--index-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">index get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">index set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::index() [attribute] -->
<section id="atrItemStateClsLvi" xreflabel="itemState"><title>itemState (Attribute)</title>
<indexterm><primary>itemState</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>itemState</secondary></indexterm>
<programlisting>
<![CDATA[
>>--itemState-----------------------------------------------------><
>>--itemState-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">itemState get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">itemState set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::itemState() [attribute] -->
<section id="atrItemStateMaskClsLvi" xreflabel="itemStateMask"><title>itemStateMask (Attribute)</title>
<indexterm><primary>itemStateMask</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>itemStateMask</secondary></indexterm>
<programlisting>
<![CDATA[
>>--itemStateMask-----------------------------------------------------><
>>--itemStateMask-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">itemStateMask get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">itemStateMask set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::itemStateMask() [attribute] -->
<section id="atrMaskClsLvi" xreflabel="mask"><title>mask (Attribute)</title>
<indexterm><primary>mask</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>mask</secondary></indexterm>
<programlisting>
<![CDATA[
>>--mask-----------------------------------------------------><
>>--mask-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">mask get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">mask set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End LvItem::mask() [attribute] -->
<section id="atrOverlayImageIndexClsLvi" xreflabel="overlayImageIndex"><title>overlayImageIndex (Attribute)</title>
<indexterm><primary>overlayImageIndex</primary></indexterm>
<indexterm><primary>LvItem class</primary><secondary>overlayImageIndex</secondary></indexterm>
<programlisting>
<![CDATA[
>>--overlayImageIndex-----------------------------------------------------><
>>--overlayImageIndex-=-varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">overlayImageIndex get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">overlayImageIndex set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term></