Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

[r8763]: docs / trunk / oodialog / en-US / baseClasses.xml Maximize Restore History

Download this file

baseClasses.xml    4545 lines (3995 with data), 158.3 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
<?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-2013 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="chpBaseObjects"><title>Base and Mixin Classes</title>
<indexterm><primary>Base classes</primary></indexterm>
<indexterm><primary>Base Mixin classes</primary></indexterm>
<para>
ooDialog programs primarily deal with dialog and dialog control objects. The top-level objects in the programs, say
a user <xref linkend="clsUserDialog"/> or a button <xref linkend="clsButton"/> are
actually composed of a number of base objects and / or mixin classes. All dialog and dialog control objects contain
the methods of their component base classes.
</para>
<para>
To make it easier to understand the methods and attributes that all dialogs have in common, this documentation treats
the <xref linkend="chpDialogObject"/> object as a whole. The dialog object chapter shows all the methods
and attributes that every dialog has, without making much distinction as to what specific mixin or base class the
method belongs to. The dialog <xref linkend="chpDialogControlObject"/> object, is treated in a similar
fashion in its chapter.
</para>
<para>
This chapter describes the base and mixin classes that make up the dialog object and the dialog control object and
shows how they fit together. In addition, it contains the detailed information for the mixin classes inherited by both
the dialog and dialog control object. The <xref linkend="chpDialogObject"/> object and the
dialog <xref linkend="chpDialogControlObject"/> object chapters link back to this chapter for the detailed
information where needed.
</para>
<section id="sctComponentClassesDiagram"><title>Component Classes Diagram</title>
<para>
The diagram shown here shows the relation between the dialog and the dialog control objects and their respective
component classes. The abstract classes are shown in red. The mixin classes in green. And the concrete subclasses in
blue.
</para>
<figure id="figComponentClassesDiagram"><title>Components</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/dialog_dialogControl_objects_classDiagram.jpg" scale="50" />
</imageobject>
</mediaobject>
</figure>
</section>
<section id="clsPlainBaseDialog" xreflabel="PlainBaseDialog"><title>PlainBaseDialog Class</title>
<indexterm><primary>PlainBaseDialog Class</primary></indexterm>
<para>
PlainBaseDialog is the base class of all dialog classes in the ooDialog framework. It implements methods that are
common to every dialog. PlainBaseDialog is an abstract class. A programmer can not instantiate a new PlainBaseDialog
object and display a dialog on the screen. Rather, the ooDialog programmer subclasses one of the concrete classes
provided by the ooDialog framework, such as the <xref linkend="clsResDialog"/>, the <xref linkend="clsRcDialog"/>, or
the <xref linkend="clsUserDialog"/>, to create and execute a real dialog.
</para>
<para>
Many of the methods of the PlainBaseDialog are actually implemented in one of the mixin classes inherited by the
PlainBaseDialog. See this <link linkend="figComponentClassesDiagram">diagram</link>/> to visualize the inheritance. In
essence the PlainBaseDialog is the <xref linkend="chpDialogObject"/> object. All the methods and attributes
of the PlainBaseDialog are listed in the dialog object chapter. This includes the methods and attributes of its
inherited mixin classes.
</para>
<para>
The PlainBaseDialog inherits the following mixin classes:
<itemizedlist>
<listitem><para><xref linkend="clsWindowBase"/></para></listitem>
<listitem><para><xref linkend="clsWindowExtensions"/></para></listitem>
<listitem><para><xref linkend="clsDialogExtensions"/></para></listitem>
<listitem><para><xref linkend="clsEventNotification"/></para></listitem>
<listitem><para><xref linkend="clsResourceUtils"/></para></listitem>
</itemizedlist>
</para>
<section id="sctMethodsPlainBaseDialog"><title>Method Table</title>
<para>
The following table lists the constant methods, class methods, attribute methods, and instance methods of the
<computeroutput>PlainBaseDialog</computeroutput> class:
</para>
<table id="tblMethodsPlainBaseDialog" frame="all"> <title>PlainBaseDialog Method Reference</title>
<tgroup cols="2">
<colspec colwidth="3*" />
<colspec colwidth="8*" />
<thead>
<row>
<entry>Dialog Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><link linkend="tblConstantsDlgObject">Constant</link> Methods</entry>
<entry>The <computeroutput>PlainBaseDialog</computeroutput> provides a number of <emphasis role="italic">constant</emphasis> values through the <computeroutput>::constant</computeroutput>directive.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="pbdNew"/></entry>
<entry>Instantiates a new dialog object.</entry>
</row>
<row>
<entry><xref linkend="pbdGetFontName"/></entry>
<entry>Returns the default font for all dialogs.</entry>
</row>
<row>
<entry><xref linkend="pbdGetFontSize"/></entry>
<entry>Returns the default font size for all dialogs.</entry>
</row>
<row>
<entry><xref linkend="pbdSetDefaultFont"/></entry>
<entry>Sets the default font name and size for all dialogs.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="pbdAutoDetect"/></entry>
<entry>If automatic data field detection is on or off.</entry>
</row>
<row>
<entry><xref linkend="pbdDlgHandle"/></entry>
<entry>The window handle of the dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdFontName"/></entry>
<entry>Name of the dialog's font.</entry>
</row>
<row>
<entry><xref linkend="pbdFontSize"/></entry>
<entry>Point size of the dialog's font.</entry>
</row>
<row>
<entry><xref linkend="pbdOwnerDialog"/></entry>
<entry>The owner dialog of the dialog, if there is one.</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="pbdAddComboEntry"/></entry>
<entry>Adds a string to the list of a combo box.</entry>
</row>
<row>
<entry><xref linkend="pbdAddListEntry"/></entry>
<entry>Adds a string to the specified list box.</entry>
</row>
<row>
<entry><xref linkend="pbdAddNewAttribute"/></entry>
<entry>Adds a new attribute (a method) to this dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdAddNewMethod"/></entry>
<entry>Adds a new method to this dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdAutoDetection"/></entry>
<entry>Turns automatic data field detection on</entry>
</row>
<row>
<entry><xref linkend="pbdBackgroundBitmap"/></entry>
<entry>Sets a bitmap as the dialog's background picture.</entry>
</row>
<row>
<entry><xref linkend="pbdBackgroundColor"/></entry>
<entry>Sets the background color of a dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdCancel"/></entry>
<entry>A default event handler, provided by the ooDialog framework , for the cancel event.</entry>
</row>
<row>
<entry><xref linkend="pbdCenter"/></entry>
<entry>Moves the dialog to the screen center.</entry>
</row>
<row>
<entry><xref linkend="pbdChangeComboEntry"/></entry>
<entry>changeComboEntry</entry>
</row>
<row>
<entry><xref linkend="pbdChangeListEntry"/></entry>
<entry>changeListEntry</entry>
</row>
<row>
<entry><xref linkend="pbdComboAddDirectory"/></entry>
<entry>Adds all or selected file names in the given directory to the combo box.</entry>
</row>
<row>
<entry><xref linkend="pbdComboDrop"/></entry>
<entry>Deletes all items from the list of the given combo box.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectCheckBox"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a check box control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectComboBox"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a combo box control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectDateTimePicker"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a date time picker control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectEdit"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a edit control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectListBox"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a list box control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectListView"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a list view control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectMonthCalendar"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a month calendar control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectRadioButton"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a radio button control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectTab"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a tab control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectTrackBar"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a track bar control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectTreeview"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a tree view control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdConnectUpDown"/></entry>
<entry>Creates a data attribute in the Rexx dialog object and connects it to a up-down control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdDeleteComboEntry"/></entry>
<entry>Deletes a string from the combo box.</entry>
</row>
<row>
<entry><xref linkend="pbdDeleteListEntry"/></entry>
<entry>Deletes an item from a list box.</entry>
</row>
<row>
<entry><xref linkend="pbdDisableControl"/></entry>
<entry>Disables the dialog control with the specified ID.</entry>
</row>
<row>
<entry><xref linkend="pbdDlgUnit2pixel"/></entry>
<entry>Takes a dimension expressed in dialog units of this dialog and transforms it to a dimension expressed in pixels.</entry>
</row>
<row>
<entry><xref linkend="pbdEnableControl"/></entry>
<entry>Enables the control with the specified resource id.</entry>
</row>
<row>
<entry><xref linkend="pbdEnsureVisible"/></entry>
<entry>Causes the dialog to reposition itself so that it is entirely on the visible screen.</entry>
</row>
<row>
<entry><xref linkend="pbdExecute"/></entry>
<entry>Creates the underlying dialog, shows it, starts the automatic methods, if any, and destroys the underlying dialog when the user closes it.</entry>
</row>
<row>
<entry><xref linkend="pbdFindComboEntry"/></entry>
<entry>Returns the index corresponding to a given text string in the combo box.</entry>
</row>
<row>
<entry><xref linkend="pbdFindListEntry"/></entry>
<entry>Returns the index of the specified string within the list box with the specified ID.</entry>
</row>
<row>
<entry><xref linkend="pbdFocusControl"/></entry>
<entry>Sets the input focus to the specified dialog control.</entry>
</row>
<row>
<entry><xref linkend="pbdGet"/></entry>
<entry>Returns the window handle of the Windows dialog associated with the top Rexx dialog instance.</entry>
</row>
<row>
<entry><xref linkend="pbdGetCheckBoxData"/></entry>
<entry>Sets the value of the connected data attribute in the Rexx dialog object to match the state of the specified check box in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdGetComboBoxData"/></entry>
<entry>Sets the value of the connected data attribute in the Rexx dialog object to match the state of the specified combo box in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdGetComboEntry"/></entry>
<entry>Returns the string at the specified index of the combo box.</entry>
</row>
<row>
<entry><xref linkend="pbdGetComboItems"/></entry>
<entry>Returns the number of items in the combo box.</entry>
</row>
<row>
<entry><xref linkend="pbdGetControlData"/></entry>
<entry>Sets the value of the connected data attribute in the Rexx dialog object to match the state of the specified dialog control in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdGetControlHandle"/></entry>
<entry>Retrieves the window handle of the specified dialog control.</entry>
</row>
<row>
<entry><xref linkend="pbdGetControlID"/></entry>
<entry>Returns the numeric resource ID of the control with the specified window handle.</entry>
</row>
<row>
<entry><xref linkend="pbdGetControlText"/></entry>
<entry>Gets the text of the specified dialog control</entry>
</row>
<row>
<entry><xref linkend="pbdGetCurrentComboIndex"/></entry>
<entry>Returns the index of the currently selected item in the comb box.</entry>
</row>
<row>
<entry><xref linkend="pbdGetCurrentListIndex"/></entry>
<entry>Returns the index of the currently selected list box item, or 0 if no item is selected.</entry>
</row>
<row>
<entry><xref linkend="pbdGetData"/></entry>
<entry>Sets all the Rexx dialog data attribute values to the state of the underlying, connected, Windows dialog controls.</entry>
</row>
<row>
<entry><xref linkend="pbdGetDataAttribute"/></entry>
<entry>Sets a data attribute of the Rexx dialog using the data from a connected Windows dialog control.</entry>
</row>
<row>
<entry><xref linkend="pbdGetDataStem"/></entry>
<entry>Sets the values of the indexes of the specified stem to the state of the underlying, connected, Windows dialog controls.</entry>
</row>
<row>
<entry><xref linkend="pbdGetFocus"/></entry>
<entry>Returns the window handle of the dialog control that currently has the input focus.</entry>
</row>
<row>
<entry><xref linkend="pbdGetListBoxData"/></entry>
<entry>Sets the value of the connected data attribute in the Rexx dialog object to match the state of the specified list box in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdGetListEntry"/></entry>
<entry>Returns the string at the specified index of the list box.</entry>
</row>
<row>
<entry><xref linkend="pbdGetListItems"/></entry>
<entry>Returns the number of items in the list box.</entry>
</row>
<row>
<entry><xref linkend="pbdGetMenuBar"/></entry>
<entry>Returns the menu object attached to the dialog, or .nil if there is no menu attached.</entry>
</row>
<row>
<entry><xref linkend="pbdGetRadioButtonData"/></entry>
<entry>Sets the value of the connected data attribute in the Rexx dialog object to match the state of the specified radio button in the underlying dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdGetSelf"/></entry>
<entry>Returns the window handle of the dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdGetTextSizeDlg"/></entry>
<entry>Calculates the size needed to display a string in dialog units.</entry>
</row>
<row>
<entry><xref linkend="pbdGetTextSizeDu"/></entry>
<entry>Calculates the size needed to display a string in dialog units <emphasis role="bold">(preferred method.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="pbdGetWindowText"/></entry>
<entry>Gets the text of the specified window.</entry>
</row>
<row>
<entry><xref linkend="pbdHasMenuBar"/></entry>
<entry>Tests if the dialog has a menu bar attached.</entry>
</row>
<row>
<entry><xref linkend="pbdHelp"/></entry>
<entry>A default implementation of the help event handler method provided by the ooDialog framework.</entry>
</row>
<row>
<entry><xref linkend="pbdHideControl"/></entry>
<entry>Hides the specified control by marking it invisible and immediately redrawing the area it occupies.</entry>
</row>
<row>
<entry><xref linkend="pbdHideControlFast"/></entry>
<entry>Marks the specified control as invisible without any redrawing.</entry>
</row>
<row>
<entry><xref linkend="pbdHideWindow"/></entry>
<entry>Hides a whole dialog window or a dialog control window and forces the window to repaint.</entry>
</row>
<row>
<entry><xref linkend="pbdHideWindowFast"/></entry>
<entry>Hides a whole dialog window or a dialog control window, but does not force the window to redraw.</entry>
</row>
<row>
<entry><xref linkend="pbdInitAutoDetection"/></entry>
<entry>Switches automatic data field detection on or off.</entry>
</row>
<row>
<entry><xref linkend="pbdInitDialog"/></entry>
<entry>A method automatically invoked by the ooDialog framework when the underlying dialog is first created.</entry>
</row>
<row>
<entry><xref linkend="pbdInsertComboEntry"/></entry>
<entry>Inserts a string into the list of a combo box.</entry>
</row>
<row>
<entry><xref linkend="pbdInsertListEntry"/></entry>
<entry>Inserts a string into the specified list box.</entry>
</row>
<row>
<entry><xref linkend="pbdIsDialogActive"/></entry>
<entry>Returns true if the underlying Windows dialog still exists.</entry>
</row>
<row>
<entry><xref linkend="pbdIsMaximized"/></entry>
<entry>Checks if a dialog is currently maximized.</entry>
</row>
<row>
<entry><xref linkend="pbdIsMinimized"/></entry>
<entry>Checks if a dialog is currently minimized.</entry>
</row>
<row>
<entry><xref linkend="pbdLeaving"/></entry>
<entry>A method automatically invoked by the ooDialog framework when the underlying dialog is being closed.</entry>
</row>
<row>
<entry><xref linkend="pbdListAddDirectory"/></entry>
<entry>Adds all or selected file names of a given directory to the list box.</entry>
</row>
<row>
<entry><xref linkend="pbdListDrop"/></entry>
<entry>Removes all items from the list box.</entry>
</row>
<row>
<entry><xref linkend="pbdMaximize"/></entry>
<entry>Maximizes the dialog on the screen.</entry>
</row>
<row>
<entry><xref linkend="pbdMinimize"/></entry>
<entry>Minimizes the dialog to the taskbar.</entry>
</row>
<row>
<entry><xref linkend="pbdNewCheckBox"/></entry>
<entry>Returns an object of the <computeroutput>CheckBox</computeroutput> class for the check box control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewComboBox"/></entry>
<entry>Returns an object of the <computeroutput>ComboBox</computeroutput> class for the combo box control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewDateTimePicker"/></entry>
<entry>Returns an object of the <computeroutput>DateTimePicker</computeroutput> class for the date time picker control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewEdit"/></entry>
<entry>Returns an object of the <computeroutput>Edit</computeroutput> class for the edit control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewGroupBox"/></entry>
<entry>Returns an object of the <computeroutput>GroupBox</computeroutput> class for the group box control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewListBox"/></entry>
<entry>Returns an object of the <computeroutput>ListBox</computeroutput> class for the list box control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewListView"/></entry>
<entry>Returns an object of the <computeroutput>ListView</computeroutput> class for the list-view control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewMonthCalendar"/></entry>
<entry>Returns an object of the <computeroutput>MonthCalendar</computeroutput> class for the month calendar control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewProgressBar"/></entry>
<entry>Returns an object of the <computeroutput>ProgressBar</computeroutput> class for the progress bar control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewPushButton"/></entry>
<entry>Returns an object of the <computeroutput>Button</computeroutput> class for the push button control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewRadioButton"/></entry>
<entry>Returns an object of the <computeroutput>RadioButton</computeroutput> class for the radio button control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewScrollBar"/></entry>
<entry>Returns an object of the <computeroutput>ScrollBar</computeroutput> class for the scroll bar control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewTrackBar"/></entry>
<entry>Returns an object of the <computeroutput>TrackBar</computeroutput> class for the track bar control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewStatic"/></entry>
<entry>Returns an object of the <computeroutput>Static</computeroutput> class for the static control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewTab"/></entry>
<entry>Returns an object of the <computeroutput>Tab</computeroutput> class for the tab control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewTreeView"/></entry>
<entry>Returns an object of the <computeroutput>TreeView</computeroutput> class for the tree-view control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNewUpDown"/></entry>
<entry>Returns an object of the <computeroutput>UpDown</computeroutput> class for the up-down control with the specified resource ID.</entry>
</row>
<row>
<entry><xref linkend="pbdNoAutoDetection"/></entry>
<entry>Turns automatic data field detection off</entry>
</row>
<row>
<entry><xref linkend="pbdOk"/></entry>
<entry>A default event handler, provided by the ooDialog framework, for the cancel event.</entry>
</row>
<row>
<entry><xref linkend="pbdPixel2dlgUnit"/></entry>
<entry>Takes a dimension expressed in pixels and transforms it to a dimension expressed in dialog units of this dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdRestore"/></entry>
<entry>Restores a minimized or maximized dialog to its original position.</entry>
</row>
<row>
<entry><xref linkend="pbdSendMessageToControl"/></entry>
<entry>Sends a Windows message to a dialog control and returns its response as a whole number.</entry>
</row>
<row>
<entry><xref linkend="pbdSendMessageToControlH"/></entry>
<entry>Sends a Windows message to a dialog control and returns its response as a handle.</entry>
</row>
<row>
<entry><xref linkend="pbdSendMessageToWindow"/></entry>
<entry>Sends a Windows message to a window and returns its response as a whole number.</entry>
</row>
<row>
<entry><xref linkend="pbdSendMessageToWindowH"/></entry>
<entry>Sends a Windows message to a window and returns its response as a handle.</entry>
</row>
<row>
<entry><xref linkend="pbdSetCheckBoxData"/></entry>
<entry>Sets the <emphasis role="italic">data</emphasis> of a check box control.</entry>
</row>
<row>
<entry><xref linkend="pbdSetComboBoxData"/></entry>
<entry>Sets the <emphasis role="italic">data</emphasis> of a combo box control.</entry>
</row>
<row>
<entry><xref linkend="pbdSetControlData"/></entry>
<entry>Sets the <emphasis role="italic">data</emphasis> of a dialog control.</entry>
</row>
<row>
<entry><xref linkend="pbdSetControlText"/></entry>
<entry>Sets the text for the specified dialog control</entry>
</row>
<row>
<entry><xref linkend="pbdSetCurrentComboIndex"/></entry>
<entry>Selects the item with the specified index within the combo box list. If called without an index, all items in the combo box list are deselected.</entry>
</row>
<row>
<entry><xref linkend="pbdSetCurrentListIndex"/></entry>
<entry>Selects the item with the specified index in the list box. If called without an index, all items in the list box are deselected.</entry>
</row>
<row>
<entry><xref linkend="pbdSetData"/></entry>
<entry>Sets the state of all underlying, connected, dialog controls to the values of the matching dialog object data attributes.</entry>
</row>
<row>
<entry><xref linkend="pbdSetDataAttribute"/></entry>
<entry>Sets the state of a dialog control using the value of a data attribute of the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdSetDataStem"/></entry>
<entry>Sets the <emphasis role="italic">data</emphasis>, (the state,) of a number of Windows dialog controls to the values specified by a stem.</entry>
</row>
<row>
<entry><xref linkend="pbdSetDlgFont"/></entry>
<entry>Sets the font that to be used for the underlying Windows dialog, when it is created.</entry>
</row>
<row>
<entry><xref linkend="pbdSetEditData"/></entry>
<entry>Sets the <emphasis role="italic">data</emphasis> of an edit control.</entry>
</row>
<row>
<entry><xref linkend="pbdSetFocus"/></entry>
<entry>sets the input focus to a dialog control specified by hwnd and returns the window handle of the control that previously had the focus.</entry>
</row>
<row>
<entry><xref linkend="pbdSetFocusToWindow"/></entry>
<entry>Moves the input focus to another top-level window or dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdSetGroup"/></entry>
<entry>Adds or removes the <xref linkend="wsgroup"/> style for the control specified.</entry>
</row>
<row>
<entry><xref linkend="pbdSetListBoxData"/></entry>
<entry>Sets the <emphasis role="italic">data</emphasis> of the underlying list box to the value specified.</entry>
</row>
<row>
<entry><xref linkend="pbdSetListTabulators"/></entry>
<entry>Sets the tabulators for a list box.</entry>
</row>
<row>
<entry><xref linkend="pbdSetRadioButtonData"/></entry>
<entry>Sets the <emphasis role="italic">data</emphasis> of a radio button control.</entry>
</row>
<row>
<entry><xref linkend="pbdSetTabStop"/></entry>
<entry>Add or remove the tab stop style for the specified control.</entry>
</row>
<row>
<entry><xref linkend="pbdSetWindowText"/></entry>
<entry>Sets the text for the specified window.</entry>
</row>
<row>
<entry><xref linkend="pbdShow"/></entry>
<entry>Sets the dialog window's show state.</entry>
</row>
<row>
<entry><xref linkend="pbdShowControl"/></entry>
<entry>Makes the specified dialog control reappear on the screen.</entry>
</row>
<row>
<entry><xref linkend="pbdShowControlFast"/></entry>
<entry>Shows a dialog control without redrawing its area.</entry>
</row>
<row>
<entry><xref linkend="pbdShowWindow"/></entry>
<entry>Shows the window or dialog control again.</entry>
</row>
<row>
<entry><xref linkend="pbdShowWindowFast"/></entry>
<entry>Marks the specified window as visible but does not force it to redraw.</entry>
</row>
<row>
<entry><xref linkend="pbdTabToNext"/></entry>
<entry>Sets the focus to the next tab stop dialog control in the dialog and returns the window handle of the dialog control that currently has the focus.</entry>
</row>
<row>
<entry><xref linkend="pbdTabToPrevious"/></entry>
<entry>Sets the focus to the previous tab stop dialog control in the dialog and returns the window handle of the dialog control that currently has the focus.</entry>
</row>
<row>
<entry><xref linkend="pbdTiledBackgroundBitmap"/></entry>
<entry>Sets a bitmap as the dialog's background brush.</entry>
</row>
<row>
<entry><xref linkend="pbdToTheTop"/></entry>
<entry>Makes the dialog the topmost dialog.</entry>
</row>
<row>
<entry><xref linkend="pbdValidate"/></entry>
<entry>A method meant to be over-ridden. Its purpose is to validate the user's input and decide whether or not to allow the dialog to close.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="pbdGetFontName" xreflabel="getFontName"><title>getFontName (Class method)</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthClsGetFontName"/>
<![CDATA[
>>--getFontName----------------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetFontSize" xreflabel="getFontSize"><title>getFontSize (Class method)</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthClsGetFontSize"/>
<![CDATA[
>>--getFontSize----------------------------------><
]]>
</programlisting>
</section>
<section id="pbdNew" xreflabel="new"><title>new (Class method)</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewDialogObject"/>
<![CDATA[
>>--new(--library--,--id--+-------------+--+----------+--)---------------------><
+-,--dlgData.-+ +-,--hFile-+
]]>
</programlisting>
</section>
<section id="pbdSetDefaultFont" xreflabel="setDefaultFont"><title>setDefaultFont (Class method)</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthClsSetDefaultFont"/>
<![CDATA[
>>--setDefaultFont(--fontName--,--fontSize--)----><
]]>
</programlisting>
</section>
<section id="pbdAutoDetect" xreflabel="autoDetect"><title>autoDetect (Attribute)</title>
<programlisting>
PlainBaseDialog::<xref linkend="atrAutoDetect"/>
<![CDATA[
>>--autoDetect-----------------------------------><
>>--autoDetect = onOff---------------------------><
]]>
</programlisting>
</section>
<section id="pbdDlgHandle" xreflabel="dlgHandle"><title>dlgHandle (Attribute)</title>
<programlisting>
PlainBaseDialog::<xref linkend="atrDlgHandle"/>
<![CDATA[
]]>
</programlisting>
</section>
<section id="pbdFontName" xreflabel="fontName"><title>fontName (Attribute)</title>
<programlisting>
PlainBaseDialog::<xref linkend="atrFontName"/>
<![CDATA[
>>--fontName-------------------------------------><
>>--fontName = nameVar---------------------------><
]]>
</programlisting>
</section>
<section id="pbdFontSize" xreflabel="fontSize"><title>fontSize (Attribute)</title>
<programlisting>
PlainBaseDialog::<xref linkend="atrFontSize"/>
<![CDATA[
>>--fontSize-------------------------------------><
>>--fontSize = sizeVar---------------------------><
]]>
</programlisting>
</section>
<section id="pbdOwnerDialog" xreflabel="ownerDialog"><title>ownerDialog (Attribute)</title>
<programlisting>
PlainBaseDialog::<xref linkend="atrOwnerDialog"/>
<![CDATA[
>>--ownerDialog----------------------------------><
>>--ownerDialog = rexxDlg------------------------><
]]>
</programlisting>
</section>
<section id="pbdAddComboEntry" xreflabel="addComboEntry"><title>addComboEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthAddComboEntry"/>
<![CDATA[
>>--addComboEntry(--id--,--aString--)------------><
]]>
</programlisting>
</section>
<section id="pbdAddListEntry" xreflabel="addListEntry"><title>addListEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthAddListEntry"/>
<![CDATA[
>>--addListEntry(--id--,--aString--)-------------><
]]>
</programlisting>
</section>
<section id="pbdAddNewAttribute" xreflabel="addNewAttribute"><title>addNewAttribute</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthAddNewAttribute"/>
<![CDATA[
>>--addNewAttribute(--atrName--+------------+--+--------------+--+------------+--)--><
+-,-initVal--+ +-,-unguarded--+ +-,-private--+
]]>
</programlisting>
</section>
<section id="pbdAddNewMethod" xreflabel="addNewMethod"><title>addNewMethod</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthAddNewMethod"/>
<![CDATA[
>>--addNewMethod(--mthName--+--------------+--+------------+--)----------------><
+-,-unguarded--+ +-,-private--+
]]>
</programlisting>
</section>
<section id="pbdBackgroundBitmap" xreflabel="backgroundBitmap"><title>backgroundBitmap</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthBackgroundBitmap"/>
<![CDATA[
>>--backgroundBitmap(--bmpFilename--+-------------+--)-------------------------><
+-,--"USEPAL"-+
]]>
</programlisting>
</section>
<section id="pbdAutoDetection" xreflabel="autoDetection"><title>autoDetection</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthAutoDetection"/>
<![CDATA[
>>--autoDetection--------------------------------><
]]>
</programlisting>
</section>
<section id="pbdBackgroundColor" xreflabel="backgroundColor"><title>backgroundColor</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthBackgroundColor"/>
<![CDATA[
>>--backgroundColor(--color--)-------------------><
]]>
</programlisting>
</section>
<section id="pbdCancel" xreflabel="cancel"><title>cancel</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthCancel"/>
<![CDATA[
>>--cancel---------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdCenter" xreflabel="center"><title>center</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthCenter"/>
<![CDATA[
>>--center(--+------------+--)-------------------><
+--showOpts--+
]]>
</programlisting>
</section>
<section id="pbdChangeComboEntry" xreflabel="changeComboEntry"><title>changeComboEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthChangeComboEntry"/>
<![CDATA[
>>--changeComboEntry(--id--,--+-------+--,--aString--)-------------------------><
+-index-+
]]>
</programlisting>
</section>
<section id="pbdChangeListEntry" xreflabel="changeListEntry"><title>changeListEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthChangeListEntry"/>
<![CDATA[
>>--changeListEntry(--id--,--+-------+--,--aString--)--------------------------><
+-index-+
]]>
</programlisting>
</section>
<section id="pbdComboAddDirectory" xreflabel="comboAddDirectory"><title>comboAddDirectory</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthComboAddDirectory"/>
<![CDATA[
>>--comboAddDirectory(--id--,--drvpath--,--fileAtrs--)----------><
]]>
</programlisting>
</section>
<section id="pbdComboDrop" xreflabel="comboDrop"><title>comboDrop</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthComboDrop"/>
<![CDATA[
>>--comboDrop(--id--)----------------------------><
]]>
</programlisting>
</section>
<section id="pbdConnectCheckBox" xreflabel="connectCheckBox"><title>connectCheckBox</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectCheckBox"/>
<![CDATA[
>>--connctChectBox(--id--+-------------------+--)---------------><
+-,--attributeName--+
]]>
</programlisting>
</section>
<section id="pbdConnectComboBox" xreflabel="connectComboBox"><title>connectComboBox</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectComboBox"/>
<![CDATA[
>>--connectComboBox(--id--+------------------+--)---------------><
+-,-attributeName--+
]]>
</programlisting>
</section>
<section id="pbdConnectDateTimePicker" xreflabel="connectDateTimePicker"><title>connectDateTimePicker</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectDateTimePicker"/>
<![CDATA[
>>--connectDateTimePicker(--id--+------------------+--)---------><
+-,--attributeName-+
]]>
</programlisting>
</section>
<section id="pbdConnectEdit" xreflabel="connectEdit"><title>connectEdit</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectEdit"/>
<![CDATA[
>>--connectEdit(--id--+------------------+--)----><
+-,--attributeName-+
]]>
</programlisting>
</section>
<section id="pbdConnectListBox" xreflabel="connectListBox"><title>connectListBox</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectListBox"/>
<![CDATA[
>>--connectListBox(--id--+-------------------+--)---------------><
+-,--attributeName--+
]]>
</programlisting>
</section>
<section id="pbdConnectListView" xreflabel="connectListView"><title>connectListView</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectListView"/>
<![CDATA[
>>--connectListView(--id--+------------------+--)---------------><
+-,--attributeName-+
]]>
</programlisting>
</section>
<section id="pbdConnectMonthCalendar" xreflabel="connectMonthCalendar"><title>connectMonthCalendar</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectMonthCalendar"/>
<![CDATA[
>>--connectMonthCalendar(--id--+------------------+--)----------><
+-,--attributeName-+
]]>
</programlisting>
</section>
<section id="pbdConnectRadioButton" xreflabel="connectRadioButton"><title>connectRadioButton</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectRadioButton"/>
<![CDATA[
>>--connectRadioButton(--id--+-------------------+--)-----------><
+-,--attributeName--+
]]>
</programlisting>
</section>
<section id="pbdConnectTab" xreflabel="connectTab"><title>connectTab</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectTab"/>
<![CDATA[
>>--connectTab(--id--+------------------+--)-----><
+-,--attributeName-+
]]>
</programlisting>
</section>
<section id="pbdConnectTrackBar" xreflabel="connectTrackBar"><title>connectTrackBar</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectTrackBar"/>
<![CDATA[
>>--connectTrackBar(--id--+------------------+--)---------------><
+-,--attributeName-+
]]>
</programlisting>
</section>
<section id="pbdConnectTreeview" xreflabel="connectTreeview"><title>connectTreeview</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectTreeView"/>
<![CDATA[
>>--connectTreeView(--id--+------------------+--)---------------><
+-,--attributeName-+
]]>
</programlisting>
</section>
<section id="pbdConnectUpDown" xreflabel="connectUpDown"><title>connectUpDown</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthConnectUpDown"/>
<![CDATA[
>>--connectUpDown(--id--+------------------+--)--><
+-,--attributeName-+
]]>
</programlisting>
</section>
<section id="pbdDeleteComboEntry" xreflabel="deleteComboEntry"><title>deleteComboEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthDeleteComboEntry"/>
<![CDATA[
>>--deleteComboEntry(--id--,--index--)-----------><
]]>
</programlisting>
</section>
<section id="pbdDeleteListEntry" xreflabel="deleteListEntry"><title>deleteListEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthDeleteListEntry"/>
<![CDATA[
>>--deleteListEntry(--id--,--index--)------------><
]]>
</programlisting>
</section>
<section id="pbdDisableControl" xreflabel="disableControl"><title>disableControl</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthDisableControl"/>
<![CDATA[
>>--disableControl(--id--)-----------------------><
]]>
</programlisting>
</section>
<section id="pbdDlgUnit2pixel" xreflabel="dlgUnit2pixel"><title>dlgUnit2pixel</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthDlgUnit2pixel"/>
<![CDATA[
>>--dlgUnit2pixel(--du--)------------------------><
]]>
</programlisting>
</section>
<section id="pbdEnableControl" xreflabel="enableControl"><title>enableControl</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthEnableControl"/>
<![CDATA[
>>--enableControl(--id--)------------------------><
]]>
</programlisting>
</section>
<section id="pbdEnsureVisible" xreflabel="ensureVisible"><title>ensureVisible</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthEnsureVisible"/>
<![CDATA[
>>--ensureVisible--------------------------------><
]]>
</programlisting>
</section>
<section id="pbdExecute" xreflabel="execute"><title>execute</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthExecute"/>
<![CDATA[
>>--execute(--+-------------+--+---------+--)----><
+--showOption-+ +-,--icon-+
]]>
</programlisting>
</section>
<section id="pbdFindComboEntry" xreflabel="findComboEntry"><title>findComboEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthFindComboEntry"/>
r<![CDATA[
>>--findComboEntry(--id--,--aString--)-----------><
]]>
</programlisting>
</section>
<section id="pbdFindListEntry" xreflabel="findListEntry"><title>findListEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthFindListEntry"/>
<![CDATA[
>>--findListEntry(--id--,--aString--)------------><
]]>
</programlisting>
</section>
<section id="pbdFocusControl" xreflabel="focusControl"><title>focusControl</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthFocusControl"/>
<![CDATA[
>>--focusControl(--id--)-------------------------><
]]>
</programlisting>
</section>
<section id="pbdGet" xreflabel="get"><title>get</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGet"/>
<![CDATA[
>>--get------------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetCheckBoxData" xreflabel="getCheckBoxData"><title>getCheckBoxData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetCheckBoxData"/>
<![CDATA[
>>--getCheckBoxData(--id--)----------------------><
]]>
</programlisting>
</section>
<section id="pbdGetComboBoxData" xreflabel="getComboBoxData"><title>getComboBoxData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetComboBoxData"/>
<![CDATA[
>>--getComboBoxData(--id--)----------------------><
]]>
</programlisting>
</section>
<section id="pbdGetComboEntry" xreflabel="getComboEntry"><title>getComboEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetComboEntry"/>
<![CDATA[
>>--getComboEntry(--id--,--index--)--------------><
]]>
</programlisting>
</section>
<section id="pbdGetComboItems" xreflabel="getComboItems"><title>getComboItems</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetComboItems"/>
<![CDATA[
>>--getComboItems(--id--)------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetControlData" xreflabel="getControlData"><title>getControlData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetControlData"/>
<![CDATA[
>>--getControlData(--id--)-----------------------><
]]>
</programlisting>
</section>
<section id="pbdGetControlHandle" xreflabel="getControlHandle"><title>getControlHandle</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetControlHandle"/>
<![CDATA[
>>--getControlHandle(--id--+---------+--)--------><
+-,--hDlg-+
]]>
</programlisting>
</section>
<section id="pbdGetControlID" xreflabel="getControlID"><title>getControlID</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetControlID"/>
<![CDATA[
>>--getControlID(--hwnd--)-----------------------><
]]>
</programlisting>
</section>
<section id="pbdGetControlText" xreflabel="getControlText"><title>getControlText</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetControlText"/>
<![CDATA[
>>--getControlText(--id--)-----------------------><
]]>
</programlisting>
</section>
<section id="pbdGetCurrentComboIndex" xreflabel="getCurrentComboIndex"><title>getCurrentComboIndex</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetCurrentComboIndex"/>
<![CDATA[
>>--getCurrentComboIndex(--id--)-----------------><
]]>
</programlisting>
</section>
<section id="pbdGetCurrentListIndex" xreflabel="getCurrentListIndex"><title>getCurrentListIndex</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetCurrentListIndex"/>
<![CDATA[
>>--getCurrentListIndex(--id--)------------------><
]]>
</programlisting>
</section>
<section id="pbdGetData" xreflabel="getData"><title>getData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetData"/>
<![CDATA[
>>--getData--------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetDataAttribute" xreflabel="getDataAttribute"><title>getDataAttribute</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetDataAttribute"/>
<![CDATA[
>>--getDataAttribute(--attributeName--)----------><
]]>
</programlisting>
</section>
<section id="pbdGetDataStem" xreflabel="getDataStem"><title>getDataStem</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetDataStem"/>
<![CDATA[
>>--getDataStem(--dataStem.--)-------------------><
]]>
</programlisting>
</section>
<section id="pbdGetEditData" xreflabel="getEditData"><title>getEditData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetEditData"/>
<![CDATA[
>>-aBaseDialog~getEditData(--id--)----------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetFocus" xreflabel="getFocus"><title>getFocus</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetFocus"/>
<![CDATA[
>>--getFocus-------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetListBoxData" xreflabel="getListBoxData"><title>getListBoxData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetListBoxData"/>
<![CDATA[
>>--getListBoxData(--id--)-----------------------><
]]>
</programlisting>
</section>
<section id="pbdGetListEntry" xreflabel="getListEntry"><title>getListEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetListEntry"/>
<![CDATA[
>>--getListEntry(--id--,--index--)---------------><
]]>
</programlisting>
</section>
<section id="pbdGetListItems" xreflabel="getListItems"><title>getListItems</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetListItems"/>
<![CDATA[
>>--getListItems(--id--)-------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetMenuBar" xreflabel="getMenuBar"><title>getMenuBar</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetMenuBar"/>
<![CDATA[
>>--getMenuBar-----------------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetRadioButtonData" xreflabel="getRadioButtonData"><title>getRadioButtonData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetRadioButtonData"/>
<![CDATA[
>>--getRadioButtonData(--id--)-------------------><
]]>
</programlisting>
</section>
<section id="pbdGetSelf" xreflabel="getSelf"><title>getSelf</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetSelf"/>
<![CDATA[
>>--getSelf--------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdGetTextSizeDlg" xreflabel="getTextSizeDlg"><title>getTextSizeDlg</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetTextSizeDlgClsPlainBaseDialog"/>
<![CDATA[
>>--getTextSizeDlg(--text--+-------------+--+-------------+--+---------+--)----><
+-,-fontname--+ +-,-fontSize--+ +-,-hwnd--+
]]>
</programlisting>
</section>
<section id="pbdGetTextSizeDu" xreflabel="getTextSizeDu"><title>getTextSizeDu</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetTextSizeDu"/>
<![CDATA[
>>--getTextSizeDu(--text--)----------------------><
]]>
</programlisting>
</section>
<section id="pbdGetWindowText" xreflabel="getWindowText"><title>getWindowText</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthGetWindowText"/>
<![CDATA[
>>--getWindowText(--hwnd--)----------------------><
]]>
</programlisting>
</section>
<section id="pbdHasMenuBar" xreflabel="hasMenuBar"><title>hasMenuBar</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthHasMenuBar"/>
<![CDATA[
>>--hasMenuBar-----------------------------------><
]]>
</programlisting>
</section>
<section id="pbdHelp" xreflabel="help"><title>help</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthHelp"/>
<![CDATA[
>>--help-----------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdHideControl" xreflabel="HideControl"><title>HideControl</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthHideControl"/>
<![CDATA[
>>--hideControl(--id--)--------------------------><
]]>
</programlisting>
</section>
<section id="pbdHideControlFast" xreflabel="hideControlFast"><title>hideControlFast</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthHideControlFast"/>
<![CDATA[
>>--hideControlFast(--id--)----------------------><
]]>
</programlisting>
</section>
<section id="pbdHideWindow" xreflabel="hideWindow"><title>hideWindow</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthHideWindow"/>
<![CDATA[
>>--hideWindow(--hwnd--)-------------------------><
]]>
</programlisting>
</section>
<section id="pbdHideWindowFast" xreflabel="hideWindowFast"><title>hideWindowFast</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthHideWindowFast"/>
<![CDATA[
>>--hideWindowFast(--hwnd--)---------------------><
]]>
</programlisting>
</section>
<section id="pbdInitAutoDetection" xreflabel="initAutoDetection"><title>initAutoDetection</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthInitAutoDetection"/>
<![CDATA[
>>-initAutoDetection---------------------------------><
]]>
</programlisting>
</section>
<section id="pbdInitDialog" xreflabel="initDialog"><title>initDialog</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthInitDialog"/>
<![CDATA[
>>--initDialog-----------------------------------><
]]>
</programlisting>
</section>
<section id="pbdInsertComboEntry" xreflabel="insertComboEntry"><title>insertComboEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthInsertComboEntry"/>
<![CDATA[
>>--insertComboEntry(--id--,--+-------+--,--string--)-----------><
+-index-+
]]>
</programlisting>
</section>
<section id="pbdInsertListEntry" xreflabel="insertListEntry"><title>insertListEntry</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthInsertListEntry"/>
<![CDATA[
>>--insertListEntry(--id--,--+-------+--,--aString--)--------------------------><
+-index-+
]]>
</programlisting>
</section>
<section id="pbdIsDialogActive" xreflabel="isDialogActive"><title>isDialogActive</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthIsDialogActive"/>
<![CDATA[
>>--isDialogActive-------------------------------><
]]>
</programlisting>
</section>
<section id="pbdIsMaximized" xreflabel="isMaximized"><title>isMaximized</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthIsMaximized"/>
<![CDATA[
>>--isMaximized----------------------------------><
]]>
</programlisting>
</section>
<section id="pbdIsMinimized" xreflabel="isMinimized"><title>isMinimized</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthIsMinimized"/>
<![CDATA[
>>--isMinimized----------------------------------><
]]>
</programlisting>
</section>
<section id="pbdLeaving" xreflabel="leaving"><title>leaving</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthLeaving"/>
<![CDATA[
>>--leaving--------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdListAddDirectory" xreflabel="listAddDirectory"><title>listAddDirectory</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthListAddDirectory"/>
<![CDATA[
>>--listAddDirectory(--id--,--drvPath--,--fileAtrs--)-----------><
]]>
</programlisting>
</section>
<section id="pbdListDrop" xreflabel="listDrop"><title>listDrop</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthListDrop"/>
<![CDATA[
>>--listDrop(--id--)-----------------------------><
]]>
</programlisting>
</section>
<section id="pbdMaximize" xreflabel="maximize"><title>maximize</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthMaximize"/>
<![CDATA[
>>--maximize-------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdMinimize" xreflabel="minimize"><title>minimize</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthMinimize"/>
<![CDATA[
>>--minimize-------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewCheckBox" xreflabel="newCheckBox"><title>newCheckBox</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewCheckBox"/>
<![CDATA[
>>--newCheckBox(--id--)--------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewComboBox" xreflabel="newComboBox"><title>newComboBox</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewComboBox"/>
<![CDATA[
>>--newComboBox(--id--)--------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewDateTimePicker" xreflabel="newDateTimePicker"><title>newDateTimePicker</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewDateTimePicker"/>
<![CDATA[
>>--newDateTimePicker(--id--)--------------------><
]]>
</programlisting>
</section>
<section id="pbdNewEdit" xreflabel="newEdit"><title>newEdit</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewEdit"/>
<![CDATA[
>>--newEdit(--id--)------------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewGroupBox" xreflabel="newGroupBox"><title>newGroupBox</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewGroupBox"/>
<![CDATA[
>>--newGroupBox(--id--)--------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewListBox" xreflabel="newListBox"><title>newListBox</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewListBox"/>
<![CDATA[
>>--newListBox(--id--)---------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewListView" xreflabel="newListView"><title>newListView</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewListView"/>
<![CDATA[
>>--newListView(--id--)--------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewMonthCalendar" xreflabel="newMonthCalendar"><title>newMonthCalendar</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewMonthCalendar"/>
<![CDATA[
>>--newMonthCalendar(--id--)---------------------><
]]>
</programlisting>
</section>
<section id="pbdNewProgressBar" xreflabel="newProgressBar"><title>newProgressBar</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewProgressBar"/>
<![CDATA[
>>--newProgressBar(--id--)-----------------------><
]]>
</programlisting>
</section>
<section id="pbdNewPushButton" xreflabel="newPushButton"><title>newPushButton</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewPushButton"/>
<![CDATA[
>>--newPushButton(--id--)------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewRadioButton" xreflabel="newRadioButton"><title>newRadioButton</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewRadioButton"/>
<![CDATA[
>>--newRadioButton(--id--)-----------------------><
]]>
</programlisting>
</section>
<section id="pbdNewScrollBar" xreflabel="newScrollBar"><title>newScrollBar</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewScrollBar"/>
<![CDATA[
>>--newScrollBar(--id--)-------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewTab" xreflabel="newTab"><title>newTab</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewTab"/>
<![CDATA[
>>--newTab(--id--)-------------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewStatic" xreflabel="newStatic"><title>newStatic</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewStatic"/>
<![CDATA[
>>--newStatic(--id--)----------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewTrackBar" xreflabel="newTrackBar"><title>newTrackBar</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewTrackBar"/>
<![CDATA[
>>--newTrackBar(--id--)--------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewTreeView" xreflabel="newTreeView"><title>newTreeView</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewTreeView"/>
<![CDATA[
>>--newTreeView(--id--)--------------------------><
]]>
</programlisting>
</section>
<section id="pbdNewUpDown" xreflabel="newUpDown"><title>newUpDown</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNewUpDown"/>
<![CDATA[
>>--newUpDown(--id--)----------------------------><
]]>
</programlisting>
</section>
<section id="pbdNoAutoDetection" xreflabel="noAutoDetection"><title>noAutoDetection</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthNoAutoDetection"/>
<![CDATA[
>>--noAutoDetection------------------------------><
]]>
</programlisting>
</section>
<section id="pbdOk" xreflabel="ok"><title>ok</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthOk"/>
<![CDATA[
>>--ok-------------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdPixel2dlgUnit" xreflabel="pixel2dlgUnit"><title>pixel2dlgUnit</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthPixel2dlgUnit"/>
<![CDATA[
>>--pixel2dlgUnit(--pixels--)--------------------><
]]>
</programlisting>
</section>
<section id="pbdRestore" xreflabel="restore"><title>restore</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthRestore"/>
<![CDATA[
>>--restore--------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdSendMessageToControl" xreflabel="sendMessageToControl"><title>sendMessageToControl</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSendMessageToControl"/>
<![CDATA[
>>--sendMessageToControl(--id--,--msg--,--wParam--,--lParam--)-----------------><
]]>
</programlisting>
</section>
<section id="pbdSendMessageToControlH" xreflabel="sendMessageToControlH"><title>sendMessageToControlH</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSendMessageToControlH"/>
<![CDATA[
>>--sendMessageToControlH(--id--,--msg--,--wParam--,--lParam--)----------------><
]]>
</programlisting>
</section>
<section id="pbdSendMessageToWindow" xreflabel="sendMessageToWindow"><title>sendMessageToWindow</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSendMessageToWindow"/>
<![CDATA[
>>--sendMessageToWindow(--hwnd--,--msg--,--wParam--,--lParam--)----------------><
]]>
</programlisting>
</section>
<section id="pbdSendMessageToWindowH" xreflabel="sendMessageToWindowH"><title>sendMessageToWindowH</title>
<programlisting>
PlainBaseDialog::sendMessageToWindowH<xref linkend="mthSendMessageToWindowH"/>)
<![CDATA[
>>--sendMessageToWindowH(--hwnd,--msg--,--wParam--,--lParam--)-----------------><
]]>
</programlisting>
</section>
<section id="pbdSetCheckBoxData" xreflabel="setCheckBoxData"><title>setCheckBoxData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetCheckBoxData"/>
<![CDATA[
>>--setCheckBoxData(--id--,--data--)-------------><
]]>
</programlisting>
</section>
<section id="pbdSetComboBoxData" xreflabel="setComboBoxData"><title>setComboBoxData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetComboBoxData"/>
<![CDATA[
>>--setComboBoxData(--id--,--data--)-------------><
]]>
</programlisting>
</section>
<section id="pbdSetControlData" xreflabel="setControlData"><title>setControlData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetControlData"/>
<![CDATA[
>>--setControlData(--id--,--dataValue--)---------><
]]>
</programlisting>
</section>
<section id="pbdSetControlText" xreflabel="setControlText"><title>setControlText</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetControlText"/>
<![CDATA[
>>--setControlText(--id--,--text--)--------------><
]]>
</programlisting>
</section>
<section id="pbdSetCurrentComboIndex" xreflabel="setCurrentComboIndex"><title>setCurrentComboIndex</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetCurrentComboIndex"/>
<![CDATA[
>>--setCurrentComboIndex(--id--+----------+--)---><
+-,--index-+
]]>
</programlisting>
</section>
<section id="pbdSetCurrentListIndex" xreflabel="setCurrentListIndex"><title>setCurrentListIndex</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetCurrentListIndex"/>
<![CDATA[
>>--setCurrentListIndex(--id--+----------+--)----><
+-,--index-+
]]>
</programlisting>
</section>
<section id="pbdSetData" xreflabel="setData"><title>setData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetData"/>
<![CDATA[
>>--setData--------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdSetDataAttribute" xreflabel="setDataAttribute"><title>setDataAttribute</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetDataAttribute"/>
<![CDATA[
>>--setDataAttribute(--attributeName--)----------><
]]>
</programlisting>
</section>
<section id="pbdSetDataStem" xreflabel="setDataStem"><title>setDataStem</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetDataStem"/>
<![CDATA[
>>--setDataStem(--dataStem.--)-------------------><
]]>
</programlisting>
</section>
<section id="pbdSetDlgFont" xreflabel="setDlgFont"><title>setDlgFont</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetDlgFont"/>
<![CDATA[
>>--setDlgFont(--fontName--+-----------+--)------><
+-,-fontSize+
]]>
</programlisting>
</section>
<section id="pbdSetEditData" xreflabel="setEditData"><title>setEditData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetEditData"/>
<![CDATA[
>>--setEditData(--id--,--data--)-----------------><
]]>
</programlisting>
</section>
<section id="pbdSetFocus" xreflabel="setFocus"><title>setFocus</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetFocus"/>
<![CDATA[
>>--setFocus(--hwnd--)---------------------------><
]]>
</programlisting>
</section>
<section id="pbdSetFocusToWindow" xreflabel="setFocusToWindow"><title>setFocusToWindow</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetFocusToWindow"/>
<![CDATA[
>>--setFocusToWindow(--hwnd--)-------------------><
]]>
</programlisting>
</section>
<section id="pbdSetGroup" xreflabel="setGroup"><title>setGroup</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetGroup"/>
<![CDATA[
>>--setGroup(--id--+-----------+--)--------------><
+-wantStyle-+
]]>
</programlisting>
</section>
<section id="pbdSetListBoxData" xreflabel="setListBoxData"><title>setListBoxData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetListBoxData"/>
<![CDATA[
>>--setListBoxData(--id--,--data--)--------------><
]]>
</programlisting>
</section>
<section id="pbdSetListTabulators" xreflabel="setListTabulators"><title>setListTabulators</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetListTabulators"/>
<![CDATA[
+-,---+
V |
>>--setListTabulators(--id--,----tab-+--)--------><
]]>
</programlisting>
</section>
<section id="pbdSetRadioButtonData" xreflabel="setRadioButtonData"><title>setRadioButtonData</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetRadioButtonData"/>
<![CDATA[
>>--setRadioButtonData(--id--,--data--)----------><
]]>
</programlisting>
</section>
<section id="pbdSetTabStop" xreflabel="setTabStop"><title>setTabStop</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetTabStop"/>
<![CDATA[
>>--setTabStop(--id--,--+-----------+--)---------><
+-wantStyle-+
]]>
</programlisting>
</section>
<section id="pbdSetWindowText" xreflabel="setWindowText"><title>setWindowText</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthSetWindowText"/>
<![CDATA[
>>--setWindowText(--hwnd--,--text--)-------------><
]]>
</programlisting>
</section>
<section id="pbdShow" xreflabel="show"><title>show</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthShowClsPlainBaseDialog"/>
<![CDATA[
>>--show(--+--------+--)-------------------------><
+--opts--+
]]>
</programlisting>
</section>
<section id="pbdShowControl" xreflabel="showControl"><title>showControl</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthShowControl"/>
<![CDATA[
>>--showControl(--id--)--------------------------><
]]>
</programlisting>
</section>
<section id="pbdShowControlFast" xreflabel="showControlFast"><title>showControlFast</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthShowControlFast"/>
<![CDATA[
>>--showItemFast(--id--)-------------------------><
]]>
</programlisting>
</section>
<section id="pbdShowWindow" xreflabel="showWindow"><title>showWindow</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthShowWindow"/>
<![CDATA[
>>--showWindow(--hwnd--)-------------------------><
]]>
</programlisting>
</section>
<section id="pbdShowWindowFast" xreflabel="showWindowFast"><title>showWindowFast</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthShowWindowFast"/>
<![CDATA[
>>-showWindowFast(--hwnd--)----------------------><
]]>
</programlisting>
</section>
<section id="pbdTabToNext" xreflabel="tabToNext"><title>tabToNext</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthTabToNext"/>
<![CDATA[
>>--tabToNext------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdTabToPrevious" xreflabel="tabToPrevious"><title>tabToPrevious</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthTabToPrevious"/>
<![CDATA[
>>--tabToPrevious--------------------------------><
]]>
</programlisting>
</section>
<section id="pbdTiledBackgroundBitmap" xreflabel="tiledBackgroundBitmap"><title>tiledBackgroundBitmap</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthTiledBackgroundBitmap"/>
<![CDATA[
>>--tiledBackgroundBitmap(--bmpFilename--)-------><
]]>
</programlisting>
</section>
<section id="pbdToTheTop" xreflabel="toTheTop"><title>toTheTop</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthToTheTop"/>
<![CDATA[
>>--toTheTop-------------------------------------><
]]>
</programlisting>
</section>
<section id="pbdValidate" xreflabel="validate"><title>validate</title>
<programlisting>
PlainBaseDialog::<xref linkend="mthValidate"/>
<![CDATA[
>>--validate-------------------------------------><
]]>
</programlisting>
</section>
</section> <!-- End Section PlainBaseDialog Class -->
<section id="clsDialogControl" xreflabel="DialogControl"><title>DialogControl</title>
<indexterm><primary>DialogControl Class</primary></indexterm>
<para>
In a similar relationship as the <xref linkend="clsPlainBaseDialog"/> and dialog objects, the
<emphasis role="italic">DialogControl</emphasis> is the base class of all dialog control classes in the ooDialog
framework. It implements methods that are common to every dialog control. DialogControl is also an abstract class. A
programmer can not instantiate a new DialogControl object. Rather, one of the concrete dialog control classes such as,
the <xref linkend="clsDateTimePicker"/> or the <xref linkend="clsListView"/>, are used.
</para>
<para>
See <xref linkend="figComponentClassesDiagram"/> to visualize the mixin classes that the
DialogControl inherits. In essence the DialogControl is the dialog <xref linkend="chpDialogControlObject"/>
object. All the methods and attributes of the DialogControl are listed and documented in the dialog control
object chapter. This includes the methods and attributes of its inherited mixin classes.
</para>
<para>
The DialogControl inherits the following mixin classes:
<itemizedlist>
<listitem><para><xref linkend="clsWindowBase"/></para></listitem>
<listitem><para><xref linkend="clsWindowExtensions"/></para></listitem>
</itemizedlist>
</para>
<section id="sctMethodsDialogContorlObject"><title>Method Table</title>
<para>
The following table lists the attribute methods and instance methods of the
<computeroutput>DialogControl</computeroutput> class:
<table id="tblDialogControl" frame="all">
<title>DialogControl Method Reference</title>
<tgroup cols="2">
<colspec colwidth="3*" />
<colspec colwidth="8*" />
<thead>
<row>
<entry>DialogControl Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Attributes</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="atrHDlg"/></entry>
<entry>Reflects the window handle of the underlying Windows dialog that the dialog control belongs to.</entry>
</row>
<row>
<entry><xref linkend="atrID"/></entry>
<entry>Reflects the numeric resource ID for the dialog control.</entry>
</row>
<row>
<entry><xref linkend="atrODlg"/></entry>
<entry>Reflects the Rexx dialog object that the dialog control belongs to.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="dcoAssignFocus"/></entry>
<entry>Sets the input focus to this dialog control.</entry>
</row>
<row>
<entry><xref linkend="dcoClearRect"/></entry>
<entry>Clears the specified rectangular within the client area of this control.</entry>
</row>
<row>
<entry><xref linkend="dcoConnectCharEvent"/></entry>
<entry>Connects a character event notification sent to the control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="dcoConnectFKeyPress"/></entry>
<entry>Connects all F Key key press events to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="dcoConnectKeyPress"/></entry>
<entry>Connects a key press event notification with a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="dcoData"/></entry>
<entry>Reprieves the <emphasis role="italic">data</emphasis> (the value) of the underlying control's state.</entry>
</row>
<row>
<entry><xref linkend="dcoDataEquals"/></entry>
<entry>Sets the state of the underlying dialog control to the <emphasis role="italic">data</emphasis> (the value) specified.</entry>
</row>
<row>
<entry><xref linkend="dcoDisconnectKeyPress"/></entry>
<entry>Disconnects a method in the Rexx dialog from a previously connected key press event.</entry>
</row>
<row>
<entry><xref linkend="dcoGetTextSizeDlg"/></entry>
<entry>Calculates the size, (width and height,) in dialog units for a given string.</entry>
</row>
<row>
<entry><xref linkend="dcoGroup"/></entry>
<entry>Adds or removes the <xref linkend="wsgroup"/> style for the control.</entry>
</row>
<row>
<entry><xref linkend="dcoHasKeyPressConnection"/></entry>
<entry>Queries if a specific method, or any method, in the Rexx dialog has a connection to a key press event.</entry>
</row>
<row>
<entry><xref linkend="dcoRedrawRect"/></entry>
<entry>Immediately redraws the rectangle of the client area of the associated dialog.</entry>
</row>
<row>
<entry><xref linkend="dcoSetColor"/></entry>
<entry>Sets the background color, and optionally the text color, for this dialog control.</entry>
</row>
<row>
<entry><xref linkend="dcoSetSysColor"/></entry>
<entry>Sets the background color, and optionally the text color, for this dialog control using the system colors.</entry>
</row>
<row>
<entry><xref linkend="dcoTabStop"/></entry>
<entry>Add or remove the tab stop style for the control.</entry>
</row>
<row>
<entry><xref linkend="mthTextSize"/></entry>
<entry>Computes the width and height in pixels of the specified string of text when displayed by this control.</entry>
</row>
<row>
<entry><xref linkend="mthUseUnicode"/></entry>
<entry>Sets the format flag telling the control to use, or not use, Unicode.</entry>
</row>
<row>
<entry><xref linkend="mthUsingUnicode"/></entry>
<entry>Determines if the control is using Unicode or not.</entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="dcoAssignFocus" xreflabel="assignFocus"><title>assignFocus</title>
<programlisting>
DialogControl::<xref linkend="mthAssignFocus"/>
<![CDATA[
>>--assignFocus----------------------------------><
]]>
</programlisting>
</section>
<section id="dcoClearRect" xreflabel="clearRect"><title>clearRect</title>
<programlisting>
DialogControl::<xref linkend="mthClearRectClsDialogControl"/>
<![CDATA[
Form 1:
>>--clearRect(--rectangle--)---------------------><
Form 2:
>>--clearRect(--pt1--,--pt2--)-------------------><
Form 3:
>>--clearRect(--x-,--y-,--cx-,--cy--)------------><
Generic form:
>>--clearRect(--rectCoordinates--)---------------><
]]>
</programlisting>
</section>
<section id="dcoConnectCharEvent" xreflabel="connectCharEvent"><title>connectCharEvent</title>
<programlisting>
DialogControl::<xref linkend="mthConnectCharEvent"/>
<![CDATA[
>>--connectCharEvent(--+--------------+--)-------><
+--methodName--+
]]>
</programlisting>
</section>
<section id="dcoConnectFKeyPress" xreflabel="connectFKeyPress"><title>connectFKeyPress</title>
<programlisting>
DialogControl::<xref linkend="mthConnectFKeyPressDialogControlObject"/>
<![CDATA[
>>--connectFKeyPress(--methodName--)-------------><
]]>
</programlisting>
</section>
<section id="dcoConnectKeyPress" xreflabel="connectKeyPress"><title>connectKeyPress</title>
<programlisting>
DialogControl::<xref linkend="mthConnectKeyPressDialogControlObject"/>
<![CDATA[
>>--connectKeyPress(--methodName--,--keys--+-----------+--)-----><
+-,-filter--+
]]>
</programlisting>
</section>
<section id="dcoData" xreflabel="data"><title>data</title>
<programlisting>
DialogControl::<xref linkend="mthData"/>
<![CDATA[
>>--data-----------------------------------------><
]]>
</programlisting>
</section>
<section id="dcoDataEquals"><title>data=</title>
<programlisting>
DialogControl::<xref linkend="mthDataEquals"/>
<![CDATA[
>>--data = newData-------------------------------><
]]>
</programlisting>
</section>
<section id="dcoDisconnectKeyPress" xreflabel="disconnectKeyPress"><title>disconnectKeyPress</title>
<programlisting>
DialogControl::<xref linkend="mthDisconnectKeyPressDialogControlObject"/>
<![CDATA[
>>--disconnectKeyPress(--+--------------+--)-----><
+--methodName--+
]]>
</programlisting>
</section>
<section id="dcoGetTextSizeDlg" xreflabel="getTextSizeDlg"><title>getTextSizeDlg</title>
<programlisting>
DialogControl::<xref linkend="mthGetTextSizeDlgClsDialogControl"/>
<![CDATA[
>>--getTextSizeDlg(--text--+-------------+--+-------------+--+---------+--)----><
+-,-fontname--+ +-,-fontSize--+ +-,-hwnd--+
]]>
</programlisting>
</section>
<section id="dcoGroup" xreflabel="group"><title>group</title>
<programlisting>
DialogControl::<xref linkend="mthGroup"/>
<![CDATA[
>>--group(--+-----------+--)---------------------><
+-wantStyle-+
]]>
</programlisting>
</section>
<section id="dcoHasKeyPressConnection" xreflabel="hasKeyPressConnection"><title>hasKeyPressConnection</title>
<programlisting>
DialogControl::<xref linkend="mthHasKeyPressConnectionDialogControlObject"/>
<![CDATA[
>>--hasKeyPressConnection(--+--------------+--)--><
+--methodName--+
]]>
</programlisting>
</section>
<section id="dcoRedrawRect" xreflabel="redrawRect"><title>redrawRect</title>
<programlisting>
DialogControl::<xref linkend="mthRedrawRectClsDialogControl"/>
<![CDATA[
Form 1:
>>--redrawRect(--rectangle--+---------+--)-------><
+-,-erase-+
Form 2:
>>--redrawRect(--pt1--,--pt2--+---------+--)-----><
+-,-erase-+
Form 3:
>>--redrawRect(--x-,--y-,--x1-,--y1--+---------+--)-------------><
+-,-erase-+
Generic form:
>>--redrawRect(--rectCoordinates--+---------+--)-><
+-,-erase-+
]]>
</programlisting>
</section>
<section id="dcoSetColor" xreflabel="setColor"><title>setColor</title>
<programlisting>
DialogControl::<xref linkend="mthSetColor"/>
<![CDATA[
>>--setColor(--bk--+-------+--)------------------><
+-,-fg--+
]]>
</programlisting>
</section>
<section id="dcoSetSysColor" xreflabel="setSysColor"><title>setSysColor</title>
<programlisting>
DialogControl::<xref linkend="mthSetSysColor"/>
<![CDATA[
>>--setSysColor(--bk--+-------+--)---------------><
+-,-fg--+
]]>
</programlisting>
</section>
<section id="dcoTabStop" xreflabel="tabStop"><title>tabStop</title>
<programlisting>
DialogControl::<xref linkend="mthTabStop"/>
<![CDATA[
>>--tabStop(--+-----------+--)-------------------><
+-wantStyle-+
]]>
</programlisting>
</section>
<section id="dcoTextSize" xreflabel="textSize"><title>textSize</title>
<programlisting>
DialogControl::<xref linkend="mthTextSize"/>
<![CDATA[
>>--textSize(--text--,--size--)------------------><
]]>
</programlisting>
</section>
<section id="dcoUseUnicode" xreflabel="useUnicode"><title>useUnicode</title>
<programlisting>
DialogControl::<xref linkend="mthUseUnicode"/>
<![CDATA[
>>--useUnicode(--use--)--------------------------><
]]>
</programlisting>
</section>
<section id="dcoUsingUnicode" xreflabel="usingUnicode"><title>usingUnicode</title>
<programlisting>
DialogControl::<xref linkend="mthUsingUnicode"/>
<![CDATA[
>>--usingUnicode---------------------------------><
]]>
</programlisting>
</section>
</section>
<!-- <section id="clsWindowBase"><title>WindowBase Mixin Class</title> START -->
<xi:include href="windowBase.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- <section id="clsWindowBase"><title>WindowBase Mixin Class</title> END -->
<!-- <section id="clsWindowExtensions"><title>WindowExtensions Mixin Class</title> START -->
<xi:include href="windowExtensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- <section id="clsWindowExtensions"><title>WindowExtensions Mixin Class</title> END -->
<!-- <section id="clsDialogExtensions"><title>DialogExtensions Mixin Class</title> START -->
<xi:include href="dialogExtensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- <section id="clsDialogExtensions"><title>DialogExtensions Mixin Class</title> END -->
<!-- <section id="clsEventNotification"><title>EventNotification Mixin Class</title> START -->
<xi:include href="eventNotification.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- <section id="clsEventNotification"><title>EventNotification Mixin Class</title> END -->
<section id="clsResourceUtils" xreflabel="ResourceUtils"><title>ResourceUtils Mixin Class</title>
<indexterm><primary>ResourceUtils Class</primary></indexterm>
<para>
The <computeroutput>ResourceUtils</computeroutput> class provides utility methods for dealing with <xref
linkend="defResourceId"/>s and parsing resource <xref linkend="defResourceScript"/> files. The
class is inherited by the <xref linkend="chpDialogObject"/> object and the <xref linkend="clsApplicationManager" />
class. Most of the methods of the <computeroutput>ResourceUtils</computeroutput> class are used <link
linkend="ovvUndocumented">internally</link> and not documented.
</para>
<section id="sctMethodsResourceUtils"><title>Method Table</title>
<para>
The following table list the methods of the <computeroutput>ResourceUtils</computeroutput> class for use by the
programer:
</para>
<table id="tblResourceUtilsMethods" frame="all">
<title>ResourceUtils Methods</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">Attributes</emphasis></entry>
<entry align="center"><emphasis role="bold">Attributes</emphasis></entry>
</row>
<row>
<entry><xref linkend="atrConstDir"/></entry>
<entry>A directory object that maps symbolic resource IDS to their numeric IDs.</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="mthParseIncludeFile"/></entry>
<entry>Reads a file and adds any symbol definitions found to the proper constant directory.</entry>
</row>
<row>
<entry><xref linkend="mthResolveNumericID"/></entry>
<entry>Uses the constant directory to resolve a numeric ID to its symbolic ID.</entry>
</row>
<row>
<entry><xref linkend="mthResolveSymbolicID"/></entry>
<entry>Uses the constant directory to resolve a symbolic ID to its numeric value.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="atrConstDir" xreflabel="constDir"><title>constDir (Attribute)</title>
<indexterm><primary>constDir</primary></indexterm>
<indexterm><primary>ResourceUtils class</primary><secondary>constDir</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>constDir</secondary></indexterm>
<programlisting>
<![CDATA[
>>--constDir-------------------------------------><
>>--constDir[symbol] = numericValue--------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">constDir</emphasis> attribute is assigned a <computeroutput>Directory</computeroutput>
object whose indexes are <xref linkend="defSymbolicId"/> resource IDs. It is part of the<xref
linkend="ovvSymbolicIDMechanism"/> provided by the ooDialog framework to allow the use of symbolic IDs in ooDialog
programs. Although the use of the <emphasis role="italic">constDir</emphasis> is mostly transparent to the
programmer, it is important to understand how the mechanism works when using symbolic IDs in ooDialog programs
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">constDir get:</emphasis></term>
<listitem>
<para>
Getting the <computeroutput>constDir</computeroutput> is public. In practical use, it is more common to get the
value of an index of the <emphasis role="italic">constDir</emphasis>:
<programlisting>
<![CDATA[
id = self~constDir[IDC_RB_MINIMUM]
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">constDir set:</emphasis></term>
<listitem>
<para>
Setting the <emphasis role="italic">constDir</emphasis> attribute is private and should not be done by the
programmer. The ooDialog framework internally manages the attribute, setting it to a
<computeroutput>Directory</computeroutput> object at the proper point in program execution.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Both <xref linkend="chpDialogObject"/> objects and the <xref linkend="clsApplicationManager" /> class inherit the
<xref linkend="clsResourceUtils" /> mixin class. <emphasis role="bold">Note</emphasis> that the <emphasis
role="italic">constDir</emphasis> attribute of the <xref linkend="dotApplication"/> <emphasis
role="bold">is</emphasis> the global <xref linkend="dotConstDir"/>.
</para>
<para>
Each index in the the <computeroutput>Directory</computeroutput> object assigned to the <emphasis
role="italic">constDir</emphasis> attribute is the symbolic name of a resource ID. The item at that index is the
numeric value of the <xref linkend="defResourceId"/>. Once a symbolic ID is added to the <emphasis
role="italic">constDir</emphasis> directory as an index, that symbolic ID can be used in place of the numeric
resource ID as the resource ID argument in methods that use a resource ID.
</para>
<para>
This is dependent, however, on the global <computeroutput>.constDir</computeroutput> usage <xref
linkend="entConstDirStrategy"/> the programmer has chosen. If the programmer has elected to not use
the global <computeroutput>.constDir</computeroutput> at all, then symbolic IDs can only be used in the methods of
the dialog or dialog control classes. If the programmer has elected to use the
<computeroutput>.constdir</computeroutput> then symbolic IDs can be used in any class the ooDialog framework
provides.
</para>
<para>
How to add symbolic IDs is explained in the overview chapter, in the discussion of the <link
linkend="ovvSymbolicIDMechanism">mechanism</link> used by ooDialog to support symbolic IDs.
</para>
<para>
The global <xref linkend="dotConstDir"/> was introduced in ooDialog 4.2.0 to overcome limitations inherent in
using the <emphasis role="italic">constDir</emphasis> attribute of the dialog object. The global
<computeroutput>.constDir</computeroutput> is more efficient and capable than the <emphasis
role="italic">constDir</emphasis> attribute. The programmer should be sure to review
the <link linkend="ovvSymbolicIDMechanism">discussion</link> in the overview to determine how to take the best
advantage of the mechanism ooDialog is providing for the use of symbolic IDs.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">constDir</emphasis> attribute is inherited from the <xref linkend="clsResourceUtils"/>
class.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ResourceUtils::constDir() [attribute] -->
<section id="mthParseIncludeFile" xreflabel="parseIncludeFile"><title>parseIncludeFile</title>
<indexterm><primary>parseIncludeFile</primary></indexterm>
<indexterm><primary>ApplicationManager class</primary><secondary>parseIncludeFile</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>parseIncludeFile</secondary></indexterm>
<indexterm><primary>ResourceUtils class</primary><secondary>parseIncludeFile</secondary></indexterm>
<programlisting>
<![CDATA[
>>--parseIncludeFile(--fileName--)---------------><
]]>
</programlisting>
<para>
Reads a file and adds any symbol <xref linkend="defPoundDefine"/>s found to the <xref linkend="atrConstDir"/>
attribute of this <computeroutput>ResourceUtils</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>fileName [required]</term>
<listitem>
<para>
The name of the file to read and parse.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true if no errors were detected, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The ooDialog framework provides a <xref linkend="ovvSymbolicIDMechanism"/> allowing programmers to
use <xref linkend="defSymbolicId"/> IDs in their program. The <emphasis
role="italic">parseIncludeFile</emphasis> method adds symbols to a constant directory, which is part of that
mechanism. Which constant directory the symbol is added to is determined by the global
<computeroutput>.constDir</computeroutput> usage <xref linkend="entConstDirStrategy"/> the programmer
has chosen.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
In this example the programmer has several different files with symbol definitions in them. When the first dialog
object is instantiated, one of the symbol files is passed to the <emphasis role="italic">new</emphasis> method and
is parsed automatically by the ooDialog framework. The other symbol files are then read and added to the constant
directory:
<programlisting>
<![CDATA[
dlg = .CueDialog~new("cueEdit.rc", IDD_CUE_DLG, , 'cueEdit.h')
dlg~parseIncludeFile('productionDialogs.h')
dlg~parseIncludeFile('debugDialogs.h')
dlg~parseIncludeFile('databaseDialogs.h')
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ResourceUtils::parseIncludeFile() -->
<section id="mthResolveNumericID" xreflabel="resolveNumericID"><title>resolveNumericID</title>
<indexterm><primary>resolveNumericID</primary></indexterm>
<indexterm><primary>ApplicationManager class</primary><secondary>parseIncludeFile</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>parseIncludeFile</secondary></indexterm>
<indexterm><primary>ResourceUtils class</primary><secondary>resolveNumericID</secondary></indexterm>
<programlisting>
<![CDATA[
>>--resolveNumericID(--id--)---------------------><
]]>
</programlisting>
<para>
Attempts to resolve a number with an index in the <xref linkend="atrConstDir"/> attribute of this
<computeroutput>ResourceUtils</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The number to resolve. If id is not a number this method fails immediately.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the index, the symbolic <xref linkend="defSymbolicId"/> ID, for the number, if the number can be matched to
an item in the constant directory. -1 is returned on failure.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The ooDialog framework provides a <xref linkend="ovvSymbolicIDMechanism"/> allowing programmers to
use <xref linkend="defSymbolicId"/> IDs in their program. This method is intended to look up a
numeric resource ID and return its symbolic ID. The lookup is done in the
<computeroutput>.Directory</computeroutput> object assigned to the <xref linkend="atrConstDir"/> attribute of this
resource utils object. If an item in the <computeroutput>constDir</computeroutput> matches the numeric <emphasis
role="italic">id</emphasis> then that item's index is returned.
</para>
<para>
The assumption in the description of this method, is that the programmer has only put items in the constant
directory that are numeric IDs and whose indexes are symbol IDs. However, the lookup and return work the same no
matter what is in the constant directory.
</para>
<para>
Although the operating system allows duplicate numeric resource IDs, as long as the IDs are for different types of
resources, programmers must use unique ID numbers if they intend to use this method. If the constant directory
contains duplicate numeric items, the return is non-deterministic.
</para>
<para>
Exactly which constant directory the lookup is done in is determined by the global
<computeroutput>.constDir</computeroutput> usage <xref linkend="entConstDirStrategy"/> the programmer
has chosen.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ResourceUtils::resolveNumericID() -->
<section id="mthResolveSymbolicID" xreflabel="resolveSymbolicID"><title>resolveSymbolicID</title>
<indexterm><primary>resolveSymbolicID</primary></indexterm>
<indexterm><primary>ApplicationManager class</primary><secondary>parseIncludeFile</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>parseIncludeFile</secondary></indexterm>
<indexterm><primary>ResourceUtils class</primary><secondary>resolveSymbolicID</secondary></indexterm>
<programlisting>
<![CDATA[
>>--resolveSymbolicID(--id--)--------------------><
]]>
</programlisting>
<para>
Resolves <emphasis role="italic">id</emphasis> to its numeric value using the <xref linkend="atrConstDir"/>
attribute of this <computeroutput>ResourceUtils</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The id to resolve.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The numeric resource ID on success, -1 on failure.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The ooDialog framework provides a <xref linkend="ovvSymbolicIDMechanism"/> allowing programmers to
use <xref linkend="defSymbolicId"/> IDs in their program. The <emphasis
role="italic">resolveSymbolicID</emphasis> is the foundation of this mechanism. The framework relies on it heavily,
however it is not expected that the programmer would have much need for the method.
</para>
<para>
The method first checks if <emphasis role="italic">id</emphasis> is a whole number greater than 0. If so the number
is simply returned. If <emphasis role="italic">id</emphasis> is a whole number, but less than 1, then the method
fails. If <emphasis role="italic">id</emphasis> is not whole number, then the constant directory of this resource
utils object is checked to see if <emphasis role="italic">id</emphasis> is one of its indexes. If it is not the
method fails. If it is an index, then the index's item is checked to see if it is a whole number greater than 0. If
not the method fails. If the item is a whole number greater than 0, then the item is returned.
</para>
<para>
Exactly which constant directory is checked is determined by the global <computeroutput>.constDir</computeroutput>
usage <xref linkend="entConstDirStrategy"/> the programmer has chosen.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ResourceUtils::resolveSymbolicID() -->
</section> <!-- End Section ResourceUtils Mixin Class -->
<section id="clsDynamicDialog" xreflabel="DynamIcDialog"><title>DynamicDialog Mixin Class</title>
<indexterm><primary>DynamicDialog Class</primary></indexterm>
<para>
The ooDialog framework allows the Rexx programmer to dynamically define a dialog <xref linkend="ovvDialogTemplate" />
in her code. This functionality is implemented by the <computeroutput>DynamicDialog</computeroutput> class. This class
is inherited by the <xref linkend="clsUserDialog" />and its methods are fully documented there.
</para>
<para>
Historically the ooDialog documentation did not distinguish the difference between the
<computeroutput>UserDialog</computeroutput> methods and the <computeroutput>DynamicDialog</computeroutput> methods.
The documentation merely treated the <computeroutput>DynamicDialog</computeroutput> methods as methods of the
<computeroutput>UserDialog</computeroutput>. The <computeroutput>DynamicDialog</computeroutput> methods are listed
here as a reference with a link to the full documentation in the <computeroutput>UserDialog</computeroutput> chapter.
</para>
<section id="sctMethodsDynamicDialog"><title>Method Table</title>
<para>
The following table lists the methods of the <computeroutput>DynamicDialog</computeroutput> class. The links in the
table lead to the full documentation for each method, which is in the <emphasis role="italic">UserDialog
Class</emphasis> chapter.
<table id="tDynamicDialogClass" frame="all">
<title>DynamicDialog Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="3*" />
<thead>
<row>
<entry>Dialog Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<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="mthAddIconResource"/></entry>
<entry>Adds the file name for an icon resource to the dialog's icon table.</entry>
</row>
<row>
<entry><xref linkend="mthCreate"/></entry>
<entry>Begins the creation of the in-memory Windows dialog template by specifying the general details for the dialog itself.</entry>
</row>
<row>
<entry><xref linkend="mthCreateBitmapButton"/></entry>
<entry>Creates a bitmap push button in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateBlackFrame"/></entry>
<entry>Creates a static black frame control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateBlackRect"/></entry>
<entry>Creates a static black rectangle control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateCenter"/></entry>
<entry>Begins the creation of an in-memory dialog template for a dialog that will be centered in the user's screen.</entry>
</row>
<row>
<entry><xref linkend="mthCreateCheckBox"/></entry>
<entry>Creates a check box control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateCheckBoxGroup"/></entry>
<entry>Creates a group of check box controls in the dialog template using a single string to specify the check box labels.</entry>
</row>
<row>
<entry><xref linkend="mthCreateCheckBoxStem"/></entry>
<entry>Creates a group of check box controls in the dialog template using a stem to specify the check box labels.</entry>
</row>
<row>
<entry><xref linkend="mthCreateComboBox"/></entry>
<entry>Creates a combobox control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateComboBoxInput"/></entry>
<entry>Creates a combobox with a static text control (for the label) in the dialog template. </entry>
</row>
<row>
<entry><xref linkend="mthCreateDateTimePicker"/></entry>
<entry>Creates a date time picker control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateEdit"/></entry>
<entry>Creates an edit control in the dialog template</entry>
</row>
<row>
<entry><xref linkend="mthCreateEditInput"/></entry>
<entry>Creates an edit control and a static text control (for the label) in the dialog template, in one step.</entry>
</row>
<row>
<entry><xref linkend="mthCreateEditInputGroup"/></entry>
<entry>Creates one or more edit controls with labels in the dialog template using a single string to specify the labels.</entry>
</row>
<row>
<entry><xref linkend="mthCreateEditInputStem"/></entry>
<entry>Creates one or more edit controls with labels in the dialog template using a stem to specify the labels.</entry>
</row>
<row>
<entry><xref linkend="mthCreateEtchedFrame"/></entry>
<entry>Creates a static etched frame control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateEtchedHorizontal"/></entry>
<entry>Creates a static control in the dialog template that is an etched horizontal line.</entry>
</row>
<row>
<entry><xref linkend="mthCreateEtchedVertical"/></entry>
<entry>Creates a static frame control in the dialog template that is a single etched vertical line.</entry>
</row>
<row>
<entry><xref linkend="mthCreateGrayFrame"/></entry>
<entry>Creates a static gray frame control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateGrayRect"/></entry>
<entry>Creates a static gray rectangle control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateGroupBox"/></entry>
<entry>Creates a group box in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateListBox"/></entry>
<entry>Creates a list box control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateListView"/></entry>
<entry>Creates a list-view control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateMonthCalendar"/></entry>
<entry>Creates a month calendar control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateOkCancelRightBottom"/></entry>
<entry>Creates an Ok and Cancel push buttons in the right bottom corner of the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateOkCancelRightTop"/></entry>
<entry>Creates an Ok and Cancel push buttons in the right top corner of the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateOkCancelLeftBottom"/></entry>
<entry>Creates an Ok and Cancel push buttons in the left bottom corner of the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateOkCancelLeftTop"/></entry>
<entry>Creates an Ok and Cancel push buttons in the left top corner of the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreatePasswordEdit"/></entry>
<entry>Creates an edit control with the PASSWORD style set in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateProgressBar"/></entry>
<entry>Creates a progress bar control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreatePushButton"/></entry>
<entry>Creates a push button in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreatePushButtonGroup"/></entry>
<entry>Creates any number of push buttons in the dialog template at one time.</entry>
</row>
<row>
<entry><xref linkend="mthCreateRadioButton"/></entry>
<entry>Creates a radio button control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateRadioButtonGroup"/></entry>
<entry>Creates a group of radio buttons with labels in the dialog template using a single string to specify the labels.</entry>
</row>
<row>
<entry><xref linkend="mthCreateRadioButtonStem"/></entry>
<entry>Creates a group of radio buttons with labels in the dialog template using a stem to specify the labels.</entry>
</row>
<row>
<entry><xref linkend="mthCreateScrollBar"/></entry>
<entry>Creates a scroll bar control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateStatic"/></entry>
<entry>Creates a static control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateStaticFrame"/></entry>
<entry>Creates one of the static frame controls in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateStaticImage"/></entry>
<entry>Creates a static image control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateStaticText"/></entry>
<entry>Creates a static text control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateTab"/></entry>
<entry>Creates a tab control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateTrackBar"/></entry>
<entry>Creates a trackbar control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateTreeView"/></entry>
<entry>Creates a tree view control in the dialog template</entry>
</row>
<row>
<entry><xref linkend="mthCreateUpDown"/></entry>
<entry>Creates an up-down control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateWhiteFrame"/></entry>
<entry>Creates a white static frame control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthCreateWhiteRect"/></entry>
<entry>Creates a white static rectangle control in the dialog template.</entry>
</row>
<row>
<entry><xref linkend="mthDefineDialog"/></entry>
<entry>
The programmer uses this method to dynamically create the dialog controls in the dialog template by using the appropriate
create ... methods.
</entry>
</row>
<row>
<entry><xref linkend="mthLoad"/></entry>
<entry>Creates the in-memory dialog template by reading the dialog template from a resource script file.</entry>
</row>
<row>
<entry><xref linkend="mthLoadFrame"/></entry>
<entry>Starts the in-memory Windows dialog template by reading a dialog template from a resource script file.</entry>
</row>
<row>
<entry><xref linkend="mthLoadItems"/></entry>
<entry>
Creates the dialog controls in the dialog template, and finishes the dialog template, by reading a dialog template
from a resource script file.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</section>
<section id="ddAddIconResource"><title>addIconResource</title>
<programlisting>
DynamicDialog::<xref linkend="mthAddIconResource"/>
<![CDATA[
>>--addIconResource(--id--,--fileName--)---------><
]]>
</programlisting>
</section>
<section id="ddCreate"><title>create</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreate"/>
<![CDATA[
>>--create(--x--,--y--,--cx--,--cy--,--title-+-----------+--+------------+----->
+-,-options-+ +-,-dlgClass-+
>----+------------+--+------------+--+------------+--)-------------------------><
+-,-fontName-+ +-,-fontSize-+ +-,-expected-+
]]>
</programlisting>
</section>
<section id="ddCreateBitmapButton"><title>createBitmapButton</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateBitmapButton"/>
<![CDATA[
>>--createBitmapButton(-id-,-x-,-y-+------+-+------+-+----------+-+--------+--->
+-,-cx-+ +-,-cy-+ +-,-style--+ +-,-text-+
>--+------------+-,-normal-+------------+--+-------------+--+-------------+--)--><
+-,-methName-+ +-,-focused--+ +-,-selected--+ +-,-disabled--+
]]>
</programlisting>
</section>
<section id="ddCreateBlackFrame"><title>createBlackFrame</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateBlackFrame"/>
<![CDATA[
>>--createBlackFrame(--+------+--x-,-y-,-cx-,-cy--+-----------+-)--------------><
+--id--+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateBlackRect"><title>createBlackRect</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateBlackRect"/>
<![CDATA[
>>--createBlackRect(--+------+--x-,-y-,-cx-,-cy--+-----------+-)---------------><
+--id--+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateCenter"><title>createCenter</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateCenter"/>
<![CDATA[
>>--createCenter(--cx--,--cy--,--title-+-----------+--+------------+----------->
+-,-options-+ +-,-dlgClass-+
>----+------------+--+------------+--+------------+--)-------------------------><
+-,-fontName-+ +-,-fontSize-+ +-,-expected-+
]]>
</programlisting>
</section>
<section id="ddCreateCheckBox"><title>createCheckBox</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateCheckBox"/>
<![CDATA[
>>--createCheckBox(-id-,--x-,--y--+------+--+------+--+---------+--+---------+->
+-,-cx-+ +-,-cy-+ +-,-style-+ +-,-label-+
>----+-----------------+--+--------------+--)----><
+-,-attributeName-+ +-,-connectOpt-+
]]>
</programlisting>
</section>
<section id="ddCreateCheckBoxGroup"><title>createCheckBoxGroup</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateCheckBoxGroup"/>
<![CDATA[
+-----+
V |
>>--createCheckBoxGroup(id,-x-,-y-+------+-,---txt-+--+---------+-+----------+-)--><
+-,-cx-+ +-,-style-+ +-,-idStat-+
]]>
</programlisting>
</section>
<section id="ddCreateCheckBoxStem"><title>createCheckBoxStem</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateCheckBoxStem"/>
<![CDATA[
>>--createCheckBoxStem(id,-x-,-y-+------+-,-txt.-+-------+-+---------+-+----------+-)-><
+-,-cx-+ +-,-max-+ +-,-style-+ +-,-idStat-+
]]>
</programlisting>
</section>
<section id="ddCreateComboBox"><title>createComboBox</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateComboBox"/>
<![CDATA[
>>--createComboBox(--id--,--x--,--y--,--cx--,--cy--+---------+--+------------+--)-><
+-,-style-+ +-,-attrName-+
]]>
</programlisting>
</section>
<section id="ddCreateComboBoxInput"><title>createComboBoxInput</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateComboBoxInput"/>
<![CDATA[
>>--createComboBoxInput(-id-,-x-,-y-+-------+-,-cx2-+---------+-,--text------->
+-,-cx1-+ +-,-count-+
>---+---------+---+----------+--+-----------+--)-------------------------------><
+-,-style-+ +-,-idStat-+ +-,-attName-+
]]>
</programlisting>
</section>
<section id="ddCreateDateTimePicker"><title>createDateTimePicker</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateDateTimePicker"/>
<![CDATA[
>>--createDateTimePicker(-id--x-,--y-,--cx-,--cy-+---------+--+------------+--)-><
+-,-style-+ +-,-attrName-+
]]>
</programlisting>
</section>
<section id="ddCreateEdit"><title>createEdit</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateEdit"/>
<![CDATA[
>>--createEdit(-id-,-x-,-y-,-cx--+------+--+---------+--+------------+--)------><
+-,-cy-+ +-,-style-+ +-,-attrName-+
]]>
</programlisting>
</section>
<section id="ddCreateEditInput"><title>createEditInput</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateEditInput"/>
<![CDATA[
>>--createEditInput(-id-,-x-,-y-+-------+-,-cx2-,-+------+-,-text-+----------+->
+-,-cx1-+ +-,-cy-+ +-,-style-+
>--+------------+-+--------+-)-------------------------------------------------><
+-,-idStatic-+ +-,-attr-+
]]>
</programlisting>
</section>
<section id="ddCreateEditInputGroup"><title>createEditInputGroup</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateEditInputGroup"/>
<![CDATA[
+---+
V |
>>--createEditInputGroup(-id-,-x-,-y-+-------+-,-cx2-,--txt-+-+------+-+-------+-)-><
+-,-cx1-+ +-,-s-+ +-,-id2-+
]]>
</programlisting>
</section>
<section id="ddCreateEditInputStem"><title>createEditInputStem</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateEditInputStem"/>
<![CDATA[
>>--createEditInputStem(-id-,-x-,-y-+-------+-,-cx2-,-text.-------------------->
+-,-cx1-+
>--+---------+-+----------+-)--------------------------------------------------><
+-,-style-+ +-,-idStat-+
]]>
</programlisting>
</section>
<section id="ddCreateEtchedFrame"><title>createEtchedFrame</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateEtchedFrame"/>
<![CDATA[
>>--createEtchedFrame(--+-------+--x-,-y-,-cx-,-cy--+-----------+-)------------><
+--id-,-+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateEtchedHorizontal"><title>createEtchedHorizontal</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateEtchedHorizontal"/>
<![CDATA[
>>--createEtchedHorizontal(--+-------+--x-,-y-,-cx-,-cy--+-----------+-)-------><
+--id-,-+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateEtchedVertical"><title>createEtchedVertical</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateEtchedVertical"/>
<![CDATA[
>>--createEtchedVertical(--+-------+--x-,-y-,-cx-,-cy--+-----------+-)---------><
+--id-,-+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateGrayFrame"><title>createGrayFrame</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateGrayFrame"/>
<![CDATA[
>>--createGrayFrame(--+------+--x-,-y-,-cx-,-cy--+-----------+-)---------------><
+--id--+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateGrayRect"><title>createGrayRect</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateGrayRect"/>
<![CDATA[
>>--createGrayRect(--+------+--x-,-y-,-cx-,-cy--+-----------+-)----------------><
+--id--+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateGroupbox"><title>createGroupbox</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateGroupBox"/>
<![CDATA[
>>--createGroupbox(-+------+-,-x-,-y-,-cx-,-cy--+---------+-+--------+-)-------><
+--id--+ +-,-style-+ +-,-text-+
]]>
</programlisting>
</section>
<section id="ddCreateListBox"><title>createListBox</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateListBox"/>
<![CDATA[
>>--createListBox(--id-,-x-,-y-,-cx-,-cy--+---------+-+------------+-)---------><
+-,-style-+ +-,-attrName-+
]]>
</programlisting>
</section>
<section id="ddCreateListView"><title>createListView</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateListView"/>
<![CDATA[
>>--createListView(-id-,--x-,--y-,--cx-,--cy-+---------+--+------------+--)----><
+-,-style-+ +-,-attrName-+
]]>
</programlisting>
</section>
<section id="ddCreateMonthCalendar"><title>createMonthCalendar</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateMonthCalendar"/>
<![CDATA[
>>--createMonthCalendar(-id--x-,--y-,--cx-,--cy-+---------+--+------------+--)-><
+-,-style-+ +-,-attrName-+
]]>
</programlisting>
</section>
<section id="ddCreateOkCancelLeftBottom"><title>createOkCancelLeftBottom</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateOkCancelLeftBottom"/>
<![CDATA[
>>--createOkCancelLeftBottom---------------------><
]]>
</programlisting>
</section>
<section id="ddCreateOkCancelLeftTop"><title>createOkCancelLeftTop</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateOkCancelLeftTop"/>
<![CDATA[
>>--createOkCancelLeftTop------------------------><
]]>
</programlisting>
</section>
<section id="ddCreateOkCancelRightBottom"><title>createOkCancelRightBottom</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateOkCancelRightBottom"/>
<![CDATA[
>>--createOkCancelRightBottom--------------------><
]]>
</programlisting>
</section>
<section id="ddCreateOkCancelRightTop"><title>createOkCancelRightTop</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateOkCancelRightTop"/>
<![CDATA[
>>--createOkCancelRightTop-----------------------><
]]>
</programlisting>
</section>
<section id="ddCreatePasswordEdit"><title>createPasswordEdit</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreatePasswordEdit"/>
<![CDATA[
>>--createPasswordEdit(-id-,-x-,-y-,-cx--+------+--+---------+-+--------+--)---><
+-,-cy-+ +-,-style-+ +-,-attr-+
]]>
</programlisting>
</section>
<section id="ddCreateProgressBar"><title>createProgressBar</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateProgressBar"/>
<![CDATA[
>>--createProgressBar(--id--,--x--,--y--,--cx--,--cy-+-----------+--)----------><
+--,-style--+
]]>
</programlisting>
</section>
<section id="ddCreatePushButton"><title>createPushButton</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreatePushButton"/>
<![CDATA[
>>--createPushButton(-id-,-x-,-y-,-cx-,-cy-,-+---------+-+-------+-+-------+-)-><
+-,-style-+ +-,-txt-+ +-,-mth-+
]]>
</programlisting>
</section>
<section id="ddcreatePushButtonGroup"><title>createPushButtonGroup</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreatePushButtonGroup"/>
<![CDATA[
+----------------+
V |
>>--createPushButtonGroup(-x-,-y-+------+-+------+-,-txt- -id- -m-+--+-----+-+-----+-)-><
+-,-cx-+ +-,-cy-+ +-,-r-+ +-,-o-+
]]>
</programlisting>
</section>
<section id="ddCreateRadioButton"><title>createRadioButton</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateRadioButton"/>
<![CDATA[
>>--createRadioButton(-id-,-x-,-y-+------+--+------+--+---------+-------------->
+-,-cx-+ +-,-cy-+ +-,-style-+
>--+--------+--+--------+--)---------------------------------------------------><
+-,-text-+ +-,-attr-+
]]>
</programlisting>
</section>
<section id="ddCreateRadioButtonGroup"><title>createRadioButtonGroup</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateRadioButtonGroup"/>
<![CDATA[
+-----+
V |
>>--createRadioButtonGroup(id1,-x-,-y-+------+-,---txt-+--+---------+-+----------+-)--><
+-,-cx-+ +-,-style-+ +-,-idSt-+
]]>
</programlisting>
</section>
<section id="ddCreateRadioButtonStem"><title>createRadioButtonStem</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateRadioButtonStem"/>
<![CDATA[
>>--createRadioButtonStem(-id-,-x-,-y--+------+-,-text.--+-------+------------->
+-,-cx-+ +-,-max-+
>--+---------+--+----------+-)-------------------------------------------------><
+-,-style-+ +-,-idStat-+
]]>
</programlisting>
</section>
<section id="ddCreateScrollBar"><title>createScrollBar</title>
<programlisting>
DynamicDialog::create <xref linkend="mthCreateScrollBar"/>
<![CDATA[
>>--createScrollBar(--id--,--x--,--y--,--cx--,--cy--+----------+--)------------><
+-,-style--+
]]>
</programlisting>
</section>
<section id="ddCreateStatic"><title>createStatic</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateStatic"/>
<![CDATA[
>>--createStatic(--+----+--,-x-,-y-,-cx-,-cy--+----------+--+---------+--)-----><
+-id-+ +-,-style--+ +-,-text--+
]]>
</programlisting>
</section>
<section id="ddCreateStaticFrame"><title>createStaticFrame</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateStaticFrame"/>
<![CDATA[
>>--createStaticFrame(--id--,-x--,-y--,-cx--,-cy--+----------+--)--------------><
+-,-style--+
]]>
</programlisting>
</section>
<section id="ddCreateStaticImage"><title>createStaticImage</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateStaticImage"/>
<![CDATA[
>>--createStaticImage(--id--,-x--,-y--,-cx--,-cy--+----------+--)--------------><
+-,-style--+
]]>
</programlisting>
</section>
<section id="ddCreateStaticText"><title>createStaticText</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateStaticText"/>
<![CDATA[
>>--createStaticText(-+------+--x-,--y-+------+-+------+-+----------+-+--------+-)-><
+-id-,-+ +-,-cx-+ +-,-cy-+ +-,-style--+ +-,-text-+
]]>
</programlisting>
</section>
<section id="ddCreateWhiteFrame"><title>createWhiteFrame</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateWhiteFrame"/>
<![CDATA[
>>--createWhiteFrame(--+------+--x-,-y-,-cx-,-cy--+-----------+-)--------------><
+--id--+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateWhiteRect"><title>createWhiteRect</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateWhiteRect"/>
<![CDATA[
>>--createWhiteRect(--+------+--x-,-y-,-cx-,-cy--+-----------+-)---------------><
+--id--+ +-,--style--+
]]>
</programlisting>
</section>
<section id="ddCreateTab"><title>createTab</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateTab"/>
<![CDATA[
>>--createTab(-id-,--x-,--y-,--cx-,--cy-+---------+--+-----------------+--)----><
+-,-style-+ +-,-attributeName-+
]]>
</programlisting>
</section>
<section id="ddCreateTrackBar"><title>createTrackBar</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateTrackBar"/>
<![CDATA[
>>--createTrackBar(-id-,--x-,--y-,--cx-,--cy-+---------+--+------------+--)----><
+-,-style-+ +-,-attrName-+
]]>
</programlisting>
</section>
<section id="ddCreateTreeView"><title>createTreeView</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateTreeView"/>
<![CDATA[
>>--createTreeView(-id-,--x-,--y-,--cx-,--cy-+---------+--+------------+--)----><
+-,-style-+ +-,-attrName-+
]]>
</programlisting>
</section>
<section id="ddCreateUpDown"><title>createUpDown</title>
<programlisting>
DynamicDialog::<xref linkend="mthCreateUpDown"/>
<![CDATA[
>>--createUpDown(-id-,--x-,--y-,--cx-,--cy-+---------+--+-----------------+--)-><
+-,-style-+ +-,-attributeName-+
]]>
</programlisting>
</section>
<section id="ddDefineDialog"><title>defineDialog</title>
<programlisting>
DynamicDialog::<xref linkend="mthDefineDialog"/>
<![CDATA[
>>--defineDialog---------------------------------><
]]>
</programlisting>
</section>
<section id="ddLoad"><title>load</title>
<programlisting>
DynamicDialog::<xref linkend="mthLoad"/>
<![CDATA[
>>--load(--rcFile--+-------+--+----------+--+-------------+--)-----------------><
+-,-id--+ +--,-opts--+ +-,--expected-+
]]>
</programlisting>
</section>
<section id="ddLoadFrame"><title>loadFrame</title>
<programlisting>
DynamicDialog::<xref linkend="mthLoadFrame"/>
<![CDATA[
>>--loadFrame(--rcFile--+-------+--+----------+--+-------------+--)------------><
+-,-id--+ +--,-opts--+ +-,--expected-+
]]>
</programlisting>
</section>
<section id="ddLoadItems"><title>loadItems</title>
<programlisting>
DynamicDialog::<xref linkend="mthLoadItems"/>
<![CDATA[
>>--loadItems(--rcFile--+-------+--+----------+--)-----------------------------><
+-,-id--+ +--,-opts--+
]]>
</programlisting>
</section>
</section>
<section id="clsCustomDraw" xreflabel="CustomDraw"><title>CustomDraw Mixin Class</title>
<indexterm><primary>CustomDraw class</primary></indexterm>
<para>
Custom draw is a service provided by some of the Windows common controls. This service allows the programmer greater
control over the appearance of a control than that provided directly though the styles and methods of the control.
Not all controls support custom draw, but those that do provide the service in a generic manner through the use of
custom draw <xref linkend="ovvEvents"/> notifications.
</para>
<para>
The following Windows controls provide custom draw services:
<itemizedlist>
<listitem>
<para>
Header controls.
</para>
</listitem>
<listitem>
<para>
List-view controls.
</para>
</listitem>
<listitem>
<para>
Rebar controls.
</para>
</listitem>
<listitem>
<para>
Toolbar controls.
</para>
</listitem>
<listitem>
<para>
Trackbar controls.
</para>
</listitem>
<listitem>
<para>
Tree-view controls.
</para>
</listitem>
</itemizedlist>
The current implementation of custom draw in ooDialog supports <emphasis role="italic">simple</emphasis> custom draw
for the <link linkend="clsListView">list-view</link> and <link linkend="clsTreeView">tree-view</link> controls.
</para>
<section id="sctCustomDrawOverview" xreflabel="overview"><title>Custom Draw Overview</title>
<indexterm><primary>custom draw</primary><secondary>overview</secondary></indexterm>
<para>
All windows in the Windows operating system periodically paint and erase themselves based on messages received from the
system or other applications. This process of painting or erasing is called a paint cycle. The common controls
that support custom draw send <xref linkend="ovvEvents"/> notifications at specific points while the control is being
drawn. The notifications describe drawing operations that apply to the entire control as well as drawing operations
specific to items within the control.
</para>
<para>
Part of the the information sent in the custom draw notification is what stage of the paint cycle the control is in. The
stage will either be part of the overall painting of the control or part of the painting of an item the control contains.
The stage is identified by a constant value supplied by the <computeroutput>CustomDraw</computeroutput> class. The possible
draw stages are described in the following table:
<table id="tblCustomDrawStage" frame="all"> <title>Stages of Custom Draw</title>
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="2*"/>
<thead>
<row>
<entry>Constant Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Global</emphasis></entry>
<entry align="center"><emphasis role="bold">Draw Stages</emphasis></entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_PREPAINT"/></entry>
<entry>This stage is before the paint cycle begins.</entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_POSTPAINT"/></entry>
<entry>This stage is after the paint cycle is complete.</entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_PREERASE"/></entry>
<entry>This stage is before the erase cycle begins. </entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_POSTERASE"/></entry>
<entry>This stage is after the erase cycle is complete.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Item Specific</emphasis></entry>
<entry align="center"><emphasis role="bold">Draw Stages</emphasis></entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_ITEMPREPAINT"/></entry>
<entry>This stage is before an item is drawn.</entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_ITEMPOSTPAINT"/></entry>
<entry>This stage is after an item has been drawn.</entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_ITEMPREERASE "/></entry>
<entry>This stage is before an item is erased.</entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_ITEMPOSTERASE"/></entry>
<entry>This stage is after an item has been erased.</entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_SUBITEMPREPAINT"/></entry>
<entry>This stage is before an subitem is drawn. Only used in <xref linkend="clsListView"/> controls in report mode.</entry>
</row>
<row>
<entry><xref linkend="cnstCDDS_SUBITEMPOSTPAINT"/></entry>
<entry>This stage is after an subitem has been drawn. Only used in list-view controls in report mode.</entry>
</row>
</tbody></tgroup>
</table>
</para>
<para>
The ooDialog program that uses custom draw processes the information sent by the control and returns information that
instructs the underlying dialog control what to do. The key to using custom draw is in this information sent back to the
control in response to the event notification message. The information returned by the program determines the control's
behavior for that paint cycle.
</para>
<para>
Part of the information returned is a combination of response codes to the event notification. The
<computeroutput>CustomDraw</computeroutput> class provides constant values for these codes as summarized in the following
table:
<table id="tblCustomDrawResponse" frame="all"> <title>Notification Responses</title>
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="2*"/>
<thead>
<row>
<entry>Constant Value</entry>
<entry>Effect</entry>
</row>
</thead>
<tbody>
<row>
<entry><xref linkend="cnstCDRF_DODEFAULT "/></entry>
<entry>The control will draw itself. It will not send additional event notifications for this paint cycle. This respons cannot be used with any other response.</entry>
</row>
<row>
<entry><xref linkend="cnstCDRF_NOTIFYITEMDRAW"/></entry>
<entry>The control will send event notifications for any item-specific drawing operations. It will send event notification messages before and after it draws items.</entry>
</row>
<row>
<entry><xref linkend="cnstCDRF_NOTIFYPOSTPAINT"/></entry>
<entry>The control will send an event notification when the painting cycle for the entire control is complete.</entry>
</row>
<row>
<entry><xref linkend="cnstCDRF_NOTIFYSUBITEMDRAW"/></entry>
<entry>The control will send event notifications for any subitem-specific drawing operations. It will send event notification messages before and after it draws subitems.</entry>
</row>
<row>
<entry><xref linkend="cnstCDRF_SKIPDEFAULT"/></entry>
<entry>The control will not perform any painting at all. </entry>
</row>
<row>
<entry><xref linkend="cnstCDRF_DOERASE"/></entry>
<entry>The control will only draw the background.</entry>
</row>
<row>
<entry><xref linkend="cnstCDRF_SKIPPOSTPAINT"/></entry>
<entry>The control will not draw the focus rectangle around an item.</entry>
</row>
</tbody></tgroup>
</table>
</para>
<para>
Custom draw can be used by the program to draw the entire item, or to change part of the way an item is drawn. Custom draw
can be used to change the foreground and background colors, and the font used by the control for each item. For list-view
controls in report view, the programmer can also change change the colors and the font for each individual subitem.
</para>
</section> <!-- End CustomDrawOverview section -->
<section id="sctCustomDrawInooDialog"><title>Custom Draw in ooDialog</title>
<indexterm><primary>custom draw</primary><secondary>in ooDialog</secondary></indexterm>
<para>
Using custom draw in ooDialog involves a few basic steps.
<variablelist>
<varlistentry><term><emphasis role="bold">Inherit <computeroutput>CustomDraw</computeroutput></emphasis></term>
<listitem>
<para>
The dialog subclass where the programmer wants to use custom draw must inherit the
<computeroutput>CustomDraw</computeroutput> mixin class.
<programlisting>
::class 'CustomDrawDlg' subclass RcDialog inherit CustomDraw
</programlisting>
</para>
<para>
The dialog subclass does not have to be a <xref linkend="clsRcDialog"/> of course. It can be any dialog class supported
by ooDialog, except the <xref linkend="clsPropertySheetDialog"/>. Recall that the property sheet dialog is managed by
the operating system, not ooDialog. However, the pages of the property sheet dialog, any <xref
linkend="clsPropertySheetPage"/> dialogs, can use custom draw.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Initialize <computeroutput>CustomDraw</computeroutput></emphasis></term>
<listitem>
<para>
Before any other use of custom draw, the <computeroutput>CustomDraw</computeroutput> class must be initialized. This is
done through the <xref linkend="mthCustomDraw"/> method. This can be done wherever it seems convenient, but typically
it would be done before the dialog control is populated with its items.
<programlisting>
::method init
expose textRed textBlack
forward class (super) continue
self~customDraw
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Register Control(s)</emphasis></term>
<listitem>
<para>
Once the <computeroutput>CustomDraw</computeroutput> class is initialized, the next step is to register the dialog
controls that will use custom draw. Each individual control must be registered using the <xref
linkend="mthCustomDrawControl"/> method.
<programlisting>
::method init
...
self~customDrawControl(IDC_LV_CUSTOM, 'ListView', onCustomDraw)
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Code an Event Handler</emphasis></term>
<listitem>
<para>
The last part of using custom draw is coding the event handler. In ooDialog, the information from the Windows dialog
control is passed on the the Rexx event handler in the form of an object. Each individual dialog control type has a
control specific class that is used to pass the information. Details on how to code the event handler are explained in
the documentation of the control specific class.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Supported Dialog controls.</emphasis></term>
<listitem>
<para>
ooDialog supports custom draw for the dialog controls listed in the following table. The table has a link to the class
used to provide the event handler with the information sent by the underlying dialog control and a link to the
documentation for the event handler for the specific type of control.
<table id="tblSupportedCustomDrawControls" frame="all"><title>ooDialog Supported Custom Draw Controls</title>
<tgroup cols="3">
<colspec colwidth="1*"/>
<colspec colwidth="1*"/>
<colspec colwidth="1*"/>
<thead>
<row>
<entry>Control</entry>
<entry>Information Class</entry>
<entry>Event Handler</entry>
</row>
</thead>
<tbody>
<row>
<entry><xref linkend="clsListView"/></entry>
<entry><xref linkend="clsLvCustomDrawSimple"/></entry>
<entry><xref linkend="evtListViewCustomDraw"/></entry>
</row>
<row>
<entry><xref linkend="clsTreeView"/></entry>
<entry><xref linkend="clsTvCustomDrawSimple"/></entry>
<entry><xref linkend="evtTreeViewCustomDraw"/></entry>
</row>
</tbody></tgroup>
</table>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</section> <!-- End CustomDrawInOODialog section -->
<section id="sctSimpleCustomDraw" xreflabel="simple"><title>Simple Custom Draw</title>
<indexterm><primary>custom draw</primary><secondary>simple custom draw</secondary></indexterm>
<para>
Currently, ooDialog supports a limited subset of the full functionality supplied by the Windows custom draw API. The
developers are denoting this as <emphasis role="italic">simple</emphasis> custom draw. Simple custom draw allows the
ooDialog programmer to change the foreground and background colors of individual dialog control items and subitems. It also
allows the programmer to change the font of individual items and subitems.
</para>
<para>
There are a number of reasons for only supporting simple custom draw at this point. For one, it is probably sufficient for
everything an ooDialog programmer will want to do. It allows the most useful functionality of custom draw to be delievered
sooner and leaves the possiblity of future enhancements providing more functionality. Drawing in Windows needs to be done
quickly and efficiently. This type of programming is normally done in a low-level language. It is not clear that a complete
implementation of custom draw would produce satisfactory results.
</para>
<para>
In simple custom draw, the ooDialog framework does not invoke the custom draw event handler for every single custom draw
notification sent by the dialog control. Rather, it replies directly for a number of the drawing stages itself, returning
the correct information so that the item and subitem prepaint notifications are sent by the control. It then invokes the
Rexx event handler for the item and subitem prepaint notifications. This allows the ooDialog programmer to change the
colors and fonts for any individual item or subitem.
</para>
<para>
In simple custom draw, the Rexx event handler will not recieve notifications for the postpaint, preerase, and posterase
drawing stages. The ooDialog programmer just needs to focus on handling the prepaint notifications for items and subitems.
</para>
</section> <!-- End SimpleCustomDraw section -->
<section id="sctMethodsCustomDraw"><title>Method Table</title>
<para>
The following table lists the class and instance methods of the <computeroutput>CustomDraw</computeroutput> class:
<table id="tblMethodsCustomDraw" frame="all"> <title>CustomDraw 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">Constant</emphasis></entry>
<entry align="center"><emphasis role="bold">Methods</emphasis></entry>
</row>
<row>
<entry><link linkend="sctConstantsClsCustomDraw">constants</link></entry>
<entry>The <computeroutput>CustomDraw</computeroutput> class provides a number of constant values needed to work with the custom draw interface.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance</emphasis></entry>
<entry align="center"><emphasis role="bold">Methods</emphasis></entry>
</row>
<row>
<entry><link linkend="mthCustomDraw">customDraw</link></entry>
<entry>Initializes the custom draw interface in ooDialog.</entry>
</row>
<row>
<entry><link linkend="mthCustomDrawControl">customDrawControl</link></entry>
<entry>Registers the specified dialog control to use custom draw.</entry>
</row>
<row>
<entry><link linkend="mthRGB">rgb</link></entry>
<entry>Constructs a COLORREF from the red, green, and blue values of a color..</entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="sctConstantsClsCustomDraw" xreflabel="CustomDraw constants"><title>Constants</title>
<indexterm><primary>constants</primary><secondary>CustomDraw class</secondary></indexterm>
<indexterm><primary>CustomDraw class</primary><secondary>constants</secondary></indexterm>
<para>
The Windows API for custom draw has a number of constant values used to specify varying things. There are constants used to
indicate the current stage of custom draw paint cycle, constants to use in replying to custom draw event notifications,
etc.. The <computeroutput>CustomDraw</computeroutput> class supplies the following <emphasis
role="italic">constant</emphasis> values to use with custom drawing. Note that, except where indicated, the CDRF_* response
codes can be combined together. The <xref linkend="mthOrClsDlgUtil"/> method can be used to combine values.
</para>
<variablelist>
<varlistentry id="cnstCDDS_ITEMPREERASE" xreflabel="CDDS_ITEMPREERASE"><term><emphasis role="bold">CDDS_ITEMPREERASE</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent
before an item is erased.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_ITEMPREPAINT" xreflabel="CDDS_ITEMPREPAINT "><term><emphasis role="bold">CDDS_ITEMPREPAINT </emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent
before an item is drawn.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_ITEMPOSTERASE" xreflabel="CDDS_ITEMPOSTERASE"><term><emphasis role="bold">CDDS_ITEMPOSTERASE</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent
after an item has been erased.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_ITEMPOSTPAINT" xreflabel="CDDS_ITEMPOSTPAINT"><term><emphasis role="bold">CDDS_ITEMPOSTPAINT</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent after
an item has been drawn.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_POSTERASE" xreflabel="CDDS_POSTERASE"><term><emphasis role="bold">CDDS_POSTERASE</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent
when the erase cycle is complete.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_POSTPAINT" xreflabel="CDDS_POSTPAINT"><term><emphasis role="bold">CDDS_POSTPAINT</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent when the paint cycle is complete.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_PREERASE" xreflabel="CDDS_PREERASE"><term><emphasis role="bold">CDDS_PREERASE</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent
before the erase cycle begins.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_PREPAINT" xreflabel="CDDS_PREPAINT"><term><emphasis role="bold">CDDS_PREPAINT</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent
before the paint cycle begins.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_SUBITEMPREPAINT" xreflabel="CDDS_SUBITEMPREPAINT"><term><emphasis role="bold">CDDS_SUBITEMPREPAINT</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent
before a subitem is drawn. This only applies to list-view controls in report view.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDDS_SUBITEMPOSTPAINT" xreflabel="CDDS_SUBITEMPOSTPAINT"><term><emphasis role="bold">CDDS_SUBITEMPOSTPAINT</emphasis></term>
<listitem>
<para>
Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent
after a subitem has been drawn. It is only sent for list-view controls in report view.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDRF_DODEFAULT" xreflabel="CDRF_DODEFAULT"><term><emphasis role="bold">CDRF_DODEFAULT</emphasis></term>
<listitem>
<para>
One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates
that the control should draw itself. The control will not send any more notification messages for the current paint
cycle. This response can not be combined with other response values.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDRF_DOERASE" xreflabel="CDRF_DOERASE"><term><emphasis role="bold">CDRF_DOERASE</emphasis></term>
<listitem>
<para>
One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates
that the control should only draw the background.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDRF_NEWFONT" xreflabel="CDRF_NEWFONT"><term><emphasis role="bold">CDRF_NEWFONT</emphasis></term>
<listitem>
<para>
One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates
that the programmer has changed the font for the item being drawn. For list-view and tree-view custom draw, it should
also be used to indicate that the colors have been changed.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDRF_NOTIFYITEMDRAW " xreflabel="CDRF_NOTIFYITEMDRAW "><term><emphasis role="bold">CDRF_NOTIFYITEMDRAW</emphasis></term>
<listitem>
<para>
One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates
the control should send notification message for any item-specific drawing operations. The control will send
event notifications before and after it draws items.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDRF_NOTIFYPOSTPAINT " xreflabel="CDRF_NOTIFYPOSTPAINT "><term><emphasis role="bold">CDRF_NOTIFYPOSTPAINT</emphasis></term>
<listitem>
<para>
One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates
the control should send a notification when the painting cycle for the entire control is complete.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDRF_NOTIFYSUBITEMDRAW " xreflabel="CDRF_NOTIFYSUBITEMDRAW "><term><emphasis role="bold">CDRF_NOTIFYSUBITEMDRAW</emphasis></term>
<listitem>
<para>
One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates
the control should send notification message for any subitem-specific drawing operations. The control will send
event notifications before and after it draws subitems.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDRF_SKIPDEFAULT" xreflabel="CDRF_SKIPDEFAULT"><term><emphasis role="bold">CDRF_SKIPDEFAULT</emphasis></term>
<listitem>
<para>
One of the response values that can be returned to the dialog control from the custom draw 8event handler. It indicates
that the control should not do any painting, the application will paint the entire control.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCDRF_SKIPPOSTPAINT" xreflabel="CDRF_SKIPPOSTPAINT"><term><emphasis role="bold">CDRF_SKIPPOSTPAINT</emphasis></term>
<listitem>
<para>
One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates
that the control should not draw the focus rectangle around an item.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCLR_DEFAULT" xreflabel="CLR_DEFAULT"><term><emphasis role="bold">CLR_DEFAULT</emphasis></term>
<listitem>
<para>
A special COLORREF value. COLORREFs are discussed in the documentation for both the <xref linkend="mthRGB"/> and <xref
linkend="mthColorRef"/> methods. The CLR_DEFAULT constant value is identical to the value returned either of those
methods when the CLR_DEFAULT keyword is used as the first argument to the method.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCLR_INVALID" xreflabel="CLR_INVALID"><term><emphasis role="bold">CLR_INVALID</emphasis></term>
<listitem>
<para>
A special COLORREF value. COLORREFs are discussed in the documentation for both the <xref linkend="mthRGB"/> and <xref
linkend="mthColorRef"/> methods. The CLR_INVALID constant value is identical to the value returned either of those
methods when the CLR_INVALID keyword is used as the first argument to the method.
</para>
</listitem></varlistentry>
<varlistentry id="cnstCLR_NONE" xreflabel="CLR_NONE"><term><emphasis role="bold">CLR_NONE</emphasis></term>
<listitem>
<para>
A special COLORREF value. COLORREFs are discussed in the documentation for both the <xref linkend="mthRGB"/> and <xref
linkend="mthColorRef"/> methods. The CLR_NONE constant value is identical to the value returned either of those methods
when the CLR_NONE keyword is used as the first argument to the method.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthCustomDraw" xreflabel="customDraw"><title>customDraw</title>
<indexterm><primary>customDraw</primary></indexterm>
<indexterm><primary>CustomDraw class</primary><secondary>customDraw</secondary></indexterm>
<programlisting>
<![CDATA[
>>--customDraw-----------------------------------><
]]>
</programlisting>
<para>
Initializes the custom draw interface in ooDialog and allows dialog controls to register for custom draw.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments for this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success and false on error. An error is highly unlikely.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">customDraw</emphasis> method must be invoked before any other use of custom draw. It
performs the basic initialization that allows ooDialog to inteact with the Windows custom draw service. The basic
sequence is to invoke the <emphasis role="italic">customDraw</emphasis> method and then register the control(s) that
will use custom draw.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example initializes the custom draw interface and then registers a list-view control to use custom draw.
<programlisting>
<![CDATA[
::method init
expose textRed textBlack
forward class (super) continue
self~customDraw
self~customDrawControl(IDC_LV_CUSTOM, 'ListView', onCustomDraw)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End CustomDraw::customDraw() -->
<section id="mthCustomDrawControl" xreflabel="customDrawControl"><title>customDrawControl</title>
<indexterm><primary>customDrawControl</primary></indexterm>
<indexterm><primary>CustomDraw class</primary><secondary>customDrawControl</secondary></indexterm>
<programlisting>
<![CDATA[
>>--customDrawControl(-id--+-----------+--+------------+-+------------+--)-----><
+-,-ctrlName+ +-,-methName-+ +-,-reserved-+
]]>
</programlisting>
<para>
Specifies that the programmer will custom draw the named control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
Resource ID of the control, may be numeric or <xref linkend="defSymbolicId"/>. A syntax condition
is raised if the ID is symbolic and it can not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>ctrlName [optional]</term>
<listitem>
<para>
The name of the type of control. I.e., treeView, TrackBar, LISTVIEW. By default the control is assumed to be a
ListView. Case is not significant. Only ListView and TreeView controls are currently supported.
</para>
</listitem></varlistentry>
<varlistentry><term>methName [optional]</term>
<listitem>
<para>
The name of a method in the Rexx dialog that will be invoked for the custom draw event. If omitted it defaults
to <emphasis role="italic">onCustomDraw</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>reserved [optional]</term>
<listitem>
<para>
Reserverd for future use. This argument is currently ignored.
</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">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">customDrawControl</emphasis> method in effect registers a specific dialog control to
receive custom draw event notifications and to use a certain <emphasis role="italic">type</emphasis> of custom draw.
Currently the only type implemented in ooDialog is <emphasis role="italic">simple</emphasis> custom draw.
</para>
<para>
It is important that the programmer correctly names the control using custom draw through the <emphasis
role="italic">ctrlName</emphasis> argument. Failure to do so will result in undefined behaviour.
</para>
<para>
The event handling method for the custom draw event will recieve a single object as its argument. The object
conveys information to the event handler concerning the event and receives information from the event handle to pass
back to the underlying Windows control. The exact object will depend on the type of dialog control. List-views will
receive a <link linkend="clsLvCustomDrawSimple">LvCustomDrawSimple</link> object and tree-views will receive a <link
linkend="clsTvCustomDrawSimple">TvCustomDrawSimple</link> object.
</para>
<para>
It is possible to have several dialog controls register to use the same event handling method. The information
object sent to the event handler has the resource ID of the control the event is for. However, the event handler
needs to respond to the events as quickly as possible. Therefore it may be better to use a different event handler
for each dialog control and eliminate the need to decipher which control the event is for in a single handler.
</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 initializes the custom draw interface and then registers two controls to use custom draw:
<programlisting>
<![CDATA[
self~customDraw
self~customDrawControl(IDC_LV_A, 'ListView', onCustomDrawA)
self~customDrawControl(IDC_LV_B, 'ListView', onCustomDrawB)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End CustomDraw::customDrawControl() -->
<section id="mthRGB" xreflabel="rgb"><title>rgb</title>
<indexterm><primary>rgb</primary></indexterm>
<indexterm><primary>CustomDraw class</primary><secondary>rgb</secondary></indexterm>
<programlisting>
<![CDATA[
>>--rgb(--+---+--+-----+--+-----+--)-------------><
+-r-+ +-,-g-+ +-,-b-+
]]>
</programlisting>
<para>
Constructs a COLORREF from the red, green, and blue components of a color. In the Windows API values of the type COLORREF
are often used for colors.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>r [optional]</term>
<listitem>
<para>
The red component for the color. The default is 0.
</para>
<para>
This argument can also be one of 3 keywords: CLR_DEFAULT, CLR_NONE, or CLR_INVALID, case is not significant. If
a keyword is used, the other arguments are ignored. See the remarks section for more information on the
keywords.
</para>
</listitem></varlistentry>
<varlistentry><term>g [optional]</term>
<listitem>
<para>
The green component for the color. The default is 0.
</para>
</listitem></varlistentry>
<varlistentry><term>b [optional]</term>
<listitem>
<para>
The blue component for the color. The default is 0.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the COLORREF value for the specified arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
A COLORREF is a 32-bit number with a hexidecimal format of: <computeroutput>0x00bbggrr</computeroutput>. The
<emphasis role="italic">rgb</emphasis> method provides a way to construct a COLORREF from the red, green, and blue
values. Each color value (red, green, or blue) is a whole number in the range of 0 to 255 inclusive.
</para>
<para>
The CLR_DEFAULT, CLR_NONE, etc., keywords represent special COLORREF values defined in the Windows API. The exact
meaning of the value seems dependent on the context it is used in. For instance, in the list-view custom draw
interface, if an item's foreground or background color is assigned CLR_DEFAULT, the list-view draws that item in its
default color. On the other hand, if the same thing is done for a tree-view item, the tree-view draws that item in
black.
</para>
<para>
CLR_DEFAULT and CLR_INVALID are actually the same value. The CLR_INVAID keyword is provided for completeness.
</para>
<para>
The functionality of the <emphasis role="italic">rgb</emphasis> method is identical to the functionality of the
<link linkend="mthColorRef">colorRef</link> class method of the <link linkend="clsImage">Image</link> class. Either
method will return the same value for the same inputs.
</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 specifies the custom draw colors for a list-view item. The item will be drawn with dark blue text on a
light blue background.
<programlisting>
<![CDATA[
if list~isChecked(item) then do
lvcds~clrText = self~RGB( 17, 5, 250)
lvcds~clrTextBk = self~RGB(115, 245, 186)
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End CustomDraw::rgb() -->
</section> <!-- End CustomDraw Class -->
</chapter>