[r8770]: ooDialog / branches / 4.2.1 / doc / oodialog / en-US / dataAttributes.xml Maximize Restore History

Download this file

dataAttributes.xml    3435 lines (3185 with data), 131.9 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
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section 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.
#
#########################################################################
-->
<section id="sctDataAttributes"><title>Data Attribute Methods</title>
<indexterm><primary>data attributes</primary></indexterm>
<indexterm><primary>connecting data attributes</primary></indexterm>
<indexterm><primary>get and set data methods</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>data attributes</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>get and set data methods</secondary></indexterm>
<section id="sctUnderstandingDataAttributes" xreflabel="attribute"><title>Understanding Data Attributes</title>
<indexterm><primary>dialog object</primary><secondary>understanding data attributes</secondary></indexterm>
<para>
This section contains methods for working with <emphasis role="bold">data attributes</emphasis>. It contains methods
to create a connection between an underlying dialog control and an attribute of the Rexx dialog object, methods for
<emphasis role="bold">getting</emphasis> and <emphasis role="bold">setting</emphasis> the <emphasis
role="bold">data</emphasis>, and methods to deal with <emphasis role="bold">automatic data detection</emphasis>. These
data attributes are used to reflect the <emphasis role="bold">values</emphasis> associated with the underlying dialog
controls. For instance, the value of an <xref linkend="clsEdit"/> control could be thought of as the text of
the control.
</para>
<para>
In order to better understand the data attribute methods, it is useful to first discuss this concept in general.
During the <link linkend="sctHistory">original</link> development of ooDialog the abstraction used was that there were only
two objects. One was the Rexx dialog object and the other was the <xref linkend="ovvUnderlying"/> system dialog that the user
sees on the screen. Dialog controls were not thought of as objects, but rather as the <emphasis
role="bold">data</emphasis> of the underlying dialog. In this abstraction, the <emphasis role="bold">value</emphasis> of
the data was the <emphasis role="bold">state</emphasis> of the dialog control.
</para>
<para>
For instance, a radio button can be either checked or not checked. Therefore, its value could be 0 (not checked) or 1
(checked.) Thus the data of the radio button would be a 1 or a 0. Using this abstraction of two objects, the Rexx
dialog and the underlying on screen dialog, then leads to the idea of exchanging, or transferring, the data between
the two objects. Or, typically, getting and setting the data of the underlying dialog. To facilitate this exchange of
data, for each <emphasis role="bold">data item</emphasis>, (a dialog control,) in the underlying dialog an attribute
is added to the Rexx dialog object. This attribute is then used to transfer data between the Rexx dialog object and
the underlying dialog control. The value of each data attribute is a single string which represents the state of the
dialog control.
</para>
<para>
The operation of <emphasis role="bold">connecting</emphasis> a dialog control is the action of creating the attribute
(the data attribute) in the Rexx dialog object, and internally mapping the attribute to the specified dialog control
in the underlying dialog. The operation of <emphasis role="bold">seting data</emphasis> then becomes the action of
setting the state of the underlying dialog control to match the value of the corresponding attribute of the Rexx
dialog object. The operation of <emphasis role="bold">getting data</emphasis> becomes the action of setting the value
of the attribute in the Rexx dialog object to match the state of the corresponding dialog control in the underlying
dialog.
</para>
<para id="paraAutomaticDataDetection" xreflabel="automatic data detection">
The term <emphasis role="italic">automatic data field detection</emphasis> is used for this process of creating and
connecting data attributes. In addition to creating and connecting the data attributes, if automatic data field
detection is on, when the underling dialog is created, the state of its controls are automatically set to the values
of the data attributes. Likewise, when the dialog is closed, the values of the data attributes in the Rexx dialog are
set to the state of their correspondaing controls in the underlying dialog.
</para>
<para>
Automatic data detection is implemented in all three main classes of dialogs, the <xref linkend="clsUserDialog"/>, <xref
linkend="clsResDialog"/>, and <xref linkend="clsRcDialog"/>, and of course their subclasses. Automatic data detection can
be turned on or off. By default it is <emphasis role="bold">on</emphasis>. The best way to turn automatic data field
detection off for a single dialog is to over-ride the <xref linkend="mthInitAutoDetection"/> method in your subclass. The
<xref linkend="dotApplication"/>, an instance of the <xref linkend="clsApplicationManager"/> class, can be used to change
the default to <emphasis role="bold">off</emphasis> for the entire program.
</para>
<para>
Some dialog controls are not considered to be <emphasis role="italic">data</emphasis> and therefore data attributes
are not created for those controls. (This is a quirk going back to the original implementation of of ooDialog.) The
non-data controls are those, in general, that the user would not change or update in a dialog. Push <link
linkend="clsButton">buttons</link>, <link linkend="clsGroupBox">group</link> box and <link
linkend="clsStatic">static</link> controls are all considered non-data controls. There are no data
attribute methods for these controls.
</para>
<para>
When automatic data detection is turned off, the programmer can use the <xref linkend="sctConnectDataMethods"/> methods to
manually create and connect the data attribute for any control. However, with automatic detection off, the ooDialog
framework will not set the state of the dialog controls to match the values of the connected attributes
when the underlying dialog is created. Likewise, when the dialog ends the connected attributes of the Rexx dialog object
are not updated to the state of the dialog controls. But, the programmer can use the <xref linkend="mthSetData"/> and
<xref linkend="mthGetData"/> methods to do this herself.
</para>
<para>
The implementation of automatic data detection in the three main classes of dialogs is slightly different in each
class due to the differences in the classes:
<variablelist>
<varlistentry><term><emphasis role="bold">UserDialog:</emphasis></term>
<listitem>
<para>
In a <xref linkend="clsUserDialog"/> the <xref linkend="sctConnectDataMethods"/> methods are called automatically from
the <xref linkend="sctCreateMethods"/> methods of the <computeroutput>UserDialog</computeroutput>. Each of the
create... methods takes an optional argument that allows the programmer to specify the data attribute name. If that
argument is omitted, the attribute name is <link linkend="sctDataAttributeNames">automatically</link> generated. This
behavior is only when automatic data detection is on. When it is off, no data connection is made, even if the
attribute name is specified.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">RcDialog</emphasis></term>
<listitem>
<para>
A <xref linkend="clsRcDialog"/> is actually a subclass of the
<computeroutput>UserDialog</computeroutput>. Therefore, when automatic data detection is on, the connect...
attribute methods are invoked automatically during the creation of each dialog control. The difference is that
there is no option to specify the attribute name, the name is <emphasis role="bold">always</emphasis> generated
automatically.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">ResDialog</emphasis></term>
<listitem>
<para>
With a <xref linkend="clsResDialog"/> the data connections are made after the underlying dialog is
created. Internally, the numeric resource ID and text of each control in the dialog is determined. Then, a data
attribute for each control is created and connected. Again, there is no way for the programmer to specify the data
attribute name, it is always automatically constructed.
</para>
</listitem></varlistentry>
</variablelist>
Obviously, the data attribute itself can not be accessed until it is created. For each type of class this is at a
subtly different point in the life cycle of the dialog.
</para>
<para>
In summary: When automatic data field detection is on, the ooDialog framework automatically creates an attribute in
the dialog object for each dialog control in the underlying dialog. The attribute is connected to the control through
an internal mapping maintained by the framework. Once the connection is made, it can be used to get or set the
<emphasis role="italic">data</emphasis> of the control. The data of a control is a string representation of the
control's state. When each underlying dialog is created, the state of all its controls is set to the value of its
connected data attribute. When the underlying dialog is closed by the user, the process is reversed. Each data
attribute is updated to reflect the state of the dialog control when the dialog was closed. For the most part, the
name of the data attribute is generated automatically by the framework. When automatic data field detection is off,
none of this is done, but there are methods the programmer can use to manually do the same things.
</para>
</section>
<section id="sctDataAttributeNames"><title>Data Attribute Names</title>
<indexterm><primary>data attribute names</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>data attribute names</secondary></indexterm>
<para>
Except when the programmer explicitly names the data attribute in one of the <xref linkend="sctConnectDataMethods"/>
methods, or one of the <xref linkend="sctCreateMethods"/> methods of the
<computeroutput>UserDialog</computeroutput>, the data attribute names are generated internally. Even when the name is
explicitly specified by the programmer, if the name is not a valid method name or is a duplicate method name, the attribute
name is generated internally. The rules for how the attribute names are generated can be a little difficult to grasp. The
following list is intended to be complete description of the rules in all circumstances.
<variablelist>
<varlistentry id="termConnectAutoNames" xreflabel="generated automatically">
<term><emphasis role="bold">connect... data attribute methods:</emphasis></term>
<listitem>
<para>
When the programmer uses one of the <xref linkend="sctConnectDataMethods"/> methods, the attribute name can be
omitted, or the name specified could not be valid. For these cases, the internally generated name is created in this
way:
</para>
<para>
If the name is omitted, then the name is created by prepending <computeroutput>DATA</computeroutput> with the
resource ID argument. Recall that the resource ID argument can possibly be a symbolic ID. Example:
<programlisting>
<![CDATA[
-- The attribute name will be DATA202
self~connectEdit(202)
-- The attribute name will be DATAIDC_EDIT_FNAME
self~connectEdit(IDC_EDIT_FNAME)
]]>
</programlisting>
</para>
<para>
Whether the attribute name was specified or not, before the attribute is actually added to the dialog object, the
name is checked to see that it is a valid method name, that it is not the empty string, and not a duplicate of an
already existing method name in the dialog. When the check fails, the name is created by prepending
<computeroutput>DATA</computeroutput> with the <emphasis role="bold">numeric</emphasis> value of the
resource ID argument. This is true even when the id argument is specified as a symbolic ID. Example:
<programlisting>
<![CDATA[
self~constDir[IDC_EDIT_FNAME] = 344
-- The attribute name will be DATA202
self~connectEdit(202, "COPY")
-- The attribute name will be DATA344
self~connectEdit(IDC_EDIT_FNAME, 'FNAME+ADDRESSBOOK')
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry id="termCreateAutoNames"><term><emphasis role="bold">UserDialog create... methods:</emphasis></term>
<listitem>
<para>
In the typical <computeroutput>UserDialog</computeroutput> all controls are added to the dialog by using one of the
<xref linkend="sctCreateMethods"/> methods. This is similar to using one of the connect... methods.
The attribute name argument can be omitted, or the specified attribute name might not be valid. For these cases,
the internally generated name is created in this way:
</para>
<para>
If the name is omitted, and the dialog control is <emphasis role="bold">not</emphasis> a check box or radio
button, then the name is created by prepending <computeroutput>DATA</computeroutput> with the numeric value of the
resource ID argument. Example:
<programlisting>
<![CDATA[
self~constDir[IDC_EDIT_FNAME] = 344
-- The attribute name will be DATA344
self~createEdit(344, 10, 10, 100, 12, "AUTOSCROLLH MULTILINE")
-- The attribute name will be DATA344
self~createEdit(IDC_EDIT_FNAME, 10, 10, 100, 12, "AUTOSCROLLH MULTILINE")
]]>
</programlisting>
</para>
<para>
If the name is omitted and the dialog control <emphasis role="bold">is</emphasis> a check box or radio button,
then the name is created from the text of the <emphasis role="bold">label</emphasis> of the button. First all
spaces, ampersands, and colons, if any, are removed from the label. The result is used for the attribute name.
Examples:
<programlisting>
<![CDATA[
self~constDir[IDC_CHK_LN] = 200
self~constDir[IDC_CHK_MAIL] = 201
self~constDir[IDC_CHK_RECEIPT] = 202
-- The attribute name will be USELASTNAME
self~createCheckBox(IDC_CHK_LN, 10, 10, 80, 12, "GROUP", "&Use last name")
-- The attribute name will be MAILITEM
self~createCheckBox(IDC_CHK_MAIL, 10, 27, 80, 12, "RBUTTON RIGHT", "Mail item:")
-- The attribute name will be RECEIPT
self~createCheckBox(IDC_CHK_RECEIPT, 10, 45, 80, 12, , "Receipt")
]]>
</programlisting>
</para>
<para>
Whether the attribute name was specified or generated by the framework, the name is always checked to see if it is
the empty string, not a valid method name, or a duplicate of an already existing method name in the dialog. When
the check fails, then the name is created by prepending <computeroutput>DATA</computeroutput> with the <emphasis
role="bold">numeric</emphasis> value of the resource ID argument. This is true even when the id argument is
specified as a symbolic ID. Examples:
<programlisting>
<![CDATA[
self~constDir[IDC_EDIT_CLASS] = 344
self~constDir[IDC_CHK_DEFAULTNAME] = 201
self~constDir[IDC_CHK_COPY] = 202
-- The attribute name will be DATA344 (CLASS is an existing method name.)
self~createEdit(IDC_EDIT_CLASS, 10, 10, 100, 12, "AUTOSCROLLH MULTILINE", "Class")
-- The attribute name will be DATA201 (defaultName is an existing method name.)
self~createCheckBox(IDC_CHK_DEFAULTNAME, 10, 27, 80, 12, , "Default Name")
-- The attribute name will be DATA202
self~createCheckBox(IDC_CHK_COPY, 10, 45, 80, 12, , "&Copy")
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">ResDialog:</emphasis></term>
<listitem>
<para>
For a <computeroutput>ResDialog</computeroutput>, the attribute names are always generated by the ooDialog
framework, there is no way for the programmer to specify the name. When the underlying dialog is created, the
numeric resource ID and the text of all the dialog controls is collected. For <emphasis
role="bold">each</emphasis> control, the data attribute is created using the <emphasis role="bold">text</emphasis>
of the control.
</para>
<para>
<emphasis role="bold">Note</emphasis> this important detail: every dialog control can have text associated with it
when compiled from a resource <xref linkend="defResourceScript"/>. Although for many controls, text is
not usually associated with them, it is always possible that they do have text.
</para>
<para>
The text of the control has all spaces, ampersands, and colons removed. The result is checked as usual. If it is
the empty string, or not a valid method name, or a duplicate of an existing method name, then the attribute name
is changed to <computeroutput>DATA</computeroutput> prepended to the resource ID. The attribute name then follows
the pattern(s) already seen. Examples:
<programlisting>
<![CDATA[
-- For an edit control with resource ID 344 and no associated text:
DATA344
-- For a check box with resource ID 400 and a label of "Compile":
COMPILE
-- For a radio button with resource ID 200 and a label of "&Copy":
DATA200
-- For a tree view with resource 320 and text associated of "C: Drive"
CDRIVE
-- Same tree view with no text assoicate, (the usual case):
DATA320
-- etc..
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">RcDialog:</emphasis></term>
<listitem>
<para>
Although a <computeroutput>RcDialog</computeroutput> is actually a subclass of a
<computeroutput>UserDialog</computeroutput> and the dialog controls are added to the dialog <xref
linkend="ovvDialogTemplate"/> through the <xref linkend="sctCreateMethods"/> methods,
the generated attribute names have a different pattern. If the resource ID of the control in the resource <xref
linkend="defResourceScript"/> file is a symbolic ID, then the attribute name will be the
symbolic ID. On the other hand, if the resource ID is numeric in the resource script file, then the attribute name
will be <computeroutput>DATA</computeroutput> prepended to the numeric ID. Example:
<programlisting>
<![CDATA[
-- For this resource script file:
//
// Dialog resources
//
LANGUAGE LANG_NEUTRAL, SUBLANG_NEUTRAL
IDD_DIALOG1 DIALOGEX 0, 0, 237, 131
STYLE DS_MODALFRAME | WS_VISIBLE | WS_BORDER | WS_CAPTION | WS_DLGFRAME | WS_SYSMENU
CAPTION "Dialog"
FONT 8, "MS Shell Dlg 2", 400, 0, 1
{
EDITTEXT 1003, 27, 22, 116, 47, WS_GROUP | ES_AUTOHSCROLL | ES_MULTILINE
EDITTEXT IDC_EDIT2, 27, 84, 116, 12, ES_AUTOHSCROLL
AUTOCHECKBOX "Hello There", IDC_CHK_TEST, 27, 109, 52, 10
DEFPUSHBUTTON "OK", IDOK, 125, 107, 50, 14
PUSHBUTTON "Cancel", IDCANCEL, 177, 107, 50, 14
LTEXT "Just a test of a static control", IDC_ST_TEST, 163, 28, 54, 24, SS_LEFT
}
-- The attribute names will be:
DATA1003
IDC_EDIT2
IDC_CHK_TEST
]]>
</programlisting>
</para>
<para>
However, as always, the attribute name is checked to be a valid method name, not the empty string, and not a
duplicate of an existing method name. If the resource script file is valid, it can not be the empty string.
Usually, programmers do not name their symbolic IDs in a fashion that would conflict with an existing method name,
but there is no reason why they could not. If the check fails, then the attribute name will once again be
<computeroutput>DATA</computeroutput> prepended to the <emphasis role="bold">numeric</emphasis> value of the
resource ID. Example:
<programlisting>
<![CDATA[
-- For this resource script file:
#define COPY 1004
//
// Dialog resources
//
LANGUAGE LANG_NEUTRAL, SUBLANG_NEUTRAL
IDD_DIALOG1 DIALOGEX 0, 0, 237, 131
STYLE DS_MODALFRAME | WS_VISIBLE | WS_BORDER | WS_CAPTION | WS_DLGFRAME | WS_SYSMENU
CAPTION "Dialog"
FONT 8, "MS Shell Dlg 2", 400, 0, 1
{
EDITTEXT 1003, 27, 22, 116, 47, WS_GROUP | ES_AUTOHSCROLL | ES_MULTILINE
EDITTEXT IDC_EDIT2, 27, 84, 116, 12, ES_AUTOHSCROLL
AUTOCHECKBOX "Hello There", COPY, 27, 109, 52, 10
DEFPUSHBUTTON "OK", IDOK, 125, 107, 50, 14
PUSHBUTTON "Cancel", IDCANCEL, 177, 107, 50, 14
LTEXT "Just a test of a static control", IDC_ST_TEST, 163, 28, 54, 24, SS_LEFT
}
-- The attribute names will be:
DATA1003
IDC_EDIT2
DATA1004
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</section>
<section id="sctDataAttributeProblems"><title>Problems with Data Attributes</title>
<indexterm><primary>data attribute problems</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>data attribute problems</secondary></indexterm>
<para>
In the author's mind, there are a number of problems with the whole data attribute concept. In no particular oder,
some of them are brought up here.
</para>
<para>
The abstraction that there are only two objects, the Rexx dialog object and the underlying operating system dialog, is
a little outdated. In this abstraction, the state of a dialog control must be transferred back and forth through the
dialog object. In addition, the original users of the abstraction believed the <emphasis role="italic">data</emphasis>
of a dialog control could only be represented by a single string. The abstraction works somewhat for simple controls
like a check box, a radio button, or an edit control. However it quickly starts to break down with more complex
controls like tree views and list views. Indeed, when the more complicated controls were added to ooDialog,
there were no get and set data methods implemented for them. There is no <emphasis
role="italic">getTreeViewData</emphasis> or <emphasis role="italic">setListViewData</emphasis> methods.
</para>
<para>
A more flexible abstraction is that everything is an object, that all the dialog controls are objects. In this
abstraction, the state of a dialog control is set or queried directly through methods of the dialog control object.
Current development in ooDialog is done using this abstraction.
</para>
<para>
Presumably the automatic data field detection was done to make things easier for the Rexx programmer. However, the
whole process is actually quite confusing. The data attributes themselves are not visible in the program, which often
makes it difficult to read and understand a program. When the attribute names are generated automatically, it is often
quite difficult to know exactly what the name is.
</para>
<para>
With auto detection on, the states of the dialog controls are set to the data (values) of the corresponding data
attributes. This is done <emphasis role="bold">after</emphasis> <xref linkend="mthInitDialog"/> is
invoked. The consequence of this is that, if the programmer explicitly sets the state of the dialog controls in the
<emphasis role="italic">initDialog</emphasis>() method, the ooDialog framwork will then <emphasis
role="bold">reset</emphasis> the state of all the dialog controls afterwards. This can be disconcerting to the
programmer if automatic data field detection is not understood.
</para>
</section>
<section id="mthAutoDetection" xreflabel="autoDetection"><title>autoDetection</title>
<indexterm><primary>autoDetection</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>autoDetection</secondary></indexterm>
<programlisting>
<![CDATA[
>>--autoDetection--------------------------------><
]]>
</programlisting>
<para>
When the <emphasis role="italic">autoDetection</emphasis> method is invoked, it switches on
<xref linkend="paraAutomaticDataDetection"/>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method does not return anything.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="sctConnectDataMethods" xreflabel="connnect data attriubte"><title>Connect Data Attribute Methods</title>
<indexterm><primary>connect data attribute methods</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connect data attribute methods</secondary></indexterm>
<para>
The methods in this section are used to manually create and connect a data <link
linkend="sctUnderstandingDataAttributes">attribute</link>. Their purpose is to manually do what is
done when <link linkend="mthInitAutoDetection">automatic</link> data field detection is on. They should only be used when
automatic detection is off.
</para>
<section id="mthConnectCheckBox" xreflabel="connectCheckBox"><title>connectCheckBox</title>
<indexterm><primary>connectCheckBox</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectCheckBox</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connctChectBox(--id--+-------------------+--)---------------><
+-,--attributeName--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectCheckBox</emphasis> method connects a check box in the underlying dialog, through
its resource ID, to a newly created data <link linkend="sctUnderstandingDataAttributes">attribute</link> in the Rexx
dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the check box control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<link linkend="termConnectAutoNames">automatically</link>/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the check box control manually. This can be done globally with the <xref
linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the
<xref linkend="mthSetCheckBoxData"/> or <xref linkend="mthGetCheckBoxData"/> methods. The <xref
linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods could also be used.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a check <xref linkend="clsCheckBox"/> is defined to be its
check state. For normal check boxes this is 0 for not checked and 1 for checked. Three-state check boxes have the
additional indeterminate state. The value for the indeterminate state is 2.
</para>
<para>
The <emphasis role="italic" >connectCheckBox</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection"/> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply
substitute a check box for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectCheckBox() -->
<section id="mthConnectComboBox" xreflabel="connectComboBox"><title>connectComboBox</title>
<indexterm><primary>connectComboBox</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectComboBox</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectComboBox(--id--+------------------+--)---------------><
+-,-attributeName--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectComboBox</emphasis> method creates a data <link
linkend="sctUnderstandingDataAttributes">attribute</link> in the Rexx dialog object and connects it to a
combo box control in the underlying dialog using its resource id.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the combo box control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<link linkend="termConnectAutoNames">automatically</link>.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the combo box control manually. This can be done globally with the <xref
linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref
linkend="mthSetComboBoxData"/> or <xref linkend="mthGetComboBoxData" />) methods. The <xref
linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods can also be used.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a combo <xref linkend="clsComboBox"/> is defined to be the
text in the selection field or the selected combo box item.
</para>
<para>
The <emphasis role="italic">connectComboBox</emphasis> should only be used when
<xref linkend="paraAutomaticDataDetection"/> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute
a combo box for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectComboBox() -->
<section id="mthConnectDateTimePicker" xreflabel="connectDateTimePicker"><title>connectDateTimePicker</title>
<indexterm><primary>connectDateTimePicker</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectDateTimePicker</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectDateTimePicker(--id--+------------------+--)---------><
+-,--attributeName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectDateTimePicker</emphasis> method connects a date time picker control in the
underlying dialog, through its resource ID, to a newly created data <xref linkend="sctUnderstandingDataAttributes"/>
in the Rexx dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the date time picker control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the date time control manually. This can be done globally with the
<xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer
grain of control use the <xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a date time <xref linkend="clsDateTimePicker"/> is
defined to be a <computeroutput>DateTime</computeroutput> object that represents it currently selected date and
time.
</para>
<para>
The <emphasis role="italic">connectDateTimePicker</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection"/> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply
substitute a date time picker for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectDateTimePicker() -->
<section id="mthConnectEdit" xreflabel="connectEdit"><title>connectEdit</title>
<indexterm><primary>connectEdit</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectEdit</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectEdit(--id--+------------------+--)----><
+-,--attributeName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectEdit</emphasis> method creates a new data
<xref linkend="sctUnderstandingDataAttributes"/> attribute in the Rexx dialog object and connects it to the underlying
edit control using its resource id.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the edit control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the edit control manually. This can be done globally with the <xref
linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref
linkend="mthSetEditData"/> or <xref linkend="mthGetEditData"/> methods. The <xref linkend="mthSetDataAttribute"/> or
<xref linkend="mthGetDataAttribute"/> methods can also be used.
</para>
<para>
The <emphasis role="italic">data</emphasis> of an edit control is defined to be the text entered in the control.
If there is no text, the data is the empty string.
</para>
<para>
The <emphasis role="italic">connectEdit</emphasis> should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry id="exampleConnectEdit"><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
In the following example, the edit control with symbolic resource ID IDC_EDIT is connected to the Rexx dialog
object's <emphasis role="italic">NAME</emphasis> attribute. The connection process creates the data attribute. The
string: <emphasis role="italic">Put your name here</emphasis> is assigned to the newly created data attribute. When
the dialog is executed, the underlying edit control is manually synchronized with the attribute. This has the
effect of setting the text of the edit control to the value of the attribute, which is the string, Put your name
here.
</para>
<para>
When the dialog is closed by the user with an <emphasis role="italic">ok</emphasis> command, the data attribute is
manually synchronized with the state of the edit control. The state of an edit control is defined to be the text
within the control. This synchronization has the effect of copying whatever text is in the edit control to the data
attribute. Then, when the dialog has terminated, the name the user entered is displayed. (Of course the user may not
have entered her name. What is displayed is whatever the text in the edit control was when the dialog was closed.)
<programlisting>
<![CDATA[
dlg = .NameDlg~new("nameExample.dll", IDD_DIALOG1, , "nameExample.h" )
if dlg~initCode == 0 then do
dlg~noAutoDetection
dlg~connectEdit(IDC_EDIT, "NAME")
dlg~name = "Put your name here"
ret = dlg~execute("SHOWTOP", IDI_DLG_OOREXX)
if ret == 1 then say "The user's name is:" dlg~name
else say "The user canceled."
end
return 0
::requires "ooDialog.cls"
::class 'NameDlg' subclass ResDialog
::method initDialog
self~setDataAttribute("NAME")
::method ok
self~getDataAttribute("NAME")
self~ok:super
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectEdit() -->
<section id="mthConnectListBox" xreflabel="connectListBox"><title>connectListBox</title>
<indexterm><primary>connectListBox</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectListBox</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectListBox(--id--+-------------------+--)---------------><
+-,--attributeName--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectListBox</emphasis> method uses the resource ID of the control to connect a list box
in the underlying dialog to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in
the Rexx dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the list box to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the list box manually. This can be done globally with the
<xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain
of control use the <xref linkend="mthSetListBoxData"/> or the <xref linkend="mthGetListBoxData"/>. The <xref
linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods could also be used.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">single-selection</emphasis> <xref
linkend="clsListBox"/> is defined to be text of the selected item in the list box.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">multi-selection</emphasis> <xref
linkend="clsListBox"/> is defined to be a string containing the item numbers of its selected items,
separated by a blank. For a multi-selection list box the string could contain any number of list items depending
on what the user has selected, (for getting data,) or what the programmer is setting to be selected, (for setting
data.)
</para>
<para>
The <emphasis role="italic">connectListBox</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry id="exampleConnectListBoxSingle"><term><emphasis role="bold">Example Single Selection:</emphasis></term>
<listitem>
<para>
This example shows how to use the <emphasis role="italic">connectListBox</emphasis> method with a single-selection
list box. It is very similar to the <link linkend="exampleConnectEdit">example</link> for the <emphasis
role="italic">connectEdit</emphasis> method. The code can be copied and pasted into the appropriate files to create
a working example.
<programlisting>
<![CDATA[
/* singleSelection.rex */
dlg = .SingleSelectionDlg~new("singleSelection.rc", IDD_SINGLE_SELECTION_DLG, , "singleSelection.h" )
if dlg~initCode == 0 then do
dlg~noAutoDetection
dlg~connectListBox(IDC_LB_STATES, "LISTBOX")
dlg~listBox = "California"
ret = dlg~execute("SHOWTOP", IDI_DLG_OOREXX)
if ret == 1 then say "The user's home state is:" dlg~listBox
else say "The user canceled."
end
return 0
::requires "ooDialog.cls"
::class 'SingleSelectionDlg' subclass RcDialog
::method initDialog
states = self~getStateArray
listBox = self~newListBox(IDC_LB_STATES)
do state over states
listBox~add(state)
end
self~setDataAttribute("LISTBOX")
::method ok
self~getDataAttribute("LISTBOX")
self~ok:super
::method getStateArray private
a = .array~of(...)
return a
/* End of singleSelection.rex */
/* Place this code in a file named "singleSelection.h" */
#ifndef IDC_STATIC
#define IDC_STATIC (-1)
#endif
#define IDD_SINGLE_SELECTION_DLG 100
#define IDC_LB_STATES 1003
/* Place this code in a file called singleSelection.rc. Two lines will wrap below:
* The line that begins "STYLE DS_3DLOOK" is all one line until the line that
* begins with "CAPTION" Likewise the "LISTBOX" line is all one line until the
* "DEFPUSHBUTTON" line. These lines will need to be fixed after the copy and
* paste.
*/
#include <windows.h>
#include "singleSelection.h"
LANGUAGE 0, SUBLANG_NEUTRAL
IDD_SINGLE_SELECTION_DLG DIALOG 0, 0, 186, 148
STYLE DS_3DLOOK | DS_CENTER | DS_MODALFRAME | DS_FIXEDSYS | WS_VISIBLE | WS_BORDER | WS_CAPTION | WS_DLGFRAME | WS_POPUP | WS_SYSMENU
CAPTION "Home State"
FONT 8, "Ms Shell Dlg 2"
{
CTEXT "Select Your Home State", IDC_STATIC, 29, 12, 127, 11, SS_CENTER
LISTBOX IDC_LB_STATES, 25, 31, 137, 84, WS_TABSTOP | WS_VSCROLL | LBS_NOINTEGRALHEIGHT | LBS_SORT | LBS_NOTIFY
DEFPUSHBUTTON "OK", IDOK, 71, 124, 50, 14
PUSHBUTTON "Cancel", IDCANCEL, 126, 124, 50, 14
}
/* Use this code to replace the .array~of(...) statement in the Rexx program. */
a = .array~of( -
"Alabama", -
"Alaska", -
"American Samoa", -
"Arizona", -
"Arkansas", -
"California", -
"Colorado", -
"Connecticut", -
"Delaware", -
"District of Columbia", -
"Florida", -
"Georgia", -
"Guam", -
"Hawaii", -
"Idaho", -
"Illinois", -
"Indiana", -
"Iowa", -
"Kansas", -
"Kentucky", -
"Louisiana", -
"Maine", -
"Maryland", -
"Massachusetts", -
"Michigan", -
"Minnesota", -
"Mississippi", -
"Missouri", -
"Montana", -
"Nebraska", -
"Nevada", -
"New Hampshire", -
"New Jersey", -
"New Mexico", -
"New York", -
"North Carolina", -
"North Dakota", -
"Northern Marianas Islands", -
"Ohio", -
"Oklahoma", -
"Oregon", -
"Pennsylvania", -
"Puerto Rico", -
"Rhode Island", -
"South Carolina", -
"South Dakota", -
"Tennessee", -
"Texas", -
"Utah", -
"Vermont", -
"Virginia", -
"Virgin Islands", -
"Washington", -
"West Virginia", -
"Wisconsin", -
"Wyoming")
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry id="exampleConnectListBoxMulti"><term><emphasis role="bold">Example Mulit Selection:</emphasis></term>
<listitem>
<para>
This example shows how to use the <emphasis role="italic">connectListBox</emphasis> method with a multi-selection
list box. It is also very similar to the <link linkend="exampleConnectEdit">example</link> for the <emphasis
role="italic">connectEdit</emphasis> method.
<programlisting>
<![CDATA[
/* multiSelection.rex */
dlg = .MultiSelectionDlg~new("multiSelection.rc", IDD_MULTI_SELECTION_DLG, , "multiSelection.h" )
if dlg~initCode == 0 then do
dlg~noAutoDetection
dlg~connectListBox(IDC_LB_STATES, "LISTBOX")
dlg~listBox = "4 6 7 49"
ret = dlg~execute("SHOWTOP", IDI_DLG_OOREXX)
if ret == 1 then do
indexes = dlg~listBox~makeArray(" ")
states = getStateArray()
say "The user has visited these states:"
do index over indexes
say " " states[index]
end
end
else do
say "The user canceled."
end
end
return 0
::requires "ooDialog.cls"
::class 'MultiSelectionDlg' subclass RcDialog
::method initDialog
states = getStateArray()
listBox = self~newListBox(IDC_LB_STATES)
do state over states
listBox~add(state)
end
self~setDataAttribute("LISTBOX")
::method ok
self~getDataAttribute("LISTBOX")
self~ok:super
::routine getStateArray public
a = .array~of(...)
return a
/* Place this code in a file called multiSelection.rc. Two lines will wrap below:
* The line that begins "STYLE DS_3DLOOK" is all one line until the line that
* begins with "CAPTION" Likewise the "LISTBOX" line is all one line until the
* "DEFPUSHBUTTON" line. These lines will need to be fixed after the copy and
* paste.
*/
#include <windows.h>
#include "multiSelection.h"
LANGUAGE 0, SUBLANG_NEUTRAL
IDD_MULTI_SELECTION_DLG DIALOG 0, 0, 186, 148
STYLE DS_3DLOOK | DS_CENTER | DS_MODALFRAME | DS_FIXEDSYS | WS_VISIBLE | WS_BORDER | WS_CAPTION | WS_DLGFRAME | WS_POPUP | WS_SYSMENU
CAPTION "Visted States"
FONT 8, "Ms Shell Dlg 2"
{
CTEXT "Select the states you've visited", IDC_STATIC, 29, 12, 127, 11, SS_CENTER
LISTBOX IDC_LB_STATES, 25, 31, 137, 84, WS_TABSTOP | WS_VSCROLL | LBS_MULTIPLESEL | LBS_NOINTEGRALHEIGHT | LBS_SORT | LBS_NOTIFY
DEFPUSHBUTTON "OK", IDOK, 71, 124, 50, 14
PUSHBUTTON "Cancel", IDCANCEL, 126, 124, 50, 14
}
/* Place this code in a file called multiSelection.h */
/* Use this code to replace the .array~of(...) statement in the Rexx program. */
a = .array~of( -
"Alabama", -
"Alaska", -
"American Samoa", -
"Arizona", -
"Arkansas", -
"California", -
"Colorado", -
"Connecticut", -
"Delaware", -
"District of Columbia", -
"Florida", -
"Georgia", -
"Guam", -
"Hawaii", -
"Idaho", -
"Illinois", -
"Indiana", -
"Iowa", -
"Kansas", -
"Kentucky", -
"Louisiana", -
"Maine", -
"Maryland", -
"Massachusetts", -
"Michigan", -
"Minnesota", -
"Mississippi", -
"Missouri", -
"Montana", -
"Nebraska", -
"Nevada", -
"New Hampshire", -
"New Jersey", -
"New Mexico", -
"New York", -
"North Carolina", -
"North Dakota", -
"Northern Marianas Islands", -
"Ohio", -
"Oklahoma", -
"Oregon", -
"Pennsylvania", -
"Puerto Rico", -
"Rhode Island", -
"South Carolina", -
"South Dakota", -
"Tennessee", -
"Texas", -
"Utah", -
"Vermont", -
"Virginia", -
"Virgin Islands", -
"Washington", -
"West Virginia", -
"Wisconsin", -
"Wyoming")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectListBox() -->
<section id="mthConnectListView" xreflabel="connectListView"><title>connectListView</title>
<indexterm><primary>connectListView</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectListView</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectListView(--id--+------------------+--)---------------><
+-,--attributeName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectListView</emphasis> method connects a list view in the underlying dialog, through
its resource ID, to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in the Rexx
dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the list view control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the list view control manually. This can be done globally with the <xref
linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref
linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a list <xref linkend="clsListView"/> is defined to be a
string containing the blank seperated index(es) of its selected item(s).
</para>
<para>
The <emphasis role="italic">connectCheckBox</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link>/> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute
a list view for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectListView() -->
<section id="mthConnectMonthCalendar" xreflabel="connectMonthCalendar"><title>connectMonthCalendar</title>
<indexterm><primary>connectMonthCalendar</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectMonthCalendar</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectMonthCalendar(--id--+------------------+--)----------><
+-,--attributeName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectMonthCalendar</emphasis> method connects a month calendar control in the underlying
dialog, through its resource ID, to a newly created data <xref linkend="sctUnderstandingDataAttributes"/>
in the Rexx dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the month calendar control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the month calendar control manually. This can be done globally with the
<xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain
of control use the <xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a <xref linkend="clsMonthCalendar"/> is defined to be a
<computeroutput>DateTime</computeroutput> object that specifies the selected date in the month calendar control.
</para>
<para>
The <emphasis role="italic">connectMonthCalendar</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link>/> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute
a month calendar control for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectMonthCalendar() -->
<section id="mthConnectRadioButton" xreflabel="connectRadioButton"><title>connectRadioButton</title>
<indexterm><primary>connectRadioButton</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectRadioButton</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectRadioButton(--id--+-------------------+--)-----------><
+-,--attributeName--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectRadioButton</emphasis> method uses the resource id of a radio button control to
connect the control in the underlying dialog to a newly created data<xref linkend="sctUnderstandingDataAttributes"/> in
the Rexx dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the radio button control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the radio button control manually. This can be done globally with the
<xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain
of control use the <xref linkend="mthSetRadioButtonData"/> or <xref linkend="mthGetRadioButtonData"/> methods. The
<xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods can also be used.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a <xref linkend="clsRadioButton"/> is defined to be the its check state.
This is 0 for not checked and 1 for checked.
</para>
<para>
The <emphasis role="italic">connectRadioButton</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link>/> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute
a radio button control for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectRadioButton() -->
<section id="mthConnectTab" xreflabel="connectTab"><title>connectTab</title>
<indexterm><primary>connectTab</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectTab</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectTab(--id--+------------------+--)-----><
+-,--attributeName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectTab</emphasis> method uses the resource id of a tab control to connect the control
in the underlying dialog to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in
the Rexx dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the tab control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the tab control manually. This can be done globally with the
<xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain
of control use the <xref linkend="mthSetDataAttribute"/> or<xref linkend="mthGetDataAttribute"/> methods.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a <xref linkend="clsTab"/> control is defined to the text
of its currently selected tab.
</para>
<para>
The <emphasis role="italic">connectTab</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute
a tab control for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectTab() -->
<section id="mthConnectTrackBar" xreflabel="connectTrackBar"><title>connectTrackBar</title>
<indexterm><primary>connectTrackBar</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectTrackBar</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectTrackBar(--id--+------------------+--)---------------><
+-,--attributeName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectTrackBar</emphasis> method uses the resource id of a trackbar control to connect
the control in the underlying dialog to a newly created data <xref linkend="sctUnderstandingDataAttributes"/>
in the Rexx dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the trackbar control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the trackbar control manually. This can be done globally with the <xref
linkend="mthSetData" /> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref
linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a <xref linkend="clsTab"/> control is defined to be
the current logical position of the slider in the trackbar.
</para>
<para>
The <emphasis role="italic">connectTab</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute
a trackbar control for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectTrackBar() -->
<section id="mthConnectTreeView" xreflabel="connectTreeView"><title>connectTreeView</title>
<indexterm><primary>connectTreeView</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectTreeView(--id--+------------------+--)---------------><
+-,--attributeName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectTreeView</emphasis> method creates a data <xref
linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object and connects it to a tree view control in the
underlying dialog using its resource id.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the tree view control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the tree view control manually. This can be done globally with the <xref
linkend="mthSetData" /> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref
linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a tree <xref linkend="clsTreeView"/> is defined to be the
text of the selected tree view item.
</para>
<para>
The <emphasis role="italic">connectTreeview</emphasis> should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link>/> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute
a tree view for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectTreeView() -->
<section id="mthConnectUpDown" xreflabel="connectUpDown"><title>connectUpDown</title>
<indexterm><primary>connectUpDown</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectUpDown</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectUpDown(--id--+------------------+--)--><
+-,--attributeName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectUpDown</emphasis> method connects an up down control in the underlying dialog,
through its resource ID, to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in
the Rexx dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the up down control to be connected. Can be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>attributeName [optional]</term>
<listitem>
<para>
The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is
<xref linkend="termConnectAutoNames"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The data attribute was created but it was not connected. (The data connection table is full.)
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attribute has to be synchronized with the up down control manually. This can be done globally with the
<xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain
of control use the <xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a up <xref linkend="clsUpDown"/> control is defined to be
the value of its current position.
</para>
<para>
The <emphasis role="italic">connectUpDown</emphasis> method should only be used when
<xref linkend="paraAutomaticDataDetection" /> is off.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method
demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute
an up down control for the edit control.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog object::connectUpDown() -->
</section> <!-- End Connect Attribute Methods Section -->
<section id="mthGetCheckBoxData" xreflabel="getCheckBoxData"><title>getCheckBoxData</title>
<indexterm><primary>getCheckBoxData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getCheckBoxData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getCheckBoxData(--id--)----------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getCheckBoxData</emphasis> method gets the data <xref
linkend="sctUnderstandingDataAttributes"/> of a check box.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the check box. May be numeric or symbolic.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">data</emphasis> of a check box is considered to be whether it is checked or not. If the
check box is checked the return is 1 and if unchecked the return is 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The check box <emphasis role="bold">should</emphasis> have been previously connected to a data attribute. If it has
not, or if the resource ID is not the ID of a check box, the results are unpredictable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetComboBoxData" xreflabel="getComboBoxData"><title>getComboBoxData</title>
<indexterm><primary>getComboBoxData</primary></indexterm>
<programlisting>
<![CDATA[
>>--getComboBoxData(--id--)----------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getComboBoxData</emphasis> method gets the data <xref
linkend="sctUnderstandingDataAttributes"/> of a combo box.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the combo box. May be numeric or symbolic.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">data</emphasis> of a combo box is considered to be the text of the selection field in
the combo <xref linkend="clsComboBox"/>. The current text in the selection field is returned, which may be
the empty string if there is no text in the selection field.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The combo box <emphasis role="bold">should</emphasis> have been previously connected to a data attribute. If it has
n0t, or if the resource ID is not the ID of a combo box, the results are unpredictable.
</para>
<para>
For drop down list combo boxes, the text in the selection field is the same as the text of the current selection.
The text returned may still be the empty string if there is no current selection.
</para>
<para>
However, for simple and drop down combo boxes things are not so simple. The text in the selection field could be
text the user typed in and there may be no current selection. Or, for these types of combo boxes, there might be a
current selection, but the user may have edited the text in the selection field so that it no longer matches the
text of the current selection.
</para>
<para>
To get the index of the current selection, use the <xref linkend="mthGetCurrentComboIndex"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetControlData" xreflabel="getControlData"><title>getControlData</title>
<indexterm><primary>getControlData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getControlData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getControlData(--id--)-----------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getControlData</emphasis> method gets the data <xref
linkend="sctUnderstandingDataAttributes"/> of a dialog control, regardless of the type of the control. The control
<emphasis role="bold">should</emphasis> have been previously connected to a data attribute.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the dialog control. May be symbolic or numeric.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return Value:</emphasis></term>
<listitem>
<para>
The return will be the <emphasis role="italic">value</emphasis> of the control data. This is dependent on the type
of the control. For an edit control it will be the text entered in the control, for a radio button it will be 0 or
1, depending on if the radio button is unchecked or checked, for a tree view it will be the text of the selected
item in the tree, etc.. The defined value for the <emphasis role="italic">data</emphasis> of any dialog control is
documented in the <xref linkend="sctConnectDataMethods"/> method for the control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
If the control has not been previously connected to a data attribute, the implementation of this method assumes the
control is an edit control and returns the text of the control. Since all windows have text value, which may be the
empty string, this is okay. However this is not the intent of this method. The method is intended to only be used
with controls connected to a data attribute.
</para>
<para>
It appears that the original intent of this method was to be used for controls such as tree views, list views, tabs,
etc.. When these controls were added to ooDialog, no corresponding getTreeViewData(), getProgressBarData(), etc.,
methods were implemented. The generic <emphasis role="italic">getControlData</emphasis>() method works for all
connected controls, but it works best if the programmer knows the type of control.
</para>
<para>
A better method to use, if the programmer is insistent on thinking in terms of data attributes, is probably to use
the <xref linkend="mthData"/> method of the dialog <xref linkend="chpDialogControlObject"/> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetData" xreflabel="getData"><title>getData</title>
<indexterm><primary>getData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getData--------------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getData</emphasis> method sets the Rexx dialog data <xref
linkend="sctUnderstandingDataAttributes"/> values to the state of the underlying, connected,
dialog controls.
</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>
0 on success or 1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example continues the <xref linkend="mthSetData"/> example:
<programlisting>
<![CDATA[
.
.
.
dialog~connectEdit(102, "EDIT_1")
dialog~connectCheckBox(201, )
dialog~ConnectListbox(203, "LISTBOX_DAYS")
.
.
.
/* process the dialog */
.
.
.
dialog~getData /* set data attributes to the state of the dialog controls */
say dialog~EDIT_1
say dialog~DATA201
say dialog~LISTBOX_DAYS
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetDataAttribute" xreflabel="getDataAttribute"><title>getDataAttribute</title>
<indexterm><primary>getDataAttribute</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getDataAttribute</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getDataAttribute(--attributeName--)----------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getDataAttribute</emphasis> method transfers the data of a dialog control to the
connected data <xref linkend="sctUnderstandingDataAttributes"/> of the Rexx dialog object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>attributeName [required]</term>
<listitem>
<para>
The name of the data attribute that receives the data of the underlying dialog control.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The terms <emphasis role="italic">transfers</emphasis> and <emphasis role="italic">receives</emphasis> the data are
holdovers from the original documentation and the original data <xref linkend="sctUnderstandingDataAttributes"/>
abstraction. What the <emphasis role="italic">getDataAttribute</emphasis> method actually does is to set the value of the
connected data attribute to the defined value of the underlying dialog control. The defined value for the <emphasis
role="italic">data</emphasis> of any dialog control is documented in the <xref linkend="sctConnectDataMethods"/> method
for the control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example shows how to get the data of a dialog control and synchronize its connected data
attribute.
<programlisting>
<![CDATA[
self~getDataAttribute("FIRSTNAME")
if self~firstName \= "" then ...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetDataStem" xreflabel="getDataStem"><title>getDataStem</title>
<indexterm><primary>getDataStem</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getDataStem</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getDataStem(--dataStem.--)-------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getDataStem</emphasis> method is the reverse of the <xref linkend="mthSetDataStem"/> method.
The method gets the <emphasis role="italic">data</emphasis> of all the dialog controls in the underlying dialog that have
been connected to a data <xref linkend="sctUnderstandingDataAttributes"/> of the Rexx dialog object. The data of each
control is copied to the specified stem.
</para>
<para>
A stem index for each connected control is set. The stem index is the numeric ID for the control. The value at that
index is the data of the matching dialog control. In addition, if the <xref linkend="atrConstDir"/>
directory has a symbolic ID for the numeric ID of the control, a stem index of the symbolic ID is also set. This of
course only works reliably if the Rexx programmer uses unique numeric IDs for all resouces.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>dataStem. [required]</term>
<listitem>
<para>
The name of a stem variable in which the data is returned. Remember the trailing period.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetEditData" xreflabel="getEditData"><title>getEditData</title>
<indexterm><primary>getEditData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getEditData</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aBaseDialog~getEditData(--id--)----------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getEditData</emphasis> method gets the data <xref linkend="sctUnderstandingDataAttributes"/>
of an edit control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the edit control. May be numeric or symbolic.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">data</emphasis> of an edit control is considered to the text entered in the control.
This method returns the text in the edit control, which may be the empty string if the user has not entered any
text.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The edit control <emphasis role="bold">should</emphasis> have been previously connected to a data attribute. If it
has not, or if the resource ID is not the ID of a edit control, the results are unpredictable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetListBoxData" xreflabel="getListBoxData"><title>getListBoxData</title>
<indexterm><primary>getListBoxData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getListBoxData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getListBoxData(--id--)-----------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getListBoxData</emphasis> method gets the data <xref linkend="sctUnderstandingDataAttributes"/>
of a list box.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the list box. May be numeric or symbolic.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
For a single-selection list box, the <emphasis role="italic">data</emphasis> of the list box is considered to be the
text of the selected item. The text of the selected item is returned, or the empty string if no item is selected.
</para>
<para>
However, for a multi-selection list box, the <emphasis role="italic">data</emphasis> is considered to be the index
numbers of the selected items. The selected indexes are returned in a string with the indexes separated by spaces.
If no item is selected then the empty string is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The list box <emphasis role="bold">should</emphasis> have been previously connected to a data attribute. If it has
not, or if the resource ID is not the ID of a list box, the results are unpredictable.
</para>
<para>
For a multi-selection list box, the string is restricted to 1500 indexes.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example shows how to handle a multiple-selection list box. It parses the returned string as long as it
contains an index.
<programlisting>
<![CDATA[
selLines = MyDialog~getListBoxData(555)
do until selLines = ""
parse var selLines aLine selLines
say aLine
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthGetRadioButtonData" xreflabel="getRadioButtonData"><title>getRadioButtonData</title>
<indexterm><primary>getRadioButtonData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getRadioButtonData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getRadioButtonData(--id--)-------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">getRadioButtonData</emphasis> method gets the data <xref
linkend="sctUnderstandingDataAttributes"/> of a a radio button.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the radio button. May be numeric or symbolic.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">data</emphasis> of a radio button is considered to be whether it is checked or not. If
it is checked the return is 1 and if unchecked the return is 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The radio button <emphasis role="bold">should</emphasis> have been previously connected to a data attribute. If it
hasn't, or if the resource ID is not the ID of a radio button, the results are unpredictable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthInitAutoDetection" xreflabel="initAutoDetection"><title>initAutoDetection</title>
<indexterm><primary>initAutoDetection</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>initAutoDetection</secondary></indexterm>
<programlisting>
<![CDATA[
>>-initAutoDetection---------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">initAutoDetection</emphasis> method is invoked automatically by the ooDialog framework
when any dialog is first instantiated. The default implementation of <emphasis
role="italic">initAutoDetection</emphasis> turns <xref linkend="paraAutomaticDataDetection"/> on.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method does not return anything.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method is private. It is meant to be over-ridden by the programmer in her subclass to change the default
behavior of turning automatic data field detection on.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example overrides <emphasis role="italic">initAutoDetection</emphasis> method to switch off auto
detection:
<programlisting>
<![CDATA[
::class 'AddressBookDialog' subclass ResDialog
::method initAutoDetection
self~noAutoDetection
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthNoAutoDetection" xreflabel="noAutoDetection"><title>noAutoDetection</title>
<indexterm><primary>noAutoDetection</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>noAutoDetection</secondary></indexterm>
<programlisting>
<![CDATA[
>>--noAutoDetection------------------------------><
]]>
</programlisting>
<para>
When the <emphasis role="italic">noAutoDetection</emphasis> method is invoked, it switches off
<xref linkend="paraAutomaticDataDetection"/>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method does not return anything.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetCheckBoxData" xreflabel="setCheckBoxData"><title>setCheckBoxData</title>
<indexterm><primary>setCheckBoxData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setCheckBoxData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setCheckBoxData(--id--,--data--)-------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setCheckBoxData</emphasis> method sets the data <xref
linkend="sctUnderstandingDataAttributes"/> of a check box control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the check box. May be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>data [required]</term>
<listitem>
<para>
The <emphasis role="italic">data</emphasis> to be assigned to the underlying check box. The <emphasis
role="italic">data</emphasis> of a check <xref linkend="clsCheckBox"/> is defined to be its check state.
For normal check boxes this is 0 for not checked and 1 for checked. Three-state check boxes have the additional
indeterminate state. The value for the indeterminate state is 2.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An error occurred.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method will work for any check box control, the underlying control does not <emphasis
role="italic">have</emphasis> to be connected to a data attribute. However, the <emphasis
role="italic">id</emphasis> argument must be the resource ID of a check box control. If it is not, say it is the
resource ID of a list view control, the results are unpredictable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetComboBoxData" xreflabel="setComboBoxData"><title>setComboBoxData</title>
<indexterm><primary>setComboBoxData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setComboBoxData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setComboBoxData(--id--,--data--)-------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setComboBoxData</emphasis> method sets the data <xref
linkend="sctUnderstandingDataAttributes"/> of a combo box control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the combo box control. May be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>data [required]</term>
<listitem>
<para>
The <emphasis role="italic">data</emphasis> to be assigned to the underlying combo box control. The <emphasis
role="italic">data</emphasis> of a combo <xref linkend="clsComboBox"/> is defined to be the text in the
selection field or the selected combo box item.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An error occurred.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method will work for any combo box control, the underlying control does not <emphasis
role="italic">have</emphasis> to be connected to a data attribute. However, the <emphasis
role="italic">id</emphasis> argument must be the resource ID of a combo box control. If it is not, say it is the
resource ID of an edit control, the results are unpredictable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetControlData" xreflabel="setControlData"><title>setControlData</title>
<indexterm><primary>setControlData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setControlData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setControlData(--id--,--dataValue--)---------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setControlData</emphasis> method sets the data <xref linkend="sctUnderstandingDataAttributes"/>
of a dialog control. The programmer does not have to know what kind of control it is.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the dialog control. May be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>dataValue [required]</term>
<listitem>
<para>
The data that is assigned to the control. The format <emphasis role="bold">should</emphasis> match the type of
the control.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An error occurred.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The dialog control <emphasis role="bold">should</emphasis> have been previously connected to a data attribute. If
the control has not been previously connected to a data attribute, the implementation of this method assumes the
control is an edit control and sets the text of the control to <emphasis role="italic">dataValue</emphasis>. Since
all windows can have their text set, this may be okay. However the outcome is dependent on the type of control.
Setting the text of a check box will change its label, setting the text of a tree view control will do nothing. The
method is intended to only be used with controls connected to a data attribute.
</para>
<para>
Likewise, if the format of <emphasis role="italic">dataValue</emphasis> does not match the type of control, the
results are unpredictable. It appears that the original intent of this method was to be used for controls such as
tree views, list views, tabs, etc.. When these controls were added to ooDialog, no corresponding setTreeViewData(),
setTabData(), etc., methods were implemented. The generic <emphasis role="italic">setControlData</emphasis>() method
works for all connected controls, but it works best if the programmer knows the type of control.
</para>
<para>
A better method to use, if the programmer is insistent on thinking in terms of data attributes, is probably to use
the <xref linkend="mthDataEquals"/> method of the dialog <xref linkend="chpDialogControlObject"/> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example sets dialog control with resource ID of 123 to the (string) data &quot;1 2 3&quot;. This is
meaningful if the control is an edit control, or if it is a list box that contains the line &quot;1 2 3&quot;.
However, for other controls it is probably meaningless.
<programlisting>
<![CDATA[
MyDialog~setControlData(123, "1 2 3")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetData" xreflabel="setData"><title>setData</title>
<indexterm><primary>setData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setData--------------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setData</emphasis> method sets the state of all underlying, connected, dialog controls to
the values of the matching dialog object data <xref linkend="sctUnderstandingDataAttributes"/>s.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method takes no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
0 on success, otherwise 1.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
<emphasis role="bold">Note</emphasis> that this method sets the state for every connected attribute. This may not
always be desirable. For instance the focused node of a tree-view control may be changed. For finely grained control
of which dialog controls have their state set, the programmer should use the <xref linkend="mthSetControlData"/> or
<xref linkend="mthSetDataAttribute"/> methods. Both of these methods transfer the value of a single object attribute that
is specified by the programmer.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
Dialog items with ID 102, 201 and 203 are connected to the attributes <computeroutput>EDIT_1</computeroutput>,
<computeroutput>DATA201</computeroutput>, and <computeroutput>LISTBOX_DAYS</computeroutput>. Attribute
<computeroutput>DATA201</computeroutput> is generated by the connectCheckBox method. Then the attributes are
initialized with some values. This does not change the state of the controls in the dialog until the <emphasis
role="italic">setData</emphasis> method is invoked.
<programlisting>
<![CDATA[
. .
.
dialog~connectEdit(102, "EDIT_1")
dialog~connectCheckBox(201,)
dialog~ConnectListbox(203, "LISTBOX_DAYS")
.
.
.
dialog~EDIT_1 = "Memorial Day"
dialog~DATA201 = 1
dialog~LISTBOX_DAYS = "Monday"
dialog~setData
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetDataAttribute" xreflabel="setDataAttribute"><title>setDataAttribute</title>
<indexterm><primary>setDataAttribute</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setDataAttribute</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setDataAttribute(--attributeName--)----------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setDataAttribute</emphasis> method transfers the value of a connected data <xref
linkend="sctUnderstandingDataAttributes"/> of the Rexx dialog object to the underlying dialog
control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>attributeName [required]</term>
<listitem>
<para>
The name of the data attribute whose value is transferred to the underlying dialog control.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An error occurred.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The terms <emphasis role="italic">transfers</emphasis> and <emphasis role="italic">receives</emphasis> the data are
holdovers from the original documentation and the original data <xref linkend="sctUnderstandingDataAttributes"/>
abstraction. What the <emphasis role="italic">setDataAttribute</emphasis> method actually does is to set the state of the
underyling dialog control to the value of the connected data attribute. The defined value for the <emphasis
role="italic">data</emphasis> of any dialog control is documented in the <xref linkend="sctConnectDataMethods"/> method
for the control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example sets the state the of the connected dialog control to the value of the data attribute DATA101:
to
<programlisting>
<![CDATA[
self~setDataAttribute("DATA101")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetDataStem" xreflabel="setDataStem"><title>setDataStem</title>
<indexterm><primary>setDataStem</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setDataStem</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setDataStem(--dataStem.--)-------------------><
]]>
</programlisting>
<para>
Sets the <emphasis role="italic">data</emphasis>, (the state,) of a number of Windows dialog controls to the values
specified by the stem. Each index of <emphasis role="italic">dataStem.</emphasis> is the resource ID of a dialog
control. The control with that ID, within the dialog, has its state set to match the value of the stem variable at
that index. The resource ID can be specified using either numeric resource IDs or symbolic resource IDs.
</para>
<para>
This method only works for controls that have been connected to a <link
linkend="sctUnderstandingDataAttributes">data</link> attributue. Either by <xref
linkend="paraAutomaticDataDetection"/>, or through one of the
<xref linkend="sctConnectDataMethods"/>) methods. Every connected control has its state set when this method is invoked.
If the data stem, <emphasis role="italic">data.</emphasis> has no matching index for a connected control, that control's
state is set to the empty string. Any indexes in the data stem that do not match the resource ID of a registered control
are ignored.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>dataStem. [required]</term>
<listitem>
<para>
A stem variable containing the values used to set a dialog control's state. Remember the trailing period.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method does not return a value.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example initializes the dialog controls with IDs 21, 22, and 23, provided they have been connected
previously:
<programlisting>
<![CDATA[
.
.
.
dlgStem.21="Windows 95"
dlgStem.22="0"
dlgStem.23="1 2 3"
self~setDataStem(dlgStem.)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetEditData" xreflabel="setEditData"><title>setEditData</title>
<indexterm><primary>setEditData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setEditData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setEditData(--id--,--data--)-----------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setEditData</emphasis> method sets the data <xref linkend="sctUnderstandingDataAttributes"/>
of an edit control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the edit control. May be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>data [required]</term>
<listitem>
<para>
The <emphasis role="italic">data</emphasis> to be assigned to the underlying edit control. The <emphasis
role="italic">data</emphasis> of an edit control is defined to be the text entered in the control. If there is no
text, the data is the empty string.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An error occurred.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method will work for any edit control, the underlying control does not <emphasis role="italic">have</emphasis>
to be connected to a data attribute. However, the <emphasis role="italic">id</emphasis> argument must be the
resource ID of an edit control. If it is not, say it is the resource ID of a radio button control, the results are
unpredictable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
Assume that three methods are connected to push buttons. The <emphasis role="italic">setToDefault</emphasis> method
sets the text in the underlying edit control with resource ID of 234 to the value <emphasis
role="italic">256</emphasis>. But, it does not change the edit control's connected attribute. Using <emphasis
role="italic">setEditData</emphasis> has the same effect as the user typing text into the edit control. The
connecte attribute in the Rexx dialog object (<computeroutput>DATA234</computeroutput>) still has the original
value. Thus it is possible to undo the changes, (using the <emphasis role="italic">unDoChanges</emphasis> method,)
or to accept the changes, (using the <emphasis role="italic">accetpValues</emphasis> method.)
<programlisting>
<![CDATA[
::method setToDefault
self~setEditData(234, "256")
::method acceptValues
self~getDataAttribute(DATA234)
::method undoChanges
self~setDataAttribute(DATA234)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetListBoxData" xreflabel="setListBoxData"><title>setListBoxData</title>
<indexterm><primary>setListBoxData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setListBoxData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setListBoxData(--id--,--data--)--------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setListBoxData</emphasis> method sets the data <xref linkend="sctUnderstandingDataAttributes"/>
of the underly list box to the value specified.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the list box. May be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>data [required]</term>
<listitem>
<para>
The data that is assigned to the list box. The <emphasis role="italic">data</emphasis> of a <emphasis
role="bold">single-selection</emphasis> list <xref linkend="clsListBox"/> is defined to be text of the
selected item in the list box.
</para>
<para>
The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">multi-selection</emphasis> <xref
linkend="clsListBox"/> is defined to be a string containing the item numbers of its selected items,
separated by a blank. For a multi-selection list box the string could contain any number of list items depending
on what the programmer is setting to be selected.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An error occurred.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method will work for any list box control, the underlying control does not <emphasis
role="italic">have</emphasis> to be connected to a data attribute. However, the <emphasis
role="italic">id</emphasis> argument must be the resource ID of a list box control. If it is not, say it is the
resource ID of a list view control, the results are unpredictable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example is for a single-selection list box. It selects the item whose text is &quot;New York&quot;,
case insensitive, in the list box with a resource ID of 232:
<programlisting>
<![CDATA[
MyBaseDialog~setListBoxData(232, "New York")
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example selects items 2, 5, and 6 of the multi-selection list box with a resource ID of 345:
<programlisting>
<![CDATA[
MyDialog~setListBoxData(345, "2 5 6")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthSetRadioButtonData" xreflabel="setRadioButtonData"><title>setRadioButtonData</title>
<indexterm><primary>setRadioButtonData</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setRadioButtonData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setRadioButtonData(--id--,--data--)----------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setRadioData</emphasis> method sets the data <xref linkend="sctUnderstandingDataAttributes"/>
of a radio button control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the radio button. May be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>data [required]</term>
<listitem>
<para>
The <emphasis role="italic">data</emphasis> to be assigned to the underlying radio button. The <emphasis
role="italic">data</emphasis> of a radio <xref linkend="clsRadioButton"/> is defined to be the its
check state. This is 0 for not checked and 1 for checked.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
A symbolic ID was used and it could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An error occurred.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method will work for any radio button control, the underlying control does not <emphasis
role="italic">have</emphasis> to be connected to a data attribute. However, the <emphasis
role="italic">id</emphasis> argument must be the resource ID of a radio button control. If it is not, say it is the
resource ID of a list view control, the results are unpredictable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if
the underlying dialog does not exist.
</para>
</listitem></varlistentry>
</variablelist>
</section>
</section>