[r8985]: docs / trunk / oodialog / en-US / userInput.xml Maximize Restore History

Download this file

userInput.xml    5840 lines (5434 with data), 212.8 kB

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "oodialog.ent">
%BOOK_ENTITIES;
]>
<!--#########################################################################
#
# Description: Open Object Rexx: ooDialog Reference XML file.
#
# Copyright (c) 2005-2013 Rexx Language Association. All rights reserved.
# Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
# distribution. A copy is also available at the following address:
# http://www.oorexx.org/license.html
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the distribution.
#
# Neither the name of Rexx Language Association nor the names
# of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#########################################################################
-->
<chapter id="chapUserInput"><title>User Input</title>
<indexterm><primary>User Input</primary></indexterm>
<para>
Capturing user input is normally an important part of any program. In one sense, the ooDialog framework is almost
completely about capturing user input as that is the primary role of a dialog.
</para>
<para>
The following table lists the general categories of user input in the Windows operating system, as described by the
Windows documentation. Several of the categories have no current implmentation in ooDialog, or the implementation
is scatterd throughout the <xref linkend="chpDialogObject"/> and dialog
<xref linkend="chpDialogControlObject"/> classes. These categories are mentioned here for completeness. Future versions of
ooDialog may be enhanced to address those categories.
<table id="tblUserInputClasses" frame="all"> <title>ooDialog User Input Groups</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="4*" />
<thead>
<row>
<entry>User Input</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><xref linkend="sctCommonDialogLibrary"/></entry>
<entry>Objects and routines used to easily gather user input in a standard way.</entry>
</row>
<row>
<entry>Keyboard Accelerators</entry>
<entry>Keyboard accelerators are keystrokes or combination of keystrokes that generate a command notification for a program.</entry>
</row>
<row>
<entry><xref linkend="clsKeyboard"/> Input</entry>
<entry>The operating system generates keyboard input from the physical keyboard and provides the means for a program to receive and process that input. ooDialog has the <computeroutput>Keyboard</computeroutput> class to deal with functionality related to the keyboard. However, for historic reasons some of the keyboard related function is scattered throughout the the dialog and dialog control classes.</entry>
</row>
<row>
<entry><xref linkend="clsMouse"/> Input</entry>
<entry>The mouse is an important, but optional, input device for programs. ooDialog programs deal with mouse input primarily through the <computeroutput>Mouse</computeroutput> class</entry>
</row>
<row>
<entry>Raw Input</entry>
<entry>
There are many user input devices beside the traditional keyboard and mouse, such as a joystick or touchpad. The operating system provides a generalized means for programs to receive and process
that input.
</entry>
</row>
</tbody></tgroup>
</table>
</para>
<section id="sctCommonDialogLibrary" xreflabel="Common Dialog Library"><title>Common Dialog Library</title>
<indexterm><primary>Common Input Dialogs and Routines</primary></indexterm>
<para>
The ooDialog framework provides a number of easy to use dialogs and routines that obtain user input in common
scenarios. These dialogs and routines allow programmers to include simple graphical elements in their Rexx
applications and collect user input in a standard way. The public routines can be called with a single line of code
and the standard dialogs can usually be executed with only two lines of code. This does not require the programmer to
do much set up and makes them simple to work with.
</para>
<section id="sctStandardClassesRoutines"><title>Class and Routine Table</title>
<para>
The common dialogs and routines are listed the following table:
</para>
<table id="tStandardElements" frame="all">
<title>Common Dialog Classes and Public Routines</title>
<tgroup cols="2">
<colspec colwidth="11*" />
<colspec colwidth="32*" />
<thead>
<row>
<entry>Class / Routine</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><xref linkend="rtnAskDialog"/> routine</entry>
<entry>Pops up a message box containing the specified question, a Yes, and a No push button.</entry>
</row>
<row>
<entry><xref linkend="clsBrowseForFolder"/> class</entry>
<entry>Provides access to the Windows <emphasis role="italic">Browse For Folder</emphasis> dialog, allowing complete configuration of the dialog.</entry>
</row>
<row>
<entry><xref linkend="clsCheckList"/> class</entry>
<entry>A dialog with a group of one or more check boxes.</entry>
</row>
<row>
<entry><xref linkend="rtnCheckList"/> routine</entry>
<entry>A shortcut function to invoke the <computeroutput>CheckList</computeroutput> dialog.</entry>
</row>
<row>
<entry><xref linkend="rtnErrorDialog"/> routine</entry>
<entry>Pops up a message box containing the specified error message, an Ok push button, and an error icon.</entry>
</row>
<row>
<entry><xref linkend="rtnFileNameDialog"/> routine</entry>
<entry>Causes a file selection dialog box to appear.</entry>
</row>
<row>
<entry><xref linkend="rtnInfoDialog"/> routine</entry>
<entry>Pops up a message box containing the specified text and an Ok push button.</entry>
</row>
<row>
<entry><xref linkend="clsInputBox"/> class</entry>
<entry>Provides a simple dialog with a title, a message, an edit control, and the Ok and Cancel push buttons.</entry>
</row>
<row>
<entry><xref linkend="rtnInputBox"/> routine</entry>
<entry>A shortcut function to invoke an <computeroutput>InputBox</computeroutput> dialog as a function.</entry>
</row>
<row>
<entry><xref linkend="clsIntegerBox"/> class</entry>
<entry>An <computeroutput>InputBox</computeroutput> dialog whose edit control allows only numerical data.</entry>
</row>
<row>
<entry><xref linkend="rtnIntegerBox"/> routine</entry>
<entry>A shortcut to invoke an <computeroutput>IntegerBox</computeroutput> dialog as a function.</entry>
</row>
<row>
<entry><xref linkend="clsListChoice"/> class</entry>
<entry>Provides a dialog with a single-selection list box, and the Ok and Cancel push buttons.</entry>
</row>
<row>
<entry><xref linkend="rtnListChoice"/> routine</entry>
<entry>Provides a shortcut to invoke a <computeroutput>ListChoice</computeroutput> dialog.</entry>
</row>
<row>
<entry><xref linkend="rtnMessageDialog"/> routine</entry>
<entry>Pops up a message box with the options specified.</entry>
</row>
<row>
<entry><xref linkend="clsMultiInputBox"/> class</entry>
<entry>A dialog that provides a title, a message, and one or more edit controls.</entry>
</row>
<row>
<entry><xref linkend="rtnMultiInputBox"/> routine</entry>
<entry>Provides a shortcut function to invoke a <computeroutput>MultiInputBox</computeroutput> dialog</entry>
</row>
<row>
<entry><xref linkend="clsMultiListChoice"/> class</entry>
<entry>A <computeroutput>ListChoice</computeroutput> dialog that allows multi-item selection</entry>
</row>
<row>
<entry><xref linkend="rtnMultiListChoice"/> routine</entry>
<entry>Provides a shortcut to invoke a <computeroutput>MultiListChoice</computeroutput> dialog.</entry>
</row>
<row>
<entry><xref linkend="clsPasswordBox"/> class</entry>
<entry><computeroutput>InputBox</computeroutput> dialog with that uses a password edit control.</entry>
</row>
<row>
<entry><xref linkend="rtnPasswordBox"/> routine</entry>
<entry>A shortcut to invoke a <computeroutput>PasswordBox</computeroutput> dialog.</entry>
</row>
<row>
<entry><xref linkend="clsProgressDialog"/> class</entry>
<entry>A pre-built dialog with a progress bar that can be used to show the progress of a lengthy operation in an application</entry>
</row>
<row>
<entry><xref linkend="clsSimpleFolderBrowse"/> class</entry>
<entry>Allows the display of a simple to use, but non-configurable, Windows <emphasis role="italic">Browse For Folder</emphasis> dialog.</entry>
</row>
<row>
<entry><xref linkend="rtnSimpleFolderBrowse"/> routine</entry>
<entry>A short cut routine for the <computeroutput>SimpleFolderBrowse</computeroutput> dialog.</entry>
</row>
<row>
<entry><xref linkend="clsSingleSelection"/> class</entry>
<entry>A dialog that has a group of radio buttons. The user can select only one item of the group.</entry>
</row>
<row>
<entry><xref linkend="rtnSingleSelection"/> routine</entry>
<entry>Provides a quick way to invoke a <computeroutput>SingleSelection</computeroutput> dialog.</entry>
</row>
<row>
<entry><xref linkend="clsTimedMessage"/> class</entry>
<entry>Shows a message window for a defined duration.</entry>
</row>
<row>
<entry><xref linkend="rtnTimedMessage"/> routine</entry>
<entry>Provides a quick way to invoking a <computeroutput>TimedMessage</computeroutput> dialog.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="sctStandardDialogs"><title>Standard Dialog Classes</title>
<indexterm><primary>standard dialogs</primary></indexterm>
<para>The standard dialog classes are: </para>
<itemizedlist>
<listitem><para>TimedMessage</para></listitem>
<listitem><para>InputBox</para></listitem>
<listitem><para>PasswordBox</para></listitem>
<listitem><para>IntegerBox</para></listitem>
<listitem><para>MultiInputBox</para></listitem>
<listitem><para>ListChoice</para></listitem>
<listitem><para>MultiListChoice</para></listitem>
<listitem><para>CheckList</para></listitem>
<listitem><para>SingleSelection</para></listitem>
</itemizedlist>
<para></para>
<variablelist>
<varlistentry><term>Preparation:</term>
<listitem><para>Standard dialogs are prepared by using the
<computeroutput>new</computeroutput> method of the class, which in turn
invokes the <computeroutput>init</computeroutput> method. The parameters for
the <computeroutput>new</computeroutput> method are described for the
<computeroutput>init</computeroutput> method of each class.
</para></listitem></varlistentry>
<varlistentry><term>Execution:</term>
<listitem><para>The dialog is then run by using the
<computeroutput>execute</computeroutput> method. For most of the standard
dialogs <computeroutput>execute</computeroutput> returns the user's input if
the OK button is clicked and the null string if the Cancel button is clicked to
terminate the dialog. If there is more than one return value, execute returns
the value 1 and stores the results in an attribute. Exceptions to the general
rule are noted in the documentation for the individual dialog.
</para></listitem></varlistentry>
<varlistentry><term>Functions:</term>
<listitem><para>Each standard dialog is also available as a callable function.
These functions are described in the
Public Routines <link linkend="sctPublicRoutines">section</link> of this chapter.
</para></listitem></varlistentry>
</variablelist>
<section id="clsBrowseForFolder" xreflabel="BrowseForFolder"><title>BrowseForFolder Class</title>
<indexterm><primary>BrowseForFolder class</primary></indexterm>
<para>
A BrowseForFolder object represents the Windows <emphasis role="italic">Browse For Folder</emphasis> common dialog. The
Windows operating system provides a number of common dialogs for use by applications to allow presenting the user with an
unified generic method to do common tasks. The Browse For Folder dialog is specifically to allow the user to open or choose
folders.
</para>
<section id="sctShellCOMConsiderations"><title>Shell / COM considerations</title>
<indexterm><primary>BrowseForFolder class</primary><secondary>Shell / COM considerations</secondary></indexterm>
<para>
The browse for folder dialog is part of the Windows Shell. Shell objects are implemented using COM (the component object
model, a standard introduced by Microsoft.) The Windows Shell should not be confused with the Windows window manager, which
is responsible for the windowing system in Windows. ooDialog is primarily concerned with, and deals with, the windowing
system. However, to be able to deal with the full range of application needs in a modern Windows system, it becomes
necessary to use more than just the windowing system. The need to provide a way for users to select or choose a folder is
an example of needing more than just the window manager.
</para>
<variablelist>
<varlistentry id="varItemIDList" xreflabel="item ID list"><term><emphasis role="bold">Item ID List</emphasis></term>
<listitem>
<para>
The Windows Shell identifies objects in the Shell using a structure called an item ID list. Files, folders, printers,
remote computers all have an item ID list when working with them in the Shell. The ooDialog programmer does not really
need to know about the details of these item ID lists. Although technically incorrect, the programmer can just think of
them as <link linkend="defHandle">handles</link>. However, it is difficult to document the
<computeroutput>BrowseForFolder</computeroutput> class without making some reference to an item ID list. For that
purpose, this simple explanation of them is included.
</para>
</listitem></varlistentry>
</variablelist>
<para>
In general, the Rexx programmer can work with the <computeroutput>BrowseForFolder</computeroutput> class in the same way as
working with any other ooDialog dialog classes. However, because the underlying Windows object is a COM object rather than
the usual windowing system window, there are a few considerations the programmer needs to be aware of. The use of COM
objects requirers that the COM library be initialized and released for <emphasis role="italic">each</emphasis> thread that
a COM object is used in.
</para>
<para>
Normally the Rexx programmer does not need to be much aware of threading and thread issues. However the COM requiement
that the library be initialized and released on each thread changes that. The normal usage pattern for a browse for folder
object would be:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="italic">Instantiate a <computeroutput>BrowseForFolder</computeroutput> object.</emphasis>
</para>
</listitem>
<listitem>
<para>
Configure the browse for folder object.
</para>
</listitem>
<listitem>
<para>
Show the dialog and get the user's selection.
</para>
</listitem>
</itemizedlist>
<para>
As long as this is all done on one thread, there is no problem. The ooDialog framework initializes COM when the object is
instantiated and releases COM when the underlying dialog is closed, when the <xref linkend="mthGetFolder"/> method returns.
However, if the programmer wants, or needs, to implement a different usage pattern, then it becomes the programmer's
responsibility to ensure that COM is initialized and released properly on each thread. The
<computeroutput>BrowseForFolder</computeroutput> class provides the tools the programmer needs to do that. If COM is not
initialized on a thread the browse for folder object is running on, then methods invoked on the object may fail. If COM is
not released on a thread it <emphasis role="italic">was</emphasis> initialized on, then system resource leaks can occur.
</para>
<para>
This is not that complicated and is not really that different than other areas of ooDialog concerning system resources. If
the programmer wants to use a different font for a dialog control, the <xref linkend="mthSetFont"/> method will fail unless
the programmer has first initialized a font. If the programmer initializes a font using the <xref
linkend="mthCreateFontEx"/> method and does not release the font, then system resource leaks can ocurr. The only difference
here is that this <emphasis role="italic">initialize / release</emphasis> cycle is on a per thread basis.
</para>
<para>
The documentation for the individual attributes and methods of the <computeroutput>BrowseForFolder</computeroutput> class
will make note of when the programmer needs to consider these threading issues when using the attribute or method. In
addition, the <xref linkend="clsSimpleFolderBrowse"/> class provides an interface to the Browse For Folder dialog where
the Rexx programmer does not need to be aware of COM.
</para>
</section> <!-- End Shell / COM considerations section -->
<section id="sctSpecialFolderNames" xreflabel="Special Folder Names"><title>Special Folder Names</title>
<indexterm><primary>BrowseForFolder</primary><secondary>Special Folder Names</secondary></indexterm>
<indexterm><primary>SimpleFolderBrowse</primary><secondary>Special Folder Names</secondary></indexterm>
<para>
Windows uses CSIDL (constant special item ID list) names to provide a unique system-independent way to identify special
folders used frequently by applications. These folders may not have the same name or location on any given system. For
example, the system folder may be <emphasis role="italic">C:\Windows</emphasis> on one system and <emphasis
role="italic">C:\Winnt</emphasis> on another.
</para>
<para>
In Windows Vista and later the CSIDL values have been replaced by Known Folder values, but for compatibility the CSIDL
values still work. ooDialog does not yet support the known folder values, only the CSIDL names. Some of the methods of the
<computeroutput>BrowseForFolder</computeroutput> class and the <xref linkend="clsSimpleFolderBrowse"/> class accept the
CSIDL names listed below for arguments. Future enhancements to ooDialog may also accept the CSIDL names, so they are listed
here in one place. The names are not case sensitive, but are otherwise spelled exactly as Microsoft does. Google can be
used to research any of the names further. Only the names listed are recognized in ooDialog.
</para>
<variablelist>
<varlistentry><term>CSIDL_ADMINTOOLS:</term>
<listitem>
<para>
The file system directory that is used to store administrative tools for an individual user.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_ALTSTARTUP:</term>
<listitem>
<para>
The file system directory that corresponds to the user's nonlocalized Startup program group. This value is recognized in
Windows Vista for backward compatibility, but the folder itself no longer exists.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_APPDATA:</term>
<listitem>
<para>
The file system directory that serves as a common repository for application-specific data.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_BITBUCKET:</term>
<listitem>
<para>
The virtual folder that contains the objects in the user's Recycle Bin.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_CDBURN_AREA:</term>
<listitem>
<para>
The file system directory that acts as a staging area for files waiting to be written to a CD.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_ADMINTOOLS:</term>
<listitem>
<para>
The file system directory that contains administrative tools for all users of the computer.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_ALTSTARTUP:</term>
<listitem>
<para>
The file system directory that corresponds to the nonlocalized Startup program group for all users. Valid only for
Microsoft Windows NT systems. This value is recognized in Windows Vista for backward compatibility, but the folder itself
no longer exists.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_APPDATA:</term>
<listitem>
<para>
The file system directory that contains application data for all users. This folder is used for application data that is not user specific. For example, an application can
store a spell-check dictionary, a database of clip art, or a log file in the CSIDL_COMMON_APPDATA folder. This
information will not roam and is available to anyone using the computer.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_DESKTOPDIRECTORY:</term>
<listitem>
<para>
The file system directory that contains files and folders that appear on the desktop for all users.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_DOCUMENTS:</term>
<listitem>
<para>
The file system directory that contains documents that are common to all users.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_FAVORITES:</term>
<listitem>
<para>
The file system directory that serves as a common repository for favorite items common to all users
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_MUSIC:</term>
<listitem>
<para>
The file system directory that serves as a repository for music files common to all users.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_OEM_LINKS:</term>
<listitem>
<para>
This value is recognized in Windows Vista for backward compatibility, but the folder itself is no longer used.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_PICTURES:</term>
<listitem>
<para>
The file system directory that serves as a repository for image files common to all users
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_PROGRAMS:</term>
<listitem>
<para>
The file system directory that contains the directories for the common program groups that appear on the Start menu for
all users.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_STARTMENU:</term>
<listitem>
<para>
The file system directory that contains the programs and folders that appear on the Start menu for all users
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_STARTUP:</term>
<listitem>
<para>
The file system directory that contains the programs that appear in the Startup folder for all users.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_TEMPLATES:</term>
<listitem>
<para>
The file system directory that contains the templates that are available to all users.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMMON_VIDEO:</term>
<listitem>
<para>
The file system directory that serves as a repository for video files common to all users.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COMPUTERSNEARME:</term>
<listitem>
<para>
The folder that represents other computers in your workgroup.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_CONNECTIONS:</term>
<listitem>
<para>
The virtual folder that represents Network Connections, that contains network and dial-up connections.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_CONTROLS:</term>
<listitem>
<para>
The virtual folder that contains icons for the Control Panel applications.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_COOKIES:</term>
<listitem>
<para>
The file system directory that serves as a common repository for Internet cookies.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_DESKTOP:</term>
<listitem>
<para>
The virtual folder that represents the Windows desktop, the root of the namespace.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_DESKTOPDIRECTORY:</term>
<listitem>
<para>
The file system directory used to physically store file objects on the desktop (not to be confused with the desktop
folder itself.)
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_DRIVES:</term>
<listitem>
<para>
The virtual folder that represents My Computer, containing everything on the local computer: storage devices, printers,
and Control Panel.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_FAVORITES:</term>
<listitem>
<para>
The file system directory that serves as a common repository for the user's favorite items.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_FONTS:</term>
<listitem>
<para>
A virtual folder that contains fonts.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_HISTORY:</term>
<listitem>
<para>
The file system directory that serves as a common repository for Internet history items.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_INTERNET:</term>
<listitem>
<para>
A virtual folder for Internet Explorer.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_INTERNET_CACHE:</term>
<listitem>
<para>
The file system directory that serves as a common repository for temporary Internet files
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_LOCAL_APPDATA:</term>
<listitem>
<para>
The file system directory that serves as a data repository for local (nonroaming) applications.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_MYDOCUMENTS:</term>
<listitem>
<para>
The virtual folder that represents the My Documents desktop item.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_MYMUSIC:</term>
<listitem>
<para>
The file system directory that serves as a common repository for music files.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_MYPICTURES:</term>
<listitem>
<para>
The file system directory that serves as a common repository for image files.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_MYVIDEO:</term>
<listitem>
<para>
The file system directory that serves as a common repository for video files
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_NETHOOD:</term>
<listitem>
<para>
A file system directory that contains the link objects that may exist in the My Network Places virtual folder. It is not
the same as CSIDL_NETWORK, which represents the network namespace root.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_NETWORK:</term>
<listitem>
<para>
A virtual folder that represents Network Neighborhood, the root of the network namespace hierarchy.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PERSONAL:</term>
<listitem>
<para>
The virtual folder that represents the My Documents desktop item.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PRINTERS:</term>
<listitem>
<para>
The virtual folder that contains installed printers.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PRINTHOOD:</term>
<listitem>
<para>
The file system directory that contains the link objects that can exist in the Printers virtual folder.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PROFILE:</term>
<listitem>
<para>
The user's profile folder. Applications should not create files or folders at this level; they should put their data
under the locations referred to by CSIDL_APPDATA or CSIDL_LOCAL_APPDATA.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PROGRAM_FILES:</term>
<listitem>
<para>
The Program Files folder.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PROGRAM_FILES_COMMON:</term>
<listitem>
<para>
A folder for components that are shared across applications.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PROGRAM_FILES_COMMONX86:</term>
<listitem>
<para>
Listed in the MSDN documentation with no explanation.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PROGRAM_FILESX86:</term>
<listitem>
<para>
Listed in the MSDN documentation with no explanation.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_PROGRAMS:</term>
<listitem>
<para>
The file system directory that contains the user's program groups (which are themselves file system directories.)
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_RECENT:</term>
<listitem>
<para>
The file system directory that contains shortcuts to the user's most recently used documents.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_RESOURCES:</term>
<listitem>
<para>
Windows Vista. The file system directory that contains resource data.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_RESOURCES_LOCALIZED:</term>
<listitem>
<para>
Listed in the MSDN documentation with no explanation.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_SENDTO:</term>
<listitem>
<para>
The file system directory that contains Send To menu items.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_STARTMENU:</term>
<listitem>
<para>
The file system directory that contains Start menu items.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_STARTUP:</term>
<listitem>
<para>
The file system directory that corresponds to the user's Startup program group. The system starts these programs whenever
any user logs onto Windows.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_SYSTEM:</term>
<listitem>
<para>
The Windows System folder.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_SYSTEMX86:</term>
<listitem>
<para>
Listed in the MSDN documentation with no explanation.
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_TEMPLATES:</term>
<listitem>
<para>
The file system directory that serves as a common repository for document templates
</para>
</listitem></varlistentry>
<varlistentry><term>CSIDL_WINDOWS:</term>
<listitem>
<para>
The Windows directory or SYSROOT. This corresponds to the %windir% or %SYSTEMROOT% environment variables.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Special Folder Names section -->
<section id="sctMethodsBrowseForFolder"><title>Method Table</title>
<para>
The following table lists the class and instance methods of the <computeroutput>BrowseForFolder</computeroutput> class:
<table id="tblMethodsBrowseForFolder" frame="all"> <title>BrowseForFolder Class Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="4*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="clsBrowseForFolder"/> </entry>
<entry>Instantiates a new <computeroutput>BrowseForFolder</computeroutput> object</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="atrBanner"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="atrDlgTitle"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="atrHint"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="atrInitialThread"/></entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="atrOptions"/> </entry>
<entry>Reflects the Browse For Folder dialog options set for this object.</entry>
</row>
<row>
<entry><xref linkend="atrOwner"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="atrRoot"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="atrStartDir"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="atrUsePathForHint"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="atrBanner"/> </entry>
<entry></entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthGetDisplayName"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="mthGetFolder"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="mthGetItemIDList"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="mthInitCOM"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="mthReleaseCOM"/> </entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="mthReleaseItemIDList"/> </entry>
<entry></entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="mthNewClsBrowseForFolder"><title>new (Class Method)</title>
<indexterm><primary>new</primary><secondary>BrowseForFolder class</secondary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>new</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(--+---------+--+----------+--+--------+--+------------+--)-------------><
+--title--+ +-,-banner-+ +-,-hint-+ +-,-startDir-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>BrowseForFolder</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>title [optional]</term>
<listitem>
<para>
Specifies a caption, or title, for the dialog. The Windows default title is <emphasis role="italic">Browse For
Folder</emphasis>. If this argumentis used, the <xref linkend="atrDlgTitle"/> attribute is set using the value
specified.
</para>
<para>
If this argument is omitted, the default ooDialog value, <emphasis role="italic">ooDialog Browse for Folder</emphasis>,
is set for the <emphasis role="italic">dlgTitle</emphasis> attribute. To prevent the ooDialg default value from being
used and have the Windows default used, set this argument to the <computeroutput>.nil</computeroutput> object, or to the empty string.
</para>
</listitem></varlistentry>
<varlistentry><term>banner [optional]</term>
<listitem>
<para>
Specifies text to use for what Windows calls the <emphasis role="italic">banner</emphasis> for the dialog. This string
is displayed above the tree view control in the dialog box. The string can be used to specify instructions to the user.
By default, Windows, does not display the banner and the area above the tree view is blank. If this argument is
used, the <xref linkend="atrBanner"/> attribute is set to the value specified.
</para>
<para>
If this argument is omitted, the default ooDialog value, <emphasis role="italic">Select the folder needed</emphasis>,
is set for the <emphasis role="italic">banner</emphasis> attribute. To prevent the ooDialg default value from being
used and have the Windows default used, set this argument to the <computeroutput>.nil</computeroutput> object, or to
the empty string.
</para>
</listitem></varlistentry>
<varlistentry><term>hint [optional]</term>
<listitem>
<para>
Specifies text to use for a <emphasis role="italic">hint</emphasis> in the dialog. The hint is displayed below the
bottom of the tree view control and above the bottom row of buttons of the dialog. By default, Windows does not display
a hint, and the area where the hint would go is removed from the dialog. That is, the bottom row of buttons is placed
directly below the tree view. If this argument is used, the <xref linkend="atrHint"/> attribute is set to the value
specified.
</para>
<para>
If this argument is omitted, the default ooDialog value, <emphasis role="italic">If the needed folder does not exist it
can be created</emphasis>, is set for the <emphasis role="italic">hint</emphasis> attribute. To prevent the ooDialg
default value from being used and have the Windows default used, set this argument to the
<computeroutput>.nil</computeroutput> object, or to the empty string.
</para>
</listitem></varlistentry>
<varlistentry><term>startDir [optional]</term>
<listitem>
<para>
Specifies an initial selected folder for the dialog. By default, Windows opens the dialog with the top-most item in the
tree view selected. If a start folder is specified, the folder is selected and, if needed, the tree view items are
expanded and the tree view is scrolled so that the starting folder is visible in the tree view. If this argument is
used, the <xref linkend="atrStartDir"/> attribute is set to the value specified.
</para>
<para>
Testing indicates that the folder specified must be a fully qualified path name of an existing directory. If not, the
operating system seems to just ignore it.
</para>
<para>
If this argument is omitted, the ooDialog framework sets the <emphasis role="italic">startDir</emphasis> attribute to
the empty string. The causes Windows to use its default behaviour.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a newly instantiated <computeroutput>BrowseForFolder</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
During instantiation, the <xref linkend="atrOptions"/>, <xref linkend="atrRoot"/>. and the <xref
linkend="atrInitialThread"/> attributes are also set.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::new() -->
<section id="atrBanner" xreflabel="banner"><title>banner (Attribute)</title>
<indexterm><primary>banner</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>banner</secondary></indexterm>
<programlisting>
<![CDATA[
>>--banner-----------------------------------------------------><
>>--banner = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">banner get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">banner set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::banner() [attribute] -->
<section id="atrDlgTitle" xreflabel="dlgTitle"><title>dlgTitle (Attribute)</title>
<indexterm><primary>dlgTitle</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>dlgTitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--dlgTitle-----------------------------------------------------><
>>--dlgTitle = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">dlgTitle get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">dlgTitle set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::dlgTitle() [attribute] -->
<section id="atrHint" xreflabel="hint"><title>hint (Attribute)</title>
<indexterm><primary>hint</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>hint</secondary></indexterm>
<programlisting>
<![CDATA[
>>--hint-----------------------------------------------------><
>>--hint = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">hint get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">hint set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::hint() [attribute] -->
<section id="atrInitialThread" xreflabel="initialThread"><title>initialThread (Attribute)</title>
<indexterm><primary>initialThread</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>initialThread</secondary></indexterm>
<programlisting>
<![CDATA[
>>--initialThread-----------------------------------------------------><
>>--initialThread = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">initialThread get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">initialThread set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::initialThread() [attribute] -->
<section id="atrOptions" xreflabel="options"><title>options (Attribute)</title>
<indexterm><primary>options</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>options</secondary></indexterm>
<programlisting>
<![CDATA[
>>--options-----------------------------------------------------><
>>--options = varName-------------------------------------------><
]]>
</programlisting>
<para>
Reflects the Browse For Folder dialog options set for this object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">options get:</emphasis></term>
<listitem>
<para>
Returns a list of the keywords that specify the Browse For Folder dialog options that are currently set for this object.
The kewyords are listed and explained in the remarks section.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">options set:</emphasis></term>
<listitem>
<para>
Set the Browse For Folder dialog options using a blank separated list of keywords. The list is case insensitive. The
possible keywords are listed in the remarks section.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
On instantiation, the Browse For Folder dialog options are set to a default value that is appropriate for most use cases.
The default options are <emphasis role="italic">RETURNONLYFSDIRS RETURNFSANCESTORS NEWDIALOGSTYLE</emphasis>. To change
these options after instantiations, set this attribute using a list of 0 or more of the following keywords, case is not
significant. The list <emphasis role="italic">replaces</emphasis> the current list, with one caveat. The ooDialog
framework manages the NEWDIALOGSTYLE and UAHINT options. The NEWDIALOGSTYLE is required. If the new list does not
contain that keyword it is added. The UAHINT option is added when needed, and removed when not needed.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BROWSEFILEJUNCTIONS</member>
<member>BROWSEFORCOMPUTER </member>
<member>BROWSEFORPRINTER </member>
<member>BROWSEINCLUDEFILES </member>
<member>BROWSEINCLUDEURLS </member>
<member>DONTGOBELOWDOMAIN </member>
<member>NEWDIALOGSTYLE </member>
<member>NONEWFOLDERBUTTON </member>
<member>NOTRANSLATETARGETS </member>
<member>RETURNFSANCESTORS </member>
<member>RETURNONLYFSDIRS </member>
<member>SHAREABLE </member>
<member>UAHINT </member>
</simplelist>
<variablelist>
<varlistentry><term>BROWSEFILEJUNCTIONS</term>
<listitem>
<para>
Allows folder junctions like zip files and libraries to be browsed.
</para>
</listitem></varlistentry>
<varlistentry><term>BROWSEFORCOMPUTER</term>
<listitem>
<para>
Only return computers.
</para>
</listitem></varlistentry>
<varlistentry><term>BROWSEFORPRINTER</term>
<listitem>
<para>
Only allow the selection of printers.
</para>
</listitem></varlistentry>
<varlistentry><term>BROWSEINCLUDEFILES</term>
<listitem>
<para>
The browse dialog box will display files as well as folders.
</para>
</listitem></varlistentry>
<varlistentry><term>BROWSEINCLUDEURLS</term>
<listitem>
<para>
The browse dialog box can display URLs. The NEWDIALOGSTYLE and BROWSEINCLUDEFILES flags must also be set. If these
three flags are not set, the browser dialog box will reject URLs. Even when these flags are set, the browse dialog
box will only display URLs if the folder that contains the selected item supports them.
</para>
</listitem></varlistentry>
<varlistentry><term>DONTGOBELOWDOMAIN</term>
<listitem>
<para>
Do not include network folders below the domain level in the dialog box's tree view control.
</para>
</listitem></varlistentry>
<varlistentry><term>NEWDIALOGSTYLE</term>
<listitem>
<para>
Use the new user interface. Setting this flag provides the user with a larger dialog box that can be resized. The
dialog box has several new capabilities, including: drag-and-drop capability within the dialog box, reordering,
shortcut menus, new folders, delete, and other shortcut menu commands. The programmer can not effectively remove this
flag, the ooDialog framework ensures it is always set.
</para>
</listitem></varlistentry>
<varlistentry><term>NONEWFOLDERBUTTON</term>
<listitem>
<para>
Do not include the New Folder button in the browse dialog box.
</para>
</listitem></varlistentry>
<varlistentry><term>NOTRANSLATETARGETS</term>
<listitem>
<para>
When the selected item is a shortcut, return the <xref linkend="varItemIDList"/> of the shortcut itself rather than
its target.
</para>
</listitem></varlistentry>
<varlistentry><term>RETURNFSANCESTORS</term>
<listitem>
<para>
Only return file system ancestors. An ancestor is a subfolder that is beneath the root folder in the namespace
hierarchy.
</para>
</listitem></varlistentry>
<varlistentry><term>RETURNONLYFSDIRS</term>
<listitem>
<para>
Only return file system directories.
</para>
</listitem></varlistentry>
<varlistentry><term>SHAREABLE</term>
<listitem>
<para>
The browse dialog box can display shareable resources on remote systems. It is intended for applications that want to
expose remote shares on a local system.
</para>
</listitem></varlistentry>
<varlistentry><term>UAHINT</term>
<listitem>
<para>
Adds a usage hint to the dialog box. This option is set by the ooDialog framework, the programmer can not effectively
alter it. The option is set if the <xref linkend="atrHint"/> attribute is set and removed if the attribute is not
set.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from a demonstration program showing how to browse for printers. After instantiating the browse for
folder object, it sets the dialog options to a non-default value, a value appropriate for printer browsing:
<programlisting>
<![CDATA[
title = 'Browse For a Printer'
banner = 'Select the printer to use for this test.'
hint = 'This is only a demonstration, no printing will be done.'
bff = .BrowseForFolder~new(title, banner, hint)
bff~owner = self
bff~root = 'CSIDL_PRINTERS'
bff~options = 'BROWSEFORPRINTERS NONEWFOLDERBUTTON'
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::options() [attribute] -->
<section id="atrOwner" xreflabel="owner"><title>owner (Attribute)</title>
<indexterm><primary>owner</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>owner</secondary></indexterm>
<programlisting>
<![CDATA[
>>--owner-----------------------------------------------------><
>>--owner = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">owner get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">owner set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::owner() [attribute] -->
<section id="atrRoot" xreflabel="root"><title>root (Attribute)</title>
<indexterm><primary>root</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>root</secondary></indexterm>
<programlisting>
<![CDATA[
>>--root-----------------------------------------------------><
>>--root = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">root get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">root set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from a demonstration program showing how to browse for printers. After instantiating the browse for
folder object, it sets the root attribute to the printers folder:
<programlisting>
<![CDATA[
title = 'Browse For a Printer'
banner = 'Select the printer to use for this test.'
hint = 'This is only a demonstration, no printing will be done.'
bff = .BrowseForFolder~new(title, banner, hint)
bff~owner = self
bff~root = 'CSIDL_PRINTERS'
bff~options = 'BROWSEFORPRINTERS NONEWFOLDERBUTTON'
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::root() [attribute] -->
<section id="atrStartDir" xreflabel="startDir"><title>startDir (Attribute)</title>
<indexterm><primary>startDir</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>startDir</secondary></indexterm>
<programlisting>
<![CDATA[
>>--startDir-----------------------------------------------------><
>>--startDir = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">startDir get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">startDir set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::startDir() [attribute] -->
<section id="atrUsePathForHint" xreflabel="usePathForHint"><title>usePathForHint (Attribute)</title>
<indexterm><primary>usePathForHint</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>usePathForHint</secondary></indexterm>
<programlisting>
<![CDATA[
>>--usePathForHint-----------------------------------------------------><
>>--usePathForHint = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">usePathForHint get:</emphasis></term>
<listitem>
<para>
details about get
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">usePathForHint set:</emphasis></term>
<listitem>
<para>
details about set
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::usePathForHint() [attribute] -->
<section id="mthGetDisplayName" xreflabel="getDisplayName"><title>getDisplayName</title>
<indexterm><primary>getDisplayName</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>getDisplayName</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getDisplayName(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::getDisplayName() -->
<section id="mthGetFolder" xreflabel="getFolder"><title>getFolder</title>
<indexterm><primary>getFolder</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>getFolder</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getFolder(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::getFolder() -->
<section id="mthGetItemIDList" xreflabel="getItemIDList"><title>getItemIDList</title>
<indexterm><primary>getItemIDList</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>getItemIDList</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getItemIDList(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::getItemIDList() -->
<section id="mthInitCOM" xreflabel="initCOM"><title>initCOM</title>
<indexterm><primary>initCOM</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>initCOM</secondary></indexterm>
<programlisting>
<![CDATA[
>>--initCOM(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::initCOM() -->
<section id="mthReleaseCOM" xreflabel="releaseCOM"><title>releaseCOM</title>
<indexterm><primary>releaseCOM</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>releaseCOM</secondary></indexterm>
<programlisting>
<![CDATA[
>>--releaseCOM(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::releaseCOM() -->
<section id="mthReleaseItemIDList" xreflabel="releaseItemIDList"><title>releaseItemIDList</title>
<indexterm><primary>releaseItemIDList</primary></indexterm>
<indexterm><primary>BrowseForFolder class</primary><secondary>releaseItemIDList</secondary></indexterm>
<programlisting>
<![CDATA[
>>--releaseItemIDList(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BrowseForFolder::releaseItemIDList() -->
</section> <!-- End BrowseForFolder Class -->
<section id="clsCheckList" xreflabel="CheckList"><title>CheckList Class</title>
<indexterm><primary>CheckList</primary>
<secondary>class</secondary></indexterm>
<indexterm><primary>standard dialogs</primary>
<secondary>CheckList</secondary></indexterm>
<para>The CheckList class is a dialog with a group of
one or more check boxes. </para>
<variablelist>
<varlistentry><term>Execute:</term>
<listitem><para>Returns 1 (if OK was clicked). The check boxes
selected by the user are marked in a stem variable with the value 1.
</para></listitem></varlistentry>
</variablelist>
<para>The method listed below is defined by this class.</para>
<section id="initCheckList" xreflabel="init"><title>init</title>
<indexterm><primary>init</primary>
<secondary>CheckList class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aCheckList~init(--message--,--title--,--labels.--,--datas.-->
>---+------------------------+--)-----------------------------><
+-,--+-----+--+--------+-+
+-len-+ +-,--max-+
]]>
</programlisting>
<para></para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>message</term>
<listitem><para>A text string that is displayed on top of the check box group. Use
it to give the user advice on what to do.
</para></listitem></varlistentry>
<varlistentry><term>title</term>
<listitem><para>A text string for the dialog's title
</para></listitem></varlistentry>
<varlistentry><term>labels.</term>
<listitem><para>A stem variable (do not forget the trailing period) containing all the
labels for the check boxes
</para></listitem></varlistentry>
<varlistentry><term>datas.</term>
<listitem><para>This argument is a stem variable (do not forget the trailing period)
that you can use to preselect the check boxes. The first check box relates
to stem item 101, the second to 102, and so forth. A value of 1 indicates selected, and a value of 0 indicates deselected.</para>
<para>For example, Datas.103=1 indicates
that there is a check mark on the third box.</para>
</listitem></varlistentry>
<varlistentry><term>len</term>
<listitem><para>Determines the length of the check boxes and labels. If omitted, the
size is calculated to fit the largest label.
</para></listitem></varlistentry>
<varlistentry><term>max</term>
<listitem><para>The maximum number of check boxes in one column. If there are more check
boxes than max - that is, labels. has more items than the value of max
- this method continues with a new column.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example creates and shows a dialog with seven check boxes:
</para></listitem></varlistentry>
</variablelist>
<programlisting>
<![CDATA[
lst.1 = "Monday"; lst.2 = "Tuesday"; lst.3 = "Wednesday"
lst.4 = "Thursday"; lst.5 = "Friday"; lst.6 = "Saturday"
lst.7 = "Sunday"
do i = 101 to 107
chk.i = 0
end
dlg = .CheckList~new("Please select a day!","Day of week",lst., chk.)
if dlg~execute = 1 then do
say "You selected the following day(s): "
do i = 101 to 107
a = i-100
if chk.i = 1 then say lst.a
end
end
]]>
</programlisting>
</section>
</section>
<section id="clsInputBox" xreflabel="InputBox"><title>InputBox Class</title>
<indexterm><primary>InputBox</primary>
<secondary>class</secondary></indexterm>
<indexterm><primary>standard dialogs</primary>
<secondary>InputBox</secondary></indexterm>
<para>The InputBox class provides a simple dialog with
a title, a message, one entry line, an OK, and a Cancel push button. </para>
<variablelist>
<varlistentry><term>Execute:</term>
<listitem><para>Returns the user's input
</para></listitem></varlistentry>
</variablelist>
<para>The methods listed below are defined by this class.</para>
<section id="initInputBox" xreflabel="init"><title>init</title>
<indexterm><primary>init</primary>
<secondary>InputBox class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aInputBox~init(--message--,--title--,--prevalue--,--len--)----><
]]>
</programlisting>
<para>The init method prepares the input dialog. </para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>message</term>
<listitem><para>A text string that is displayed in the dialog
</para></listitem></varlistentry>
<varlistentry><term>title</term>
<listitem><para>A string that is displayed as the dialog's title in the title bar
</para></listitem></varlistentry>
<varlistentry><term>prevalue</term>
<listitem><para>A string to initialize the entry line. If you do not want to put any
text in the entry line, just pass an empty string.
</para></listitem></varlistentry>
<varlistentry><term>len</term>
<listitem><para>The width of the entry line in dialog units
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example shows an InputBox dialog with the title of
<emphasis role="italic">Input</emphasis> and an entry line:
<programlisting>
<![CDATA[
dlg = .InputBox~New("Please enter your email address", -
"Input", "user@host.domain", 150)
value = dlg~execute
say "You entered:" value
drop dlg
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="h002128"><title>defineDialog</title>
<indexterm><primary>defineDialog</primary>
<secondary>InputBox class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aInputBox~DefineDialog--------------------------------------><
]]>
</programlisting>
<para>The defineDialog method is called by the create method of the parent
class, which in turn is called at the very beginning of
Execute. You do not have to call it. However, you may want to over-ride it in
your subclass to add more dialog controls to the window. If you over-ride it, you
have to forward the message to the parent class by using the keyword super.
</para>
</section>
<section id="h002138"><title>AddLine</title>
<indexterm><primary>AddLine</primary>
<secondary>InputBox class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aInputBox~AddLine(--x--,--y--,--l--)------------------------><
]]>
</programlisting>
<para>The AddLine method is used internally to add one
entry line to the dialog.</para>
</section>
<section id="h002148"><title>execute</title>
<indexterm><primary>execute</primary>
<secondary>InputBox class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aInputBox~Execute-------------------------------------------><
]]>
</programlisting>
<para>The execute method creates and shows the dialog. After termination, the
value of the entry line is returned if the user clicks the OK button; a null
string is returned if the user clicks on Cancel.</para>
</section>
</section>
<section id="clsIntegerBox" xreflabel="IntegerBox"><title>IntegerBox Class</title>
<indexterm><primary>IntegerBox</primary>
<secondary>class</secondary></indexterm>
<indexterm><primary>standard dialogs</primary>
<secondary>IntegerBox</secondary></indexterm>
<para>The IntegerBox class is an <xref linkend="clsInputBox"/>
dialog whose entry line allows only numerical data. </para>
<variablelist>
<varlistentry><term>Subclass:</term>
<listitem><para>This class is a subclass of the InputBox <xref linkend="clsInputBox"/> class
</para></listitem></varlistentry>
<varlistentry><term>Execute:</term>
<listitem><para>Returns the user's numeric input
</para></listitem></varlistentry>
</variablelist>
<para>The methods are the same as for the InputBox <xref linkend="clsInputBox"/>
class, with the exception of Validate.</para>
<section id="h002189"><title>validate</title>
<indexterm><primary>validate</primary>
<secondary>IntegerBox function</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aIntegerBox~validate----------------------------------------><
]]>
</programlisting>
<para>The only method this subclass overrides is validate, which is one of the
automatically called methods of PlainUserDialog. It is invoked by the OK method,
which in turn is called in response to a push button event. This method checks
whether or not the entry line contains a valid numerical value. If the value is
invalid, a message window is displayed.
</para>
</section>
</section>
<section id="clsListChoice" xreflabel="ListChoice"><title>ListChoice Class</title>
<indexterm><primary>ListChoice</primary>
<secondary>class</secondary></indexterm>
<indexterm><primary>standard dialogs</primary>
<secondary>ListChoice</secondary></indexterm>
<para>The ListChoice class provides a dialog with a list
box, an OK, and a Cancel button.
The selected item is returned if the OK push button
is used to terminate the dialog. </para>
<variablelist>
<varlistentry><term>Execute:</term>
<listitem><para>Returns the user's choice or a null string
</para></listitem></varlistentry>
</variablelist>
<para>The method listed below is defined by this class.</para>
<section id="initListChoice" xreflabel="init"><title>init</title>
<indexterm><primary>init</primary>
<secondary>ListChoice class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aListChoice~init(--message--,--title--,--input.-------------->
>--+---------------------------------------------------+-------><
+-,--+------+--+-------------------------------+--)-+
+-lenx-+ +-,--+------+--+--------------+-+
+-leny-+ +-,--preselect-+
]]>
</programlisting>
<para>The init method is used to initialize a newly created
instance of this class. </para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>message</term>
<listitem><para>A text string that is displayed on top of the list box. Use it to give
the user advice on what to do.
</para></listitem></varlistentry>
<varlistentry><term>title</term>
<listitem><para>A text string for the dialog's title
</para></listitem></varlistentry>
<varlistentry><term>input.</term>
<listitem><para>A stem variable (do not forget the trailing period) containing string
values that are inserted into the list box
</para></listitem></varlistentry>
<varlistentry><term>lenx, leny</term>
<listitem><para>The size of the list box in dialog units
</para></listitem></varlistentry>
<varlistentry><term>preselect</term>
<listitem><para>Entry that is selected when list pops up
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example creates a list choice dialog box where the user
can select exactly one dessert:
</para></listitem></varlistentry>
</variablelist>
<programlisting>
<![CDATA[
lst.1 = "Cookies"; lst.2 = "Pie"; lst.3 = "Ice cream"; lst.4 = "Fruit"
dlg = .ListChoice~new("Select the dessert please","YourChoice",lst., , ,"Pie")
say "Your ListChoice data:" dlg~execute
]]>
</programlisting>
</section>
</section>
<section id="clsMultiInputBox" xreflabel="MultiInputBox"><title>MultiInputBox Class</title>
<indexterm><primary>MultiInputBox</primary>
<secondary>class</secondary></indexterm>
<indexterm><primary>standard dialogs</primary>
<secondary>MultiInputBox</secondary></indexterm>
<para>The MultiInputBox class is a dialog that provides
a title, a message, and one or more entry lines. After execution of this dialog
you can access the values of the entry lines. </para>
<variablelist>
<varlistentry><term>Execute:</term>
<listitem><para>Returns 1 (if OK was clicked). The values entered
by the user are stored in attributes matching the labels of the entry lines.
</para></listitem></varlistentry>
</variablelist>
<para>The methods are the same as for the InputBox <xref linkend="clsInputBox"/>
class, with the exception of Init.</para>
<section id="initMultiInputBox" xreflabel="init"><title>init</title>
<indexterm><primary>init</primary>
<secondary>MultiInputBox class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aMultiInputBox~init(--message--,--title--,--labels.--,--datas.-->
>--+--------+--)--------------------------------------------------><
+-,--len-+
]]>
</programlisting>
<para>The init method is called automatically whenever
a new instance of this class is created. It prepares the dialog. </para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>message</term>
<listitem><para>A text string that is displayed on top of the entry lines. Use it to
give the user advice on what to do.
</para></listitem></varlistentry>
<varlistentry><term>title</term>
<listitem><para>A text string that is displayed in the title bar.
</para></listitem></varlistentry>
<varlistentry><term>labels.</term>
<listitem><para>A stem variable containing strings that are used as labels on the left
side of the entry lines. Labels.1 becomes the label
for the first entry line, labels.2 for the second,
and so forth.
</para></listitem></varlistentry>
<varlistentry><term>datas.</term>
<listitem><para>A stem variable (do not forget the trailing period) containing strings
that are used to initialize the entry lines. The entries must start with 101
and continue in increments of 1.
</para></listitem></varlistentry>
<varlistentry><term>len</term>
<listitem><para>The length of the entry lines. All entry lines get the same length.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example creates a four-line input box. The data entered
is stored in the object attributes that are displayed after dialog execution.
<programlisting>
<![CDATA[
lab.1 = "First name" ; lab.2 = "Last name "
lab.3 = "Street and City" ; lab.4 = "Profession:"
addr.101 = "John" ; addr.102 = "Smith" ; addr.103 = ""
addr.104 = "Software Engineer"
dlg = .MultiInputBox~new("Please enter your address", ,
"Your Address", lab., addr.)
if dlg~execute = 1 then do
say "The address is:"
say dlg~firstname dlg~lastname
say dlg~StreetandCity
say dlg~Profession
end
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
</section>
<section id="clsMultiListChoice" xreflabel="MultiListChoice"><title>MultiListChoice Class</title>
<indexterm><primary>MultiListChoice</primary>
<secondary>class</secondary></indexterm>
<indexterm><primary>standard dialogs</primary>
<secondary>MultiListChoice</secondary></indexterm>
<para>The MultiListChoice class is an extension of the ListChoice class. It makes it possible for the user to
select more than one line at a time. The execute method
returns the selected items' indexes separated by blank spaces. The first
item has index 1. </para>
<variablelist>
<varlistentry><term>Subclass:</term>
<listitem><para>This class is a subclass of the ListChoice <xref linkend="clsListChoice"/>
</para></listitem></varlistentry>
<varlistentry><term>Execute:</term>
<listitem><para>Returns the index numbers of the entries selected
</para></listitem></varlistentry>
<varlistentry><term>Preselect:</term>
<listitem><para>Indexes of entries, separated by a blank, that are to be preselected.
The first entry has index 1 and the rest are increments of one.
</para></listitem></varlistentry>
</variablelist>
<para>The methods are the same as for the ListChoice <xref linkend="clsListChoice"/>
class, except that execute returns the index numbers
of the selected entries. </para>
<variablelist>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example creates a multiple list choice box where the user
can select multiple entries:
</para></listitem></varlistentry>
</variablelist>
<programlisting>
<![CDATA[
lst.1 = "Monday" ; lst.2 = "Tuesday" ; lst.3 = "Wednesday"
lst.4 = "Thursday" ; lst.5 = "Friday" ; lst.6 = "Saturday"
lst.7 = "Sunday"
dlg = .MultiListChoice~new("Select the days you are working this week", ,
"YourMultipleChoice",lst., , ,"2 5")
s = dlg~execute
if s <> "" then do while s \= ""
parse var s res s
say lst.res
end
]]>
</programlisting>
</section>
<section id="clsPasswordBox" xreflabel="PasswordBox"><title>PasswordBox Class</title>
<indexterm><primary>PasswordBox</primary>
<secondary>class</secondary></indexterm>
<indexterm><primary>standard dialogs</primary>
<secondary>PasswordBox</secondary></indexterm>
<para>The PasswordBox class is an InputBox dialog with an entry line that echoes the keys with asterisks
(*) instead of characters. </para>
<variablelist>
<varlistentry><term>Subclass:</term>
<listitem><para>This class is a subclass of the InputBox <xref linkend="clsInputBox"/>
</para></listitem></varlistentry>
<varlistentry><term>Execute:</term>
<listitem><para>Returns the user's password
</para></listitem></varlistentry>
</variablelist>
<para>The methods are the same as for the InputBox <xref linkend="clsInputBox"/>,
with the exception of AddLine.</para>
<section id="h002166"><title>AddLine</title>
<indexterm><primary>AddLine</primary>
<secondary>PasswordBox class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aPasswordBox~AddLine(--x--,--y--,--l--)---------------------><
]]>
</programlisting>
<para>The AddLine overrides the same method of the parent
class, InputBox, by using a password entry line instead
of a simple entry line.</para>
</section>
</section>
<section id="sctProgressDialog" xreflabel="A Progress Dialog"><title>A Progress Dialog</title>
<indexterm><primary>progress dialog implementation</primary></indexterm>
<para>
ooDialog provides, as a standard dialog, an easy to use implementation of a progress dialog in the <xref
linkend="clsProgressDialog"/> class. This implementation includes two small helper classes for the
<computeroutput>ProgressDialog</computeroutput> class, the <xref linkend="clsInterruptible"/> and the <xref
linkend="clsAlerter"/> classes. These classes are documented in this section.
</para>
<section id="clsProgressDialog" xreflabel="ProgressDialog"><title>ProgressDialog Class</title>
<indexterm><primary>ProgressDialog class</primary></indexterm>
<para>
A <computeroutput>ProgressDialog</computeroutput> object is used to show a dialog containing a <xref
linkend="clsProgressBar"/>, an optional message, an optional status line, and an optional <emphasis
role="italic">Cancel</emphasis> button. The dialog shows the progress a lengthy task is making to the user. The optional
components of the dialog, the message text, the status line, et., can be used to convey more information concerning the
progrress, or the purpose of the dialog, to the user. The components can be used, or not used, according to the needs of
the application.
</para>
<para>
The progress dialog internally creates and sizes the components of the dialog, and the dialog itself, depending on how it
is configured. For instance, if the dialog is configured to skip the message and status components, and the progress is not
cancelable by the user, the dialog will consist of a progress bar only. The width of the dialog will either be a calculated
width, default width, or a configured width. The height of the dialog will be the proper height to accomdatae the progress
bar and other components, with margins. The layout of the dialog, from top to bottom, has a static control for the message
at the top of the dialog, then a static control for the status line, then the progress bar, and finally a cancel button at
the bottom right hand corner. The static message text, static status text, and progress bar controls are all the entire
width of the dialog with an equal margin on each side.
</para>
<para>
By default, the width of the dialog is calcualted based on the width of the message text. If there is no message, the width
is calculated based on the width of a typical message. Or, the programmer can configure a width. The dialog maintains a
minimum width that it will not be sized smaller than.
</para>
<para>
The dialog object has a number of attributes that are used configure the appearance and behaviour of the dialog. The
attributes all have default values and the progress dialog can be simply used <emphasis role="italic">as is</emphasis>, or
the programmer can change the values of any or all of the attributes. The methods of the
<computeroutput>ProgressDialog</computeroutput> class are used to start, update, and close the dialog.
</para>
<para>
Normally, an application, shows the progress bar, starts its lengthy operation, and periodically as it makes progress with
the option it advances the progress bar position. When the operation finishes, the application ends the progress bar. With
the <computeroutput>ProgressDialog</computeroutput> object, the programmer first configures the object by setting any
attributes whose default values are not appropriate. The <xref linkend="mthBegin"/> method shows the progress bar. As the
operation progresses, the programmer advances the progress bar position using the <xref linkend="mthIncrease"/> method. The
<xref linkend="mthUpdateStatus"/> and <xref linkend="mthUpdateStatusText"/> methods can also be used to update the status
line as progress is made, if desired. Finally, the <xref linkend="mthCompleteClsProgressDialog"/> and <xref
linkend="mthEndNow"/> are used to end the dialog.
</para>
<para>
One important aspect of performing a lengthy operation is whether the user can, or can not, cancel the operation once it is
begun. By default, the progress dialog can not be canceled by the user, and no cancel button is present in the dialog. If
the user tries to end the dialog using the Escape key, the Close menu item in the system menu, or the close button in the
title bar, a message box is put up explaining that the operation is not done yet and can not be canceled. The dialog is not
allowed to close. This default behaviour is changed throught the <xref linkend="atrCanCancel"/> attribute or through the
<xref linkend="mthSetInterruptible"/> method. The use of an <xref linkend="clsInterruptible"/> object gives the programmer
an elgant way of handling and controlling a user's request to cancel the operation.
</para>
<section id="sctMethodsProgressDialog"><title>Method Table</title>
<para>
The following table lists the class and instance methods of the <computeroutput>ProgressDialog</computeroutput> class:
<table id="tblMethodsProgressDialog" frame="all"> <title>ProgressDialog Class Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="4*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
</row>
<row>
<entry>new</entry>
<entry><link linkend="mthNewClsProgressDialog">new</link></entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="mthNewClsProgressDialog"><title>new (Class Method)</title>
<indexterm><primary>new</primary><secondary>ProgressDialog class</secondary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>new</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
xx
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::new() -->
<section id="atrAbsoluteWidth" xreflabel="absoluteWidth"><title>absoluteWidth (Attribute)</title>
<indexterm><primary>absoluteWidth</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>absoluteWidth</secondary></indexterm>
<programlisting>
<![CDATA[
>>--absoluteWidth-----------------------------------------------------><
>>--absoluteWidth = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::absoluteWidth() [attribute] -->
<section id="atrCanCancel" xreflabel="canCancel"><title>canCancel (Attribute)</title>
<indexterm><primary>CanCancel</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>canCancel</secondary></indexterm>
<programlisting>
<![CDATA[
>>--canCancel-----------------------------------------------------><
>>--canCancel = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::canCancel() [attribute] -->
<section id="atrCaptionText" xreflabel="captionText"><title>captionText (Attribute)</title>
<indexterm><primary>captionText</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>captionText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--captionText-----------------------------------------------------><
>>--captionText = title---------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::captionText() [attribute] -->
<section id="atrIncrStep" xreflabel="incrStep"><title>incrStep (Attribute)</title>
<indexterm><primary>incrStep</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>incrStep</secondary></indexterm>
<programlisting>
<![CDATA[
>>--incrStep-----------------------------------------------------><
>>--incrStep = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::incrStep() [attribute] -->
<section id="atrInitialStatusText" xreflabel="initialStatusText"><title>initialStatusText (Attribute)</title>
<indexterm><primary>initialStatusText</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>initialStatusText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--initialStatusText-----------------------------------------------------><
>>--initialStatusText = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::initialStatusText() [attribute] -->
<section id="atrMarqueeMode" xreflabel="marqueeMode"><title>marqueeMode (Attribute)</title>
<indexterm><primary>MarqueeMode</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>marqueeMode</secondary></indexterm>
<programlisting>
<![CDATA[
>>--marqueeMode-----------------------------------------------------><
>>--marqueeMode = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::MarqueeMode() [attribute] -->
<section id="atrMarqueePause" xreflabel="marqueePause"><title>marqueePause (Attribute)</title>
<indexterm><primary>MarqueePause</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>marqueePause</secondary></indexterm>
<programlisting>
<![CDATA[
>>--marqueePause-----------------------------------------------------><
>>--marqueePause = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::marqueePause() [attribute] -->
<section id="atrMsgText" xreflabel="msgText"><title>msgText (Attribute)</title>
<indexterm><primary>msgText</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>msgText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--msgText-----------------------------------------------------><
>>--msgText = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::msgText() [attribute] -->
<section id="atrNoMsg" xreflabel="noMsg"><title>noMsg (Attribute)</title>
<indexterm><primary>noMsg</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>noMsg</secondary></indexterm>
<programlisting>
<![CDATA[
>>--noMsg-----------------------------------------------------><
>>--noMsg = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::noMsg() [attribute] -->
<section id="atrNoStatus" xreflabel="noStatus"><title>noStatus (Attribute)</title>
<indexterm><primary>noStatus</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>noStatus</secondary></indexterm>
<programlisting>
<![CDATA[
>>--noStatus-----------------------------------------------------><
>>--noStatus = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::noStatus() [attribute] -->
<section id="atrRangeMax" xreflabel="rangeMax"><title>rangeMax (Attribute)</title>
<indexterm><primary>rangeMax</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>rangeMax</secondary></indexterm>
<programlisting>
<![CDATA[
>>--rangeMax-----------------------------------------------------><
>>--rangeMax = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::rangeMax() [attribute] -->
<section id="atrRangeMin" xreflabel="rangeMin"><title>rangeMin (Attribute)</title>
<indexterm><primary>rangeMin</primary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>rangeMin</secondary></indexterm>
<programlisting>
<![CDATA[
>>--rangeMin-----------------------------------------------------><
>>--rangeMin = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::rangeMin() [attribute] -->
<section id="atrWidthClsPropertyDialog" xreflabel="width"><title>width (Attribute)</title>
<indexterm><primary>width</primary><secondary>PropertyDialog class</secondary></indexterm>
<indexterm><primary>PropertyDialog class</primary><secondary>width</secondary></indexterm>
<programlisting>
<![CDATA[
>>--width-----------------------------------------------------><
>>--width = varName-------------------------------------------><
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertyDialog::width() [attribute] -->
<section id="mthBegin" xreflabel="begin"><title>begin</title>
<indexterm><primary>begin</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>begin</secondary></indexterm>
<programlisting>
<![CDATA[
>>--begin(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::begin() -->
<section id="mthCompleteClsProgressDialog" xreflabel="complete"><title>complete</title>
<indexterm><primary>complete</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>complete</secondary></indexterm>
<programlisting>
<![CDATA[
>>--complete(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::complete() -->
<section id="mthEndNow" xreflabel="endNow"><title>endNow</title>
<indexterm><primary>endNow</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>endNow</secondary></indexterm>
<programlisting>
<![CDATA[
>>--endNow(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::endNow() -->
<section id="mthIncrease" xreflabel="increase"><title>increase</title>
<indexterm><primary>increase</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>increase</secondary></indexterm>
<programlisting>
<![CDATA[
>>--increase(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::increase() -->
<section id="mthSetInterruptible" xreflabel="setInterruptible"><title>setInterruptible</title>
<indexterm><primary>setInterruptible</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>setInterruptible</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setInterruptible(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::setInterruptible() -->
<section id="mthUpdateStatus" xreflabel="updateStatus"><title>updateStatus</title>
<indexterm><primary>updateStatus</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>updateStatus</secondary></indexterm>
<programlisting>
<![CDATA[
>>--updateStatus(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::updateStatus() -->
<section id="mthUpdateStatusText" xreflabel="updateStatusText"><title>updateStatusText</title>
<indexterm><primary>updateStatusText</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>updateStatusText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--updateStatusText(--+--------+--)---------------------------------------------><
+--type--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>TERM</term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
xx
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ProgressDialog::updateStatusText() -->
</section> <!-- End ProgressDialog Class -->
<section id="clsAlerter" xreflabel="Alerter"><title>Alerter Class</title>
<indexterm><primary>Alerter class</primary></indexterm>
<indexterm><primary>ProgressDialog class</primary><secondary>Alerter class</secondary></indexterm>
<para>
An <computeroutput>Alerter</computeroutput> object is intended to be used as the argument to the <xref
linkend="mthSetInterruptible"/> method of the <xref linkend="clsProgressDialog"/> object, when the progress dialog can
always be canceled by the user, but the application needs to know if the user cancels.
</para>
<section id="sctMethodsAlerter"><title>Method Table</title>
<para>
The following table lists the class and instance methods of the <computeroutput>Alerter</computeroutput> class:
<table id="tblMethodsAlerter" frame="all"> <title>Alerter Class Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="4*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthNewClsAlerter"/> </entry>
<entry>Instantiates a new <computeroutput>Alerter</computeroutput> object.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
</row>
<row>
<entry><link linkend="mthNewClsAlerter">new</link></entry>
<entry>new</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthInterruptClsAlerter"/> </entry>
<entry>xx</entry>
</row>
<row>
<entry><xref linkend="mthInterruptibleClsAlerter"/></entry>
<entry>xx</entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="mthNewClsAlerter"><title>new (Class Method)</title>
<indexterm><primary>new</primary><secondary>Alerter class</secondary></indexterm>
<indexterm><primary>Alerter class</primary><secondary>new</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new------------------------------------------><
]]>
</programlisting>
<para>
A simple implementation of the <xref linkend="clsInterruptible"/> interface that can be used with a <xref
linkend="clsProgressDialog"/> object to notify the application that the user has canceled the progress dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments for this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a newly instantiated <computeroutput>Alerter</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
An <emphasis role="italic">Alerter</emphasis> object provides a concrete implementation of the two abstract methods of
the <computeroutput>Interruptible</computeroutput> interface. The object sets the <xref linkend="atrIsCanceled"/>
attributed to false on instantiation. if the <xref linkend="mthInterruptClsAlerter"/> method is invoked, the attribute is
set to true. This allows the application to test the value of the <emphasis role="italic">isCanceled</emphasis> attribute
to determine if the user has canceled the progress dialog.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Alerter::new() -->
<section id="atrIsCanceled" xreflabel="isCanceled"><title>isCanceled (Attribute)</title>
<indexterm><primary>isCanceled</primary></indexterm>
<indexterm><primary>Alerter class</primary><secondary>isCanceled</secondary></indexterm>
<programlisting>
<![CDATA[
>>--isCanceled-----------------------------------><
]]>
</programlisting>
<para>
Reflects the state of the internal canceled flag. The flag is false if the <xref linkend="mthInterruptClsAlerter"/> method
of this object has not been invoked and true if it has been invoked.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">isCanceled</emphasis> attribute is a <emphasis role="italic">get</emphasis> only attribute. The
programmer can not set the value of this attribute. It is set internally by the object and can not be changed.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Alerter::isCanceled() [attribute] -->
<section id="mthInterruptClsAlerter" xreflabel="interrupt"><title>interrupt</title>
<indexterm><primary>interrupt</primary><secondary>Alerter class</secondary></indexterm>
<indexterm><primary>Alerter class</primary><secondary>interrupt</secondary></indexterm>
<programlisting>
<![CDATA[
>>--interrupt------------------------------------><
]]>
</programlisting>
<para>
Signals this object that it is being interrupted.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments to this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method does not return any value.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">alerter</emphasis> object provides a concrete implmentation of the <xref
linkend="clsInterruptible"/> interface that can be used as the arguemnt to the <xref linkend="mthSetInterruptible"/>
method of the <xref linkend="clsProgressDialog"/>. It is intended to be used when the progress dialog can always be
canceled and provides a notification to the application if the progress dialog is canceled.
</para>
<para>
When the <emphasis role="italic">interrupt</emphasis> method is invoked, the <xref linkend="atrIsCanceled"/> attribute is
set to true. When used with the progress dialog object, the progress dialog invokes this method if the user cancels the
dialog. This allows the programmer to determine if the user has canceled the dialog by checking the <emphasis
role="italic">isCanceled</emphasis> attribute.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Alerter::interrupt() -->
<section id="mthInterruptibleClsAlerter" xreflabel="interruptible"><title>interruptible</title>
<indexterm><primary>interruptible</primary><secondary>Alerter class</secondary></indexterm>
<indexterm><primary>Alerter class</primary><secondary>interruptible</secondary></indexterm>
<programlisting>
<![CDATA[
>>--interruptible--------------------------------><
]]>
</programlisting>
<para>
Detemines if this object is interruptible at this point in time. By definition an <computeroutput>Alerter</computeroutput>
object is always interruptible.
</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>
This method always returns true.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">alerter</emphasis> object provides a concrete implmentation of the <xref
linkend="clsInterruptible"/> interface that can be used as the arguemnt to the <xref linkend="mthSetInterruptible"/>
method of the <xref linkend="clsProgressDialog"/>. It is intended to be used when the progress dialog can always be
canceled and provides a notification to the application if the progress dialog is canceled. When used with the progress
dialog object, the progress dialog invokes this method if the user cancels, to determine if it is okay to cancel, close,
the dialog. This method always returns true for that invocation.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Alerter::interruptible() -->
</section> <!-- End Alerter Class -->
<section id="clsInterruptible" xreflabel="Interruptible"><title>Interruptible Mixin Class</title>
<indexterm><primary>Interruptible class</primary></indexterm>
<para>
The <computeroutput>Interruptible</computeroutput> class defines an interface for an object that can be <emphasis
role="italic">interrupted</emphasis>, but possibly only interrupted at certain times. It does this by defining two abstract
methods. Users of the <computeroutput>Interruptible</computeroutput> class are expected to inherit this mixin class and
provide concrete implmentations of both abstract methods.
</para>
<para>
The <computeroutput>Interruptible</computeroutput> class is a helper class for the <xref linkend="clsProgressDialog"/>
class. Only <emphasis role="italic">interruptible</emphasis> objects can be used as an argument for the <xref
linkend="mthSetInterruptible"/> method. The progress dialog will invoke both methods of the
<computeroutput>Interruptible</computeroutput> object, so concrete implementations for both methods must be provided to
prevent syntax conditions from bein raised.
</para>
<section id="sctMethodsInterruptible"><title>Method Table</title>
<para>
The following table lists the abstract instance methods of the <computeroutput>Interruptible</computeroutput> mixin class:
<table id="tblMethodsInterruptible" frame="all"> <title>Interruptible Class Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="4*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthInterruptClsInterruptible"/> </entry>
<entry>Signals this object that it is being interrupted.</entry>
</row>
<row>
<entry><xref linkend="mthInterruptibleClsInterruptible"/></entry>
<entry>Detemines if this object is interruptible at this point in time.</entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="mthInterruptClsInterruptible" xreflabel="interrupt"><title>interrupt (abstract)</title>
<indexterm><primary>interrupt</primary><secondary>Interruptible class</secondary></indexterm>
<indexterm><primary>Interruptible class</primary><secondary>interrupt</secondary></indexterm>
<programlisting>
<![CDATA[
>>--interrupt------------------------------------><
]]>
</programlisting>
<para>
Signals this object that it is being interrupted.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments to this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method does not return any value
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The contract for this abstract method is that it will not receive any arguments and will not return any value.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Interruptible::interrupt() -->
<section id="mthInterruptibleClsInterruptible" xreflabel="interruptible"><title>interruptible (abstract)</title>
<indexterm><primary>interruptible</primary><secondary>Interruptible class</secondary></indexterm>
<indexterm><primary>Interruptible class</primary><secondary>interruptible</secondary></indexterm>
<programlisting>
<![CDATA[
>>--interruptible--------------------------------><
]]>
</programlisting>
<para>
Detemines if this object is interruptible at this point in time.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments for this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true if this object can be interrupted now. Returns false if this object should not be interrrupted now, but can
possibly be interrupted at a later time.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The contract for this abstract method is that it will not be passed any arguments and will always return either true or
false.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Interruptible::interruptible() -->
</section> <!-- End Interruptible Class -->
</section> <!-- End Progress Dialog section -->
<section id="clsSimpleFolderBrowse" xreflabel="SimpleFolderBrowse"><title>SimpleFolderBrowse Class</title>
<indexterm><primary>SimpleFolderBrowse class</primary></indexterm>
<para>
The SimpleFolderBrowse object displays the Windows common Browse For Folder dialog and returns the user's selection. It is
a simplified version of the <xref linkend="clsBrowseForFolder"/> dialog that is designed to be easy to use, and does not
have as many configuration options as the <computeroutput>BrowseForFolder</computeroutput> object does.
</para>
<para>
The Windows common Browse For Folder dialog allows the user to select a folder from a tree-like display of the computer's
file system. The Browse For Folder dialog is specifically for opening or choosing folders.
</para>
<section id="sctMethodsSimpleFolderBrowse"><title>Method Table</title>
<para>
The following table lists the class and instance methods of the <computeroutput>SimpleFolderBrowse</computeroutput> class.
This simple to use dialog only has a single class method:
<table id="tblMethodsSimpleFolderBrowse" frame="all"> <title>SimpleFolderBrowse Class Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="3*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthGetFolderClsSimpleFolderBrowse"/></entry>
<entry>Pops up the Browse For Folder Windows dialog and returns the user's selection.</entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="mthGetFolderClsSimpleFolderBrowse" xreflabel="getFolder"><title>getFolder (Class Method)</title>
<indexterm><primary>getFoder</primary><secondary>SimpleFolderBrowse class</secondary></indexterm>
<indexterm><primary>SimpleFolderBrowse class</primary><secondary>getFolder</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getFolder(--+---------+-------+-+------ +-+---------+-+--------+-+---------+--)--><
+--capt-+ +-,-bnr-+ +-,-hnt-+ +-,-start-+ +-,-root-+ +-,-owner-+
]]>
</programlisting>
<para>
Instantiates the Rexx SimpleBrowseFolder object, pops up the Windows Browse For Folder dialog, and returns the user's
selection in one step.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>capt [optional]</term>
<listitem>
<para>
Specifies a caption, or title, for the dialog. The Windows default title is <emphasis role="italic">Browse For
Folder</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>bnr [optional]</term>
<listitem>
<para>
Specifies text to use for what Windows calls the <emphasis role="italic">banner</emphasis> for the dialog. This string
is displayed above the tree view control in the dialog box. The string can be used to specify instructions to the user.
By default nothing is displayed for the banner and the area above the tree view is blank.
</para>
</listitem></varlistentry>
<varlistentry><term>hnt [optional]</term>
<listitem>
<para>
Specifies text to use for a <emphasis role="italic">hint</emphasis> in the dialog. The hint is displayed below the
bottom of the tree view control and above the bottom row of buttons of the dialog. By default there is no hint, and
the area where the hint would go is removed from the dialog. That is, the bottom row of buttons is placed directly
below the tree view.
</para>
</listitem></varlistentry>
<varlistentry><term>start [optional]</term>
<listitem>
<para>
Specifies an initial selected folder for the dialog. By default, the dialog opens with the top-most item in the tree
view selected. If a start folder is specified, the folder is selected and, if needed, the tree view items are expanded
and the tree view is scrolled so that the starting folder is visible in the tree view.
</para>
<para>
Testing indicates that the folder specified must be a fully qualified path name of an existing directory. If not, the
operating system seems to just ignore it.
</para>
</listitem></varlistentry>
<varlistentry><term>root [optional]</term>
<listitem>
<para>
Specifies the root for the tree view in the dialog. The root is the location of the root folder from which the user
starts browsing. Only the specified folder and any subfolders that are beneath it in the namespace hierarchy
will appear in the dialog box. The user can not browse above the root folder. If this argument is omitted, the
operating system uses the namespace root (the desktop folder.)
</para>
<para>
Specify either a fully qualified file system path name, or use one of the <xref linkend="sctSpecialFolderNames"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>owner [optional]</term>
<listitem>
<para>
The Rexx dialog object that is to be the owner window of the browse for folder dialog. The owner dialog is disabled
until the browse for folder dialog is closed by the user.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
If the user cancels the dialog, the empty string is returned, otherwise the fully qualified path to the folder the user
picked is returned. However it is possible to set up the dialog in a way such that the user can pick a virtual folder.
Virtual folders do not have a file system path. The <computeroutput>.nil</computeroutput> object is returned if a virtual
folder is picked.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <computeroutput>SimpleFolderBrowse</computeroutput> dialog is intended to be simple to use and is restricted to file
system paths. The Windows Browse For Folders dialog has more capabilities than can be accessed through the
<computeroutput>SimpleFolderBrowse</computeroutput> class, but the capabilities are less likely to be useful in most
ooRexx programs. The <xref linkend="clsBrowseForFolder"/> class allows access to all features of the Windows Browse For
Folders dialog, but it is correspondingly more complex to use.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example puts up the Browse For Folder dialog and gets the user's selection:
<programlisting>
<![CDATA[
folder = .SimpleFolderBrowse~getFolder
select
when folder == .nil then text = 'The user picked a virtual folder'
when folder == '' then text = 'The user canceled'
otherwise text = 'The user picked:' folder
end
-- End select
say text
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End SimpleFolderBrowse::new() -->
</section> <!-- End SimpleFolderBrowse Class -->
<section id="clsSingleSelection" xreflabel="SingleSelection"><title>SingleSelection Class</title>
<indexterm><primary>SingleSelection</primary><secondary>standard dialog</secondary></indexterm>
<indexterm><primary>standard dialogs</primary><secondary>SingleSelection</secondary></indexterm>
<para>
The <computeroutput>SingleSelection</computeroutput> class presents a dialog that has a group of <link
linkend="clsRadioButton">radio</link> buttons. The user can select only one item of the group, or cancel the dialog. The
programmer can specify how many radio buttons are in the group, if they should be placed in one, or several, columns. The
ooDialog framework internally handles all the layout of the controls of the dialog. This makes the dialog class very easy
to use.
</para>
<para>
The basic steps to user the <computeroutput>SingleSelection</computeroutput> are to instantiate the dialog using the
<emphasis role="italic">new</emphasis> method, run the dialog using the <emphasis role="italic">execute</emphasis> method,
and do something with the user's repsonse which is returned from the <emphasis role="italic">execute</emphasis> method.
</para>
<section id="mthNewClsSingleSelection" xreflabel="new"><title>new</title>
<indexterm><primary>new</primary><secondary>SingleSelection class</secondary></indexterm>
<indexterm><primary>SingleSelection class</primary><secondary>new</secondary></indexterm>
<programlisting>
<![CDATA[
>>-new(--msg--,--title--,--labels.--,--+----------+--+-----------+--+-------+--)--><
+-,-preSel-+ +-,-rbWidth-+ +-,-max-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>SingleSelection</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>msg [required]</term>
<listitem>
<para>
A text string that is displayed above the radio button group. Typically, the text would be used to give the user the
purpose of the radio buttons.
</para>
</listitem></varlistentry>
<varlistentry><term>title [required]</term>
<listitem>
<para>
A title, the caption bar text, for the dialog
</para>
</listitem></varlistentry>
<varlistentry><term>labels. [reuired]</term>
<listitem>
<para>
A stem with whole number numeric indexes, one through the number of radio buttons desired. The value for each index is
the label for the corresponding radio button. For instance <computeroutput>labels.2</computeroutput> would be set to
the label for the second radio button.
</para>
</listitem></varlistentry>
<varlistentry><term>preSel [optional]</term>
<listitem>
<para>
This argument can be used to preselect, (check,) one radio button. A value of 1 checks the first radio button, a
value of 2 checks the second, and so on. If this argument is omitted, the first radio button is checked.
</para>
</listitem></varlistentry>
<varlistentry><term>rbWidth [optiona]</term>
<listitem>
<para>
Specifies the width, in dialog units, of the radio button controls. If omitted, the width is calculated so that the
longest label will not be clipped. If used, all radio buttons are set to this width without regard as to whether the
label will be clipped or not.
</para>
</listitem></varlistentry>
<varlistentry><term>max [optional]</term>
<listitem>
<para>
The maximum number of radio buttons in one column. If there are more radio buttons than <emphasis
role="italic">max</emphasis>, that is, if the <emphasis role="italic">labels.</emphasis> argument has more indexes
than the value of <emphasis role="italic">max</emphasis>, the radio buttons are positioned in columns. Each column will
have <emphasis role="italic">max</emphasis> radio buttons and ther will be as many columns as needed to display all the
radio buttons.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example instantiates and executes a dialog that contains a two-column radio button group. The fifth radio
button (the button with the label May) is preselected.
<programlisting>
<![CDATA[
mon.1 = "January" ; mon.2 = "February" ; mon.3 = "March"
mon.4 = "April" ; mon.5 = "May" ; mon.6 = "June"
mon.7 = "July" ; mon.8 = "August" ; mon.9 = "September"
mon.10= "October" ; mon.11= "November" ; mon.12= "December"
dlg = .SingleSelection~new("Please select a month:", ,
"Single Selection", mon., 5, , 6)
s = dlg~execute
say "You Selected the month:" mon.s
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthExecuteClsSingleSelection" xreflabel="execute"><title>execute</title>
<indexterm><primary>execute</primary><secondary>SingleSelection class</secondary></indexterm>
<indexterm><primary>SingleSelection class</primary><secondary>execute</secondary></indexterm>
<programlisting>
<![CDATA[
>>--execute--------------------------------------><
]]>
</programlisting>
<para>
Executes the dialog and returns the user's selection or the empty string if the user cancels the dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments to this method
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
If the user cancels the dialog, the empty string is returned. If the user closes the dialog with <emphasis
role="italic">Ok</emphasis> the return is the number of the selected radio button. 1 for the first radio button, 2 for
the second radio button, 8 for the eighth radion button, etc., etc..
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When the <emphasis role="italic">execute</emphasis> method is invoked, the ooDialog framework, internally, does a number
of calculations to determine the optimal size of the dialog controls and dialog. The framework then positions all the
dialog controls such that none of the radio button labels, message, and title of the dialog are clipped.
</para>
<para>
The one exception to this is if the programmer specifies the width of the radio button controls using the optional
<emphasis role="italic">rbWidth</emphasis> argument in the <xref linkend="mthNewClsSingleSelection"/> method. In that
case the width of the radio buttons is always set to what the programmer has specified. It is possible that the radio
buttons will be clipped, but that is now the responsibility of the programmer.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example instantiates a single selection dialog
<programlisting>
<![CDATA[
rex.1 = "Regina" ; rex.2 = "ooRexx" ; rex.3 = "Reginald" ; rex.4 = "Personal Rexx"
d = .SingleSelection~new("Pick your favorite Rexx", "Rexx is King", rex., 2, , 2)
index = d~execute
if index == "" then say "You failed to pick a Rexx interpreter."
else say "The Rexx you picked:" rex.index
::requires 'ooDialog.cls'
/* Output will most likely be:
The Rexx you picked: ooRexx
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End SingleSelection::execute() -->
</section>
<section id="clsTimedMessage" xreflabel="TimedMessage"><title>TimedMessage Class</title>
<indexterm><primary>TimedMessage</primary>
<secondary>class</secondary></indexterm>
<indexterm><primary>standard dialogs</primary>
<secondary>TimedMessage</secondary></indexterm>
<para>The TimeMessage class shows a message window for
a defined duration. </para>
<para>The methods listed below are defined by this class.</para>
<section id="initTimedMessage" xreflabel="init"><title>init</title>
<indexterm><primary>init</primary>
<secondary>TimedMessage class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aTimedMessage~init(--msg-,-title-,-sleeping--+--------------+-+-----+--)----><
+-,-earlyReply-+ +-,-p-+
]]>
</programlisting>
<para>The init method prepares the dialog. </para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>message</term>
<listitem><para>A string that is displayed inside the window as a message. The length
of the message determines the horizontal size of all standard dialogs.
</para></listitem></varlistentry>
<varlistentry><term>title</term>
<listitem><para>A string that is displayed as the window title in the title bar of the
dialog
</para></listitem></varlistentry>
<varlistentry><term>sleeping</term>
<listitem><para>A number that determines how long (in milliseconds) the window
is shown. If this number is 0 or greater, the message window is shown for that
time and automatically dismisses itself. The programmer need take no further
action.
</para>
<para>If the number is less than 0 then the message window is shown
indefinitely. The <computeroutput>execute</computeroutput> method returns
immediately. In this case, the programmer needs to dismiss the window manually.
This is done by invoking the <computeroutput>ok</computeroutput> method. See
<emphasis role="bold">Example 2</emphasis> below.
</para></listitem></varlistentry>
<varlistentry><term>earlyReply</term>
<listitem><para>The optional early reply argument defaults to false. If used
and if true, the <computeroutput>execute</computeroutput> method of the dialog
returns immediately. This allows the code at the point where <computeroutput>
execute</computeroutput> was invoked to continue. The message windows continues
to display for its specified duration and then dismisses itself automatically.
</para></listitem></varlistentry>
<varlistentry><term>p [optional]</term>
<listitem>
<para>
A <xref linkend="clsPoint"/> object that specifies the position, in pixels, for the position of the timed
message dialog on the screen. By default the dialog is centered in the screen. If <emphasis role="italic">p</emphasis>
is used, the point specifies the position of the upper left corner of the dialog.
</para>
</listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry id="example1TimedMessage"><term><emphasis role="bold">Example
1:</emphasis></term>
<listitem><para>The following example shows a window with the title of <emphasis
role="italic">Infomation</emphasis> for a duration of 3 seconds:
<programlisting>
<![CDATA[
dlg = .TimedMessage~New("Application will be started, please wait", -
"Information", 3000)
dlg~execute
drop dlg
]]>
</programlisting>
</para></listitem></varlistentry>
<varlistentry id="example2TimedMessage"><term><emphasis role="bold">Example
2:</emphasis></term>
<listitem><para>The following example shows an introductory window that displays
while an application is doing its time consuming start up routine. Since this
start up process can vary in time depending on the individual system, the window
is set to display indefinitely. When the start up process is finished, the
programmer dismisses the window and destroys the dialog manually.
<programlisting>
<![CDATA[
dlg = .TimedMessage~New("The WidgetCreator Application - loading ...", -
"The Widget Factory", -1)
dlg~execute
ret = doStartup()
dlg~ok
drop dlg
if ret <> 0 then do
...
end
]]>
</programlisting>
</para></listitem></varlistentry>
<varlistentry id="example3TimedMessage"><term><emphasis role="bold">Example
3:</emphasis></term>
<listitem><para>The following example is a variation on <emphasis role="bold">
Example 2</emphasis>. In this case the Widget Factory executives decided that
they want their WidgeCreator splash screen to always display for 2 seconds to
the customer and then close. The early reply argument is used so that the start
up routine executes immediately. After 2 seconds the splash screen dismisses
and the dialog is destroyed automatically.
</para>
<note><title>Note</title><para>It is not necessary to explicitly drop the dlg
variable. That is shown in the other examples to emphasize the point that the
dialog has been destroyed.</para></note>
<programlisting> <![CDATA[
dlg = .TimedMessage~New("The WidgetCreator Application - loading ...", -
"The Widget Factory", 2000)
dlg~execute
if doStartup() <> 0 then do
...
end
]]>
</programlisting></listitem></varlistentry>
</variablelist>
</section>
<section id="defDlgTimedMessage"><title>defineDialog</title>
<indexterm><primary>Define</primary>
<secondary>TimedMessage</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aTimedMessage~DefineDialog----------------------------------><
]]>
</programlisting>
<para>The defineDialog method is called by the create method of the parent
class, PlainUserDialog, which in turn is called at the very beginning of
Execute. You do not have to call it. However, you may want to over-ride it in
your subclass to add more dialog controls to the window. If you over-ride it,
you have to forward the message to the parent class by using the keyword super.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example shows how to subclass the TimedMessage
class and how to add a background bitmap to the dialog window:
<programlisting>
<![CDATA[
::class MyTimedMessage subclass TimedMessage inherit DialogExtensions
::method defineDialog
self~backgroundBitmap("mybackg.bmp", "USEPAL")
self~DefineDialog:super()
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="h002097"><title>execute</title>
<indexterm><primary>execute</primary>
<secondary>TimedMessage class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aTimedMessage~Execute---------------------------------------><
]]>
</programlisting>
<para>
The execute method creates and shows the message window. If the specified <link linkend="initTimedMessage">duration</link>
is not negative, this method destroys the dialog automatically when the duration is up. If the duration is less than 0,
then the programmer must destroy the dialog manually by invoking the <computeroutput>ok</computeroutput> method. See this
<link linkend="example2TimedMessage">example</link> for a code snippet showing the procedure.
</para>
</section>
</section>
</section>
<section id="sctPublicRoutines"><title>Public Routines</title>
<indexterm><primary>ooDialog public routines</primary></indexterm>
<para>
The routines listed in this section can be used in any Rexx program. They are designed to be even easier to use than
the standard dialogs. Simply add a requires directive for the <computeroutput>ooDialog.cls</computeroutput> file in
a Rexx program to use any of these routines.
<programlisting>
<![CDATA[
::requires ooDialog.cls
]]>
</programlisting>
</para>
<section id="rtnAskDialog" xreflabel="AskDialog"><title>AskDialog Routine</title>
<indexterm><primary>AskDialog</primary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>AskDialog</secondary></indexterm>
<para>Pops up a message box containing the specified text, a Yes button, and
a No Button.</para>
<programlisting>
<![CDATA[
>>-AskDialog(--question--+-------------------+--)-------------><
+--, defaultbutton--+
]]>
</programlisting>
<para></para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>question</term>
<listitem><para>Text to be displayed in the message box.
</para></listitem></varlistentry>
<varlistentry><term>defaultbutton</term>
<listitem><para>Specifies which button, the Yes or the No button, has the
default focus when the message box pops up. This argument can be Yes or No and
is optional. If the argument is omitted, the Yes button will be given the focus.
Only the first letter of the option is needed and case is not significant.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term>Return Values:</term>
<listitem><para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>The No button has been selected.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>The Yes button has been selected.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="rtnCheckList" xreflabel="CheckList"><title>CheckList Routine</title>
<indexterm><primary>CheckList</primary>
<secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>CheckList</secondary></indexterm>
<para>A shortcut function to invoke the <xref linkend="clsCheckList"/>
dialog: </para>
<programlisting>
<![CDATA[
>>--CheckList(--message--,--title--,--labels--,-+-----------+---->
+-,--checks-+
>---+------------------------+--)-------------------------------><
+-,--+-----+--+--------+-+
+-len-+ +-,--max-+
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are similar to what is described in the <xref linkend="initCheckList"/>) method of the
<computeroutput>CheckList</computeroutput> class. However, instead of stems, arrays are passed into and returned from the
function.
<variablelist>
<varlistentry><term>message</term>
<listitem><para>A text string that is displayed on top of the check box group.
It could be used, for example, to give the user a hint as to what to do.
</para></listitem></varlistentry>
<varlistentry><term>title</term>
<listitem><para>A text string for the dialog's title
</para></listitem></varlistentry>
<varlistentry><term>labels</term>
<listitem><para>An array containing the labels, in order, for each of the check
boxes. The dialog will contain a check box for each label.
</para></listitem></varlistentry>
<varlistentry><term>checks</term>
<listitem><para>This argument is an array that allows you to pre-check any of
the check boxes. For each index in this array whose item is <computeroutput>
.true</computeroutput>, (or 1,) the check box at the corresponding index in the
<computeroutput>labels</computeroutput> array will be checked. For any index
that is not <computeroutput>.true </computeroutput>, the corresponding check box
will not be checked. This means that the programmer only needs to put a
<computeroutput>.true</computeroutput> at the indexes where he wants the check
boxes checked. All the other indexes can be left empty.
</para></listitem></varlistentry>
<varlistentry><term>len</term>
<listitem><para>Determines the length (in dialog units) of the check boxes and
labels. If omitted, the size is calculated to fit the largest label.
</para></listitem></varlistentry>
<varlistentry><term>max</term>
<listitem><para>The maximum number of check boxes in one column. If there are
more check boxes than max, that is, if labels has more items than the value of
max, the check boxes will be put into columns. Each column will contain no more
than the number of check boxes specified by max.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>If the user cancels the dialog, then <computeroutput>.nil
</computeroutput> is returned. If the user clicks the okay button, then an
array is returned. The array will be the same size as the input
<computeroutput>labels</computeroutput> array. Each index of the returned array
will contain <computeroutput>.true</computeroutput> if the corresponding check
box was checked by the user or will contain <computeroutput>.false
</computeroutput> if the check box was not checked.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem><para>The following example show how to use the
<computeroutput>CheckList</computeroutput> public routine:
<programlisting>
<![CDATA[
weekdays = .array~of("Monday","Tuesday","Wednesday","Thursday", -
"Friday","Saturday","Sunday")
-- Monday and Tuesday will be checked, all the rest will not be checked.
checks = .array~of(.true, .true, .false)
checks[5] = 0
checks[7] = 'a'
-- The labels will be 60 dialog units wide and there will be at most 4 check
-- boxes in a column. (Only 7 check boxes, so 2 columns, the first with 4
-- check boxes, the second with 3.)
days = CheckList("Check the days", "Working Days", weekdays, checks, 60, 4)
if days <> .Nil then do i = 1 to days~items
if days[i] then say "Working day =" weekdays[i]
end
::requires "ooDialog.cls"
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="rtnErrorDialog" xreflabel="ErrorDialog"><title>ErrorDialog Routine</title>
<indexterm><primary>ErrorDialog</primary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>ErrorDialog</secondary></indexterm>
<para>Pops up a message box containing the specified text, an OK button, and
an error symbol.</para>
<programlisting>
<![CDATA[
>>-ErrorDialog(--error_text--)--------------------------------><
]]>
</programlisting>
<para></para>
<variablelist>
<varlistentry><term><emphasis role="bold">Argument:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>error_text</term>
<listitem><para>Text to be displayed in the message box.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="rtnFileNameDialog" xreflabel="FileNameDialog"><title>FileNameDialog Routine</title>
<indexterm><primary>FilenameDialog</primary></indexterm>
<indexterm><primary>public routines</primary><secondary>FileNameDialog</secondary></indexterm>
<programlisting>
<![CDATA[
>>-FileNameDialog(-+-----+-+----------+-+-------+-+--------+-+---------+-->
+-sel-+ +-,-parent-+ +-,-msk-+ +-,-type-+ +-,-title-+
>-----------------+----------+-+---------+-+-----------+--)---------------><
+-,-defExt-+ +-,-multi-+ +-,-sepChar-+
]]>
</programlisting>
<para>
Causes a file selection dialog box to appear. File selection dialogs are used to allow the user to pick a file or set
of files to open, or to pick a file to save to.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>sel [optional]</term>
<listitem>
<para>
This argument can be used to pre-select a file and / or have the open or save dialog start in a specified
directory.
</para>
<para>
This argument initializes the open or save dialog by selecting the specified file and placing its name in the
<emphasis role="italic">File</emphasis> edit control of the dialog. In addition this argument can also be used to
specify the initial directory (folder) the dialog opens in.
</para>
<para>
When this argument contains no path information, then the <emphasis role="italic">File</emphasis> name edit
control will contain the argument and the initial directory is determined by the operating system. Which
directory the operating system picks varies slightly between versions of Windows. But, in general, it will be a
directory previously used in one of the Windows common dialogs, or a directory in the users My Documents folder.
</para>
<para>
If the argument contains file name and path information, the initial directory will be determined by the path
information and the <emphasis role="italic">File</emphasis> name edit control will contain the file information.
When the selfile argument contains only path information and no file name information, i.e. the
argument ends with a back slash <emphasis role="italic">\</emphasis>, then the initial directory will be that
path and the <emphasis role="italic">File</emphasis> name edit control will be left blank.
</para>
<para>
In cases where the argument contains incorrect path information, the initial directory is determined as if no path
information had been supplied and the entire value of the argument is placed in the File name field.
</para>
<para>
<emphasis role="bold">Note</emphasis> that Windows treats normal wild card characters as valid for file names.
Therefore, values such as <emphasis role="italic">C:\*.*</emphasis> or <emphasis
role="italic">C:\Windows\*.exe</emphasis> are acceptable for this argument.
</para>
</listitem></varlistentry>
<varlistentry><term>parent [optional]</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> of a parent window for the open or save file dialog. Normally
the programmer would use the handle of a dialog in her program. The operating system disables the parent window
until the user closes the open or save dialog.
</para>
</listitem></varlistentry>
<varlistentry><term>msk [optional]</term>
<listitem>
<para>
This argument contsists of pairs of filter strings where each of the filter strings is separated with a
<computeroutput>'0'x</computeroutput> character and the pairs of strings within a filter are also seperated with a
<computeroutput>'0'x</computeroutput> charatcter. The first string in each pair describes the filter and the
second string in the pair is a list of file patterns to use for the filter. For instance, if the file pattern
filter is <computeroutput>*.txt</computeroutput> then only files with the extension of
<computeroutput>.txt</computeroutput> are displayed in the dialog. The file pattern can consist of any valid file
name characters and and the asterisk (*) wildcard character. But the pattern can not contain any space characters.
</para>
<para>
An example of how to construct this string is as follows:
<programlisting>
<![CDATA[
delimiter = '0'x
pair1 = "DLL Files (*.dll)"delimiter"*.dll"delimiter
pair2 = "Class Files (*.cls)"delimiter"*.cls"delimiter
filter = pair1 || pair2
]]>
</programlisting>
To specify multiple file extension patterns for a single display string, use a semicolon to separate the patterns,
for example:
<programlisting>
<![CDATA[
delimiter = '0'x
pair1 = "Text Files (*.txt)"delimiter"*.txt;*.bak;*.doc"delimiter
pair2 = "Class Files (*.cls)"delimiter"*.cls"delimiter
filter = pair1 || pair2
]]>
</programlisting>
</para>
<para>
The operating system does not change the order of the filters. In the open or save dialog the filters are
dislpayed in the File Types combo box in the order specified in the <emphasis role="italic">mask</emphasis>
argument.
</para>
<para>
To have the dialog box not display any filters, use the empty string for this argument. The default filter string
when this argument is omitted is:
<programlisting>
<![CDATA[
delimiter = '0'x
"Text Files (*.txt)"delimiter"*.txt"delimiter"All Files (*.*)"delimiter"*.*"delimiter
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term>type [optional]</term>
<listitem>
<para>
A keyword specifying if the <emphasis role="italic">File Open</emphasis> or <emphasis role="italic">File
Save</emphasis> dialog is displayed. By default the <emphasis role="italic">File Open</emphasis> is used. The
keyword can be <emphasis role="italic">LOAD</emphasis> for the file open dialog or <emphasis
role="italic">SAVE</emphasis> for the file save dialog. Only the first letter of the argument is needed and case
is not significant.
</para>
<para>
If the <emphasis role="italic">File Save</emphasis> dialog is not explicitly requested, the <emphasis role="italic">File Open</emphasis>
dialog is always presented. For historic reasons this argument can also be <computeroutput>1</computeroutput> for
the <emphasis role="italic">File Open</emphasis> dialog or <computeroutput>0</computeroutput> for the
<computeroutput>File Save</computeroutput> dialog.
</para>
</listitem></varlistentry>
<varlistentry><term>title [optional]</term>
<listitem>
<para>
The window title for the save or open file idlaog. The default is <emphasis role="italic">Open a File</emphasis>
or <emphasis role="italic">Save File As</emphasis>, depending on what is specified for the <emphasis
role="italic">type</emphasis> argument.
</para>
</listitem></varlistentry>
<varlistentry><term>defExt [optional]</term>
<listitem>
<para>
The default file extension. The <emphasis role="italic">File Open</emphasis> or <emphasis role="italic">File
Save</emphasis> dialog append this extension if the user does not type an extension. Although this extension can
be any length, the opererating system only uses the first 3 characters. The string must not include the <emphasis
role="italic">.</emphasis> character.
</para>
<para>
If this argument is omitted, <emphasis role="italic">txt</emphasis> is used. To prevent the operating system from
appending an extension, the programmer should use the empty string for this argument.
</para>
</listitem></varlistentry>
<varlistentry><term>multi [optional]</term>
<listitem>
<para>
Specifies if the <emphasis role="italic">File Open</emphasis> dialog allows selection of multiple files. Normally,
the open dialog allows the user to select one file only. This can be changed by specifying the keyword <emphasis
role="italic">MULTI</emphasis> for this option. Only the first letter is needed and case is not significant.
</para>
<para>
This option is ignored for <emphasis role="italic">File Save</emphasis> dialogs. If the multiple file selection is
enabled and the user selects multiple files, the returned result is then: <computeroutput>path file1 file2 file3
...</computeroutput>
</para>
</listitem></varlistentry>
<varlistentry><term>sepChar [optional]</term>
<listitem>
<para>
Specifies the separation character for the returned path and file names. This is needed for file names with blank
characters. If this argument is omitted, the separation character is a blank. If the argument is specified, the
returned path and file name string uses this separation character. For example, if you specify <emphasis
role="italic">#</emphasis> as the separation character, the return string might look as follows:
<programlisting>
<![CDATA[
C:\WINNT#file with blank.ext#fileWithNoBlank.TXT
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the selected file name or 0 if the user cancels the dialog. Open file dialogs with multiple selection return
<computeroutput>path file1 file2 file3 ...</computeroutput> when the user selects multiple files.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
If the user changes directory with the <emphasis role="italic">File Open</emphasis> or <computeroutput>File
Save</computeroutput> dialog, then the current directory of the Rexx program will be changed. This is the behavior
of the underlying Windows dialog, which is designed to work that way. The ooDialog programmer should be aware of
this behavior and insert code to change the directory back if that is needed. For example:
<programlisting>
<![CDATA[
curdir = directory()
file = FileNameDialog("*.pdf", , "Adobe PDF Files"'0'x"*.pdf"'0'x)
call directory curdir
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="rtnInfoDialog" xreflabel="InfoDialog"><title>InfoDialog Routine</title>
<indexterm><primary>InfoDialog</primary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>InfoDialog</secondary></indexterm>
<para>Pops up a message box containing the specified text and an OK button.</para>
<programlisting>
<![CDATA[
>>-InfoDialog(--info_text--)----------------------------------><
]]>
</programlisting>
<para></para>
<variablelist>
<varlistentry><term><emphasis role="bold">Argument:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>info_text</term>
<listitem><para>Text to be displayed in the message box.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="rtnInputBox" xreflabel="InputBox"><title>InputBox Routine</title>
<indexterm><primary>InputBox</primary>
<secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>InputBox</secondary></indexterm>
<para>
A shortcut function to invoke an <xref linkend="clsInputBox"/> dialog as a function:
</para>
<programlisting>
<![CDATA[
say "Your name:" InputBox("Please enter your name","Personal Data")
]]>
</programlisting>
<para>
The parameters are described in the <xref linkend="initInputBox"/> method of the<computeroutput>InputBox</computeroutput>
class.
</para>
</section>
<section id="rtnIntegerBox" xreflabel="IntegerBox"><title>IntegerBox Routine</title>
<indexterm><primary>IntegerBox</primary>
<secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>IntegerBox</secondary></indexterm>
<para>A shortcut to invoke an <xref linkend="clsIntegerBox"/>
dialog as a function:
</para>
<programlisting>
<![CDATA[
say "Your age:" IntegerBox("Please enter your age","Personal Data")
]]>
</programlisting>
<para>
The parameters are described in the <xref linkend="initInputBox"/> method of the <computeroutput>InputBox</computeroutput>
class.
</para>
</section>
<section id="rtnListChoice" xreflabel="ListChoice"><title>ListChoice Routine</title>
<indexterm><primary>ListChoice</primary>
<secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>ListChoice</secondary></indexterm>
<para>The ListChoice function provides a shortcut to invoke a
<xref linkend="clsListChoice"/> dialog:
</para>
<programlisting>
<![CDATA[
day = ListChoice("Select a day","My favorite day", ,
.array~of("Monday","Tuesday","Wednesday","Thursday", ,
"Friday","Saturday","Sunday") , , ,"Thursday")
say "Your favorite day is" day
]]>
</programlisting>
<para>
The parameters are described in the <xref linkend="initListChoice"/> method of the
<computeroutput>ListChoice</computeroutput> class. However, instead of an input stem an array is passed into the function.
</para>
<para>If the user cancels the dialog <computeroutput>.nil</computeroutput> is
returned rather than the empty string.
</para>
</section>
<section id="rtnMessageDialog" xreflabel="MessageDialog"><title>MessageDialog Routine</title>
<indexterm><primary>MessageDialog</primary></indexterm>
<indexterm><primary>public routines</primary><secondary>MessageDialog</secondary></indexterm>
<programlisting>
<![CDATA[
>>--MessageDialog(--msg-+--------+-+-------+-+------+-+--------+-+--------+-)---><
+-,-hwnd-+ +-,-cap-+ +-,-pb-+ +-,-icon-+ +-,-misc-+
]]>
</programlisting>
<para>
Displays a message box on the screen with the options specified.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>msg [required]</term>
<listitem>
<para>
The message text to be displayed.
</para>
</listitem></varlistentry>
<varlistentry><term>hwnd [optional]</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> of the owner window for the message box. The owner window is
disabled until the user closes the message box. If this argument is omitted, the ooDialog framework will use the
last created, topmost, dialog as the owner window. To explicitly choose that there should be no owner window,
specify <computeroutput>0</computeroutput> for this argument.
</para>
</listitem></varlistentry>
<varlistentry><term>cap [optional]</term>
<listitem>
<para>
The caption, or title, of the message box. The default title when omitted is: <emphasis role="italic">ooDialog
Application Message</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>pb [optional]</term>
<listitem>
<para>
The <emphasis role="italic">pb</emphasis> argument specifies which push buttons the message box will have. The
default if this argument is omitted is a single Ok button. Otherwise, use exactly one of the following keywords,
case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>ABORTRETRYIGNORE </member>
<member>CANCELTRYCONTINUE</member>
<member>OK </member>
<member>OKCANCEL </member>
<member>RETRYCANCEL </member>
<member>YESNO </member>
<member>YESNOCANCEL </member>
</simplelist>
<variablelist>
<varlistentry><term>ABORTRETRYIGNORE</term>
<listitem>
<para>
The message box wil have three push buttons: <emphasis role="bold">Abort</emphasis>, <emphasis
role="bold">Retry</emphasis>, and <emphasis role="bold">Ignore</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>CANCELTRYCONTINUE</term>
<listitem>
<para>
The message box wil have three push buttons: <emphasis role="bold">Cancel</emphasis>, <emphasis
role="bold">Try Again</emphasis>, and <emphasis role="bold">Continue</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>OK</term>
<listitem>
<para>
The message box wil have one push button: <emphasis role="bold">Ok</emphasis>. This is the default if the
argument is omitted.
</para>
</listitem></varlistentry>
<varlistentry><term>OKCANCEL</term>
<listitem>
<para>
The message box wil have two push buttons: <emphasis role="bold">Ok</emphasis> and <emphasis
role="bold">Cancel</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>RETRYCANCEL</term>
<listitem>
<para>
The message box wil have two push buttons: <emphasis role="bold">Retry</emphasis> and <emphasis
role="bold">Cancel</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>YESNO</term>
<listitem>
<para>
The message box wil have two push buttons: <emphasis role="bold">Yes</emphasis> and <emphasis
role="bold">No</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>YESNOCANCEL</term>
<listitem>
<para>
The message box wil have three push buttons: <emphasis role="bold">Yes</emphasis>, <emphasis
role="bold">No</emphasis>, and <emphasis role="bold">Cancel</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>icon [optional]</term>
<listitem>
<para>
The <emphasis role="italic">icon</emphasis> argument specifies the icon placed in the message box. If this
argument is omitted then the message box will not display an icon. Note that several keywords may specify the
same icon. To have an icon appear in the message box, use exactly one of the following keywords, case is not
significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>EXCLAMATION</member>
<member>WARNING </member>
<member>INFORMATION</member>
<member>ASTERISK </member>
<member>QUESTION </member>
<member>STOP </member>
<member>ERROR </member>
<member>HAND </member>
<member>QUERY </member>
<member>NONE </member>
</simplelist>
<variablelist>
<varlistentry><term>EXCLAMATION</term>
<listitem>
<para>
The message box will have an exclamation-point icon.
</para>
</listitem></varlistentry>
<varlistentry><term>WARNING</term>
<listitem>
<para>
The message box will have an exclamation-point icon.
</para>
</listitem></varlistentry>
<varlistentry><term>INFORMATION</term>
<listitem>
<para>
The message box will have an icon consisting of a lowercase letter i in a circle.
</para>
</listitem></varlistentry>
<varlistentry><term>ASTERISK</term>
<listitem>
<para>
The message box will have an icon consisting of a lowercase letter i in a circle.
</para>
</listitem></varlistentry>
<varlistentry><term>QUESTION</term>
<listitem>
<para>
The message box will have a question-mark icon. Microsoft recommends that this icon not be used any more for
a number of reasons. If you want your Rexx programs to have the same look and feel of other Windows
programs, then you should not use the question-mark icon.
</para>
</listitem></varlistentry>
<varlistentry><term>STOP</term>
<listitem>
<para>
The message box will have a stop-sign icon.
</para>
</listitem></varlistentry>
<varlistentry><term>ERROR</term>
<listitem>
<para>
The message box will have a stop-sign icon.
</para>
</listitem></varlistentry>
<varlistentry><term>HAND</term>
<listitem>
<para>
The message box will have a stop-sign icon.
</para>
</listitem></varlistentry>
<varlistentry><term>QUERY</term>
<listitem>
<para>
The message box will have a question-mark icon, same as the QUESTION keyword. Microsoft recommends not using
this icon.
</para>
</listitem></varlistentry>
<varlistentry><term>NONE</term>
<listitem>
<para>
Used to allow the programmer to explicitly state that the message box should not have an icon. Omitting the
<emphasis role="italic">icon</emphasis> argument altogether has the same effect.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>misc [optional]</term>
<listitem>
<para>
The <emphasis role="italic">misc</emphasis> argument specifies a number of other attributes that can be set for
the message box. The argument consists of a blank separated string of keywords from the lists below. The
default if this argument is omitted is <computeroutput>"DEFBUTTON1 APPLMODAL"</computeroutput>.
</para>
<para>
The keywords are divided up into four groups. Except for the <emphasis role="italic">other
miscellaneous</emphasis> group, only one keyword from each groupd should be used, case is not significant. If
more than one keyword in a group is used, the behavior is undefined.
</para>
<para>
These keywords are used to select the default push button when the message box is shown. Use only one keyword
from this group.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>DEFBUTTON1</member>
<member>DEFBUTTON2</member>
<member>DEFBUTTON3</member>
<member>DEFBUTTON4</member>
</simplelist>
<variablelist>
<varlistentry><term>DEFBUTTON1</term>
<listitem>
<para>
The first button is the default button. This is the default value if none of the other default button
keywords are used.
</para>
</listitem></varlistentry>
<varlistentry><term>DEFBUTTON2</term>
<listitem>
<para>
The second button is the default button.
</para>
</listitem></varlistentry>
<varlistentry><term>DEFBUTTON3</term>
<listitem>
<para>
The third button is the default button.
</para>
</listitem></varlistentry>
<varlistentry><term>DEFBUTTON4</term>
<listitem>
<para>
The fourth button is the default button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
<para>
These keywords are used to indicate the <link linkend="defModalModeless">modality</link> of the message box.
<emphasis role="bold">Note</emphasis> that the description of the modality behaviour here assumes that the window
specified by the <emphasis role="italic">hwnd</emphasis> argument belongs to the programmer's Rexx application. Use
only one keyword from this group.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>APPLMODAL </member>
<member>SYSTEMMODAL</member>
<member>TASKMODAL </member>
</simplelist>
<variablelist>
<varlistentry><term>APPLMODAL</term>
<listitem>
<para>
Application Modal: The user must close the message box before continuing to work in the window specified by
the <emphasis role="italic">hwnd</emphasis> argument. However, the user can move to windows on the desktop
not part of the application and work in those windows.
</para>
<para>
Depending on the hierarchy of windows in the application, the user may be able to move to other windows
within the application. However, all child windows of the owner window of the message box are automatically
disabled.
</para>
<para>
APPLMODAL is the default if neither SYSTEMMODAL nor TASKMODAL are specified.
</para>
</listitem></varlistentry>
<varlistentry><term>SYSTEMMODAL</term>
<listitem>
<para>
System Modal: The modality for this keyword is the same as APPLMODAL except that the message box will have
the topmost style. This means that the message box will stay on top of other windows not part of the
application, if the user moves to those windows.
</para>
<para>
Microsoft suggests that this type of message box be used to notify the user of serious, potentially
damaging errors that require immediate attention. SYSTEMMODAL has no effect on the user's ability to
interact with windows other than those associated with the <emphasis role="italic">hwnd</emphasis> argument.
</para>
</listitem></varlistentry>
<varlistentry><term>TASKMODAL</term>
<listitem>
<para>
Task Modal: This is the same as APPLMODAL except that all the top-level windows belonging to the current
thread are disabled if the <emphasis role="italic">hwnd</emphasis> argument is 0. Use this keyword when the
the programmer does not have a window handle available but still needs to prevent input to other windows in
the application.
</para>
</listitem></varlistentry>
</variablelist>
</para>
<para>
Other miscellaneous keywords. One or more keywords from this group can be used..
</para>
<para>
<simplelist type='vert' columns='3'>
<member>DEFAULTDESKTOP </member>
<member>RIGHT </member>
<member>RTLREADING </member>
<member>SETFOREGROUND </member>
<member>TOPMOST </member>
<member>SERVICENOTIFICATION</member>
</simplelist>
<variablelist>
<varlistentry><term>DEFAULTDESKTOP</term>
<listitem>
<para>
Same as the desktop of the interactive window station. The programmer should consult the Windows
<xref linkend="defWindowsDoc"/> when considering to use this keyword.
</para>
</listitem></varlistentry>
<varlistentry><term>RIGHT</term>
<listitem>
<para>
The message text is right-justified.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Displays the message and caption text using right-to-left reading order on Hebrew and Arabic systems.
</para>
</listitem></varlistentry>
<varlistentry><term>SETFOREGROUND</term>
<listitem>
<para>
The operating system, internally, sets the message box as the foreground window.
</para>
</listitem></varlistentry>
<varlistentry><term>TOPMOST</term>
<listitem>
<para>
The message box will have the topmost window style. This will keep the message box above all other windows
on the desktop.
</para>
</listitem></varlistentry>
<varlistentry><term>SERVICENOTIFICATION</term>
<listitem>
<para>
The application dialog calling the <emphasis role="italic">MessageDialog</emphasis> routine is a service
notifying the user of an event. The <emphasis role="italic">MessageDialog</emphasis> displays a message box
on the current active desktop, even if there is no user logged on to the computer.
</para>
<para>
ooDialog and Rexx programs in general are not particularly suited to implement Windows services. So it is
unlikely that this keyword will be used.
</para>
</listitem></varlistentry>
<varlistentry><term>HELP</term>
<listitem>
<para>
Adds a <emphasis role="bold">Help</emphasis> push button to the message box, in addition to the push buttons
specifed in the <emphasis role="italic">pb</emphasis> argument. When the user clicks the <emphasis
role="bold">Help</emphasis> button or presses F1, the operating system sends a HELP <xref
linkend="ovvEvents"/> notification to the window specified by the <emphasis role="italic">hwnd</emphasis>
argument. If this window is an ooDialog dialog, the programmer can capture this notification using the
<xref linkend="mthConnectHelp"/> method.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
<emphasis role="italic">MessageDialog</emphasis> returns the Microsoft defined resource ID of the button pushed by
the user, and 0 on error. The programmer can use a <link linkend="sctMethodsDlgObject">constant</link> of the
<xref linkend="chpDialogObject"/> object to determine the return. The return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
An error ocurred. the <xref linkend="dotSystemErrorCode"/> will be set.
</para>
</listitem></varlistentry>
<varlistentry><term>1 IDOK</term>
<listitem>
<para>
The <emphasis role="bold">Ok</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>2 IDCANCEL</term>
<listitem>
<para>
The <emphasis role="bold">Cancel</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>3 IDABORT</term>
<listitem>
<para>
The <emphasis role="bold">Abort</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>4 IDRETRY</term>
<listitem>
<para>
The <emphasis role="bold">Retry</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>5 IDIGNORE</term>
<listitem>
<para>
The <emphasis role="bold">Ignore</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>6 IDYES</term>
<listitem>
<para>
The <emphasis role="bold">Yes</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>7 IDNO</term>
<listitem>
<para>
The <emphasis role="bold">No</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>8 IDCLOSE</term>
<listitem>
<para>
The <emphasis role="bold">Close</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>9 IDHELP</term>
<listitem>
<para>
The <emphasis role="bold">Help</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>10 IDTRYAGAIN</term>
<listitem>
<para>
The <emphasis role="bold">Try Again</emphasis> button was pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>11 IDCONTINUE</term>
<listitem>
<para>
The <emphasis role="bold">Continue</emphasis> button was pushed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When the message box has a <emphasis role="bold">Cancel</emphasis> button, IDCANCEL is also returned if the user
uses the ESC key. If the message box does not have a <emphasis role="bold">Cancel</emphasis> button, then the user
can not close the message box by using the ESC key.
</para>
<para>
The <xref linkend="rtnAskDialog"/>, <xref linkend="rtnInfoDialog"/>, and
<xref linkend="rtnErrorDialog"/> routines are all implemented using the
<computeroutput>MessageDialog</computeroutput> routine. While they are simplier to use, they are not very flexible.
In addition because of the way <xref linkend="defModalModeless"/> dialogs are implemented, it is possbile that those
routines will not diable the correct dialog. If the programmer encounters problems with the wrong dialog being disabled,
the solution is to use the <computeroutput>MessageDialog</computeroutput> routine and specify the
proper window handle of the owner window.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example is from a Wizard 97 program that warns the user when she is about to change the page and has not
completed all of the steps on the page she is on.
<programlisting>
<![CDATA[
::method wizNext unguarded
expose selectedMovies movieTheaters movieCombo
use arg propSheet
do movie over selectedMovies
if movieTheaters[movie] == .nil then do
msg = "Warning. You have not selected a movie" || .endOfLine || -
"theater for all selected movies." || .endOfLine~copies(2) || -
"Are you sure you want to go to" || .endOfLine || -
"the next page?"
title = "Theater Selection is not Complete"
buttons = "YESNO"
icon = "WARNING"
style = "DEFBUTTON2 TASKMODAL"
ans = MessageDialog(msg, propSheet~dlgHandle, title, buttons, icon, style)
if ans == .PlainBaseDialog~IDYES then return 0
movieCombo~select(movie)
self~setRadioButtons(movie)
return -1
end
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End public routines::messageDialog() -->
<section id="rtnMultiInputBox" xreflabel="MultiInputBox"><title>MultiInputBox Routine</title>
<indexterm><primary>MultiInputBox</primary>
<secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>MultiInputBox</secondary></indexterm>
<para>Provides a shortcut function to invoke a
<xref linkend="clsMultiInputBox"/> dialog:</para>
<programlisting>
<![CDATA[
res = MultiInputBox("Enter your address","Personal Data", ,
.array~of("&First name","Last &name","&City"), ,
.array~of("John","Smith","San Jose"), 100)
if res \= .Nil then do entry over res
say "Address-line[]= " entry
end
]]>
</programlisting>
<para>
The parameters are described in the <xref linkend="initMultiInputBox"/> method of the
<computeroutput>MultiInputBox</computeroutput> class. However, instead of using stems, arrays are used for input.
</para>
<para>The user's input to the dialog is also returned in an array. Note this
other difference from the MultiInputBox dialog: if the user cancels the dialog
<computeroutput>.nil</computeroutput> is returned rather than the empty string.
</para>
</section>
<section id="rtnMultiListChoice" xreflabel="MultiListChoice"><title>MultiListChoice Routine</title>
<indexterm><primary>MultiListChoice</primary>
<secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>MultiListChoice</secondary></indexterm>
<para>Provides a shortcut to invoke a
<xref linkend="clsMultiListChoice"/> dialog as a function:
</para>
<programlisting>
<![CDATA[
days = MultiListChoice("Select days","My TV Days", ,
.array~of("Monday","Tuesday","Wednesday", ,
"Thursday","Friday","Saturday","Sunday"), , ,"2 5")
if days <> .Nil then do day over days
say "TV day =" day
end
]]>
</programlisting>
<para>
The parameters are described in the <xref linkend="initListChoice"/> method of the
<computeroutput>MultiListChoice</computeroutput> class. However, instead of stems, arrays are passed into the function.
</para>
<para>
If the user cancels the dialog, <computeroutput>.nil</computeroutput> is returned rather than the empty string.
</para>
</section>
<section id="rtnPasswordBox" xreflabel="PasswordBox"><title>PasswordBox Routine</title>
<indexterm><primary>PasswordBox</primary>
<secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>PasswordBox</secondary></indexterm>
<para>A shortcut to invoke a <xref linkend="clsPasswordBox"/>
dialog as a function:
</para>
<programlisting>
<![CDATA[
pwd = PasswordBox("Please enter your password","Security")
]]>
</programlisting>
<para>
The parameters are described in the <xref linkend="initInputBox"/> method of the <computeroutput>InputBox</computeroutput>
class.
</para>
</section>
<section id="rtnSimpleFolderBrowse" xreflabel="SimpleFolderBrowse"><title>SimpleFolderBrowse</title>
<indexterm><primary>SimpleFolderBrowse</primary></indexterm>
<indexterm><primary>public routines</primary><secondary>SimpleFolderBrowse</secondary></indexterm>
<programlisting>
<![CDATA[
>>-SimpleFolderBrowse(-+-------+-+-------+-+-------+-+--------+-+------+-+--------+-)-><
+--capt-+ +-,-bnr-+ +-,-hnt-+ +-,-strt-+ +-,-rt-+ +-,-ownr-+
]]>
</programlisting>
<para>
Brings up the Windows <emphasis role="italic">Browse For Folder</emphasis> dialog, allowing the user to select a folder in
the file system.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>capt [optional]</term>
<listitem>
<para>
Specifies a caption, or title, for the dialog. The Windows default title is <emphasis role="italic">Browse For
Folder</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>bnr [optional]</term>
<listitem>
<para>
Specifies text to use for what Windows calls the <emphasis role="italic">banner</emphasis> for the dialog. This string
is displayed above the tree view control in the dialog box. The string can be used to specify instructions to the user.
By default nothing is displayed for the banner and the area above the tree view is blank.
</para>
</listitem></varlistentry>
<varlistentry><term>hnt [optional]</term>
<listitem>
<para>
Specifies text to use for a <emphasis role="italic">hint</emphasis> in the dialog. The hint is displayed below the
bottom of the tree view control, and above the bottom row of buttons of the dialog. By default there is no hint, and
the area where the hint would go is removed from the dialog. That is, the bottom row of buttons is placed directly
below the tree view.
</para>
</listitem></varlistentry>
<varlistentry><term>strt [optional]</term>
<listitem>
<para>
Specifies an initial selected folder for the dialog. By default, the dialog opens with the top-most item in the tree
view selected. If a start folder is specified, the folder is selected and, if needed, the tree view items are expanded
and the tree view is scrolled so that the starting folder is visible in the tree view.
</para>
<para>
Testing indicates that the folder specified must be a fully qualified path name of an existing directory. If not, the
operating system seems to just ignore it.
</para>
</listitem></varlistentry>
<varlistentry><term>rt [optional]</term>
<listitem>
<para>
Specifies the root for the tree view in the dialog. The root is the location of the root folder from which the user
starts browsing. Only the specified folder and any subfolders that are beneath it in the namespace hierarchy
will appear in the dialog box. The user can not browse above the root folder. If this argument is omitted, the
operating system uses the namespace root (the desktop folder.)
</para>
<para>
Specify either a fully qualified file system path name, or use one of the <xref linkend="sctSpecialFolderNames"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>ownr [optional]</term>
<listitem>
<para>
The Rexx dialog object that is to be the owner window of the browse for folder dialog. The owner dialog is disabled
until the browse for folder dialog is closed by the user.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
If the user cancels the dialog, the empty string is returned, otherwise the fully qualified path to the folder the user
picked is returned. However it is possible to set up the dialog in a way such that the user can pick a virtual folder.
Virtual folders do not have a file system path. The <computeroutput>.nil</computeroutput> object is returned if a virtual
folder is picked.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">SimpleFolderBrowse</emphasis> routine is just a shortcut to using the <xref
linkend="clsSimpleFolderBrowse"/> class. It is intended to be simple to use and is restricted to file system paths. The
Windows Browse For Folders dialog has more capabilities than can be accessed through this routine, but the capabilities
are less likely to be useful in most ooRexx programs. The <xref linkend="clsBrowseForFolder"/> class allows access to all
features of the Windows Browse For Folders dialog, but it is correspondingly more complex to use.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example puts up the Browse For Folder dialog and gets the user's selection:
<programlisting>
<![CDATA[
folder = SimpleFolderBrowse()
select
when folder == .nil then text = 'The user picked a virtual folder'
when folder == '' then text = 'The user canceled'
otherwise text = 'The user picked:' folder
end
-- End select
say text
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End SimpleFolderBrowse() -->
<section id="rtnSingleSelection" xreflabel="SingleSelection"><title>SingleSelection Routine</title>
<indexterm><primary>SingleSelection</primary><secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary><secondary>SingleSelection</secondary></indexterm>
<programlisting>
<![CDATA[
>>-SingleSelection(--msg-,-title-,-labels-+----------+-+-----------+-+-------+--)--><
+-,-preSel-+ +-,-rbWidth-+ +-,-max-+
]]>
</programlisting>
<para>
The SingleSelection function provides a shortcut to invoke a <xref linkend="clsSingleSelection"/> dialog. However, the
<emphasis role="italic">labels</emphasis> argument is an array, rather than a stem as it is in the
<computeroutput>SingleSelection</computeroutput> class.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>msg [required]</term>
<listitem>
<para>
A text string that is displayed above the radio button group. Typically, the text would be used to give the user the
purpose of the radio buttons, or to prompt the user as to what to do.
</para>
</listitem></varlistentry>
<varlistentry><term>title [required]</term>
<listitem>
<para>
A title, the caption bar text, for the dialog that will be invoked.
</para>
</listitem></varlistentry>
<varlistentry><term>labels [reuired]</term>
<listitem>
<para>
An array with indexes one through the number of radio buttons desired. The value for each index is the label for the
corresponding radio button. For instance the value at index 2 of the array would be set to the label for the second
radio button.
</para>
</listitem></varlistentry>
<varlistentry><term>preSel [optional]</term>
<listitem>
<para>
This argument can be used to preselect, (that is to check,) one radio button. A value of 1 checks the first radio
button, a value of 2 checks the second, and so on. If this argument is omitted, the first radio button is checked.
</para>
</listitem></varlistentry>
<varlistentry><term>rbWidth [optiona]</term>
<listitem>
<para>
Specifies the width, in dialog units, of the radio button controls. If omitted, the width is calculated so that the
longest label will not be clipped. If used, all radio buttons are set to this width without regard as to whether the
label will be clipped or not.
</para>
</listitem></varlistentry>
<varlistentry><term>max [optional]</term>
<listitem>
<para>
The maximum number of radio buttons in one column. If there are more radio buttons than <emphasis
role="italic">max</emphasis>, that is, if the <emphasis role="italic">labels</emphasis> argument has more indexes than
the value of <emphasis role="italic">max</emphasis>, the radio buttons are positioned in columns. Each column will
have <emphasis role="italic">max</emphasis> radio buttons and there will be as many columns as needed to display all
the radio buttons.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
If the user cancels the dialog, the empty string is returned. If the user closes the dialog with <emphasis
role="italic">Ok</emphasis> the return is the index in the <emphasis role="italic">labels</emphasis> array of the
selected radio button. 1 for the first radio button, 2 for the second radio button, 8 for the eighth radion button,
etc., etc..
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When the <emphasis role="italic">SingleSelection</emphasis> routine is called, the ooDialog framework, internally, does
a number of calculations to determine the optimal size of the dialog controls and dialog. The framework then positions
all the dialog controls such that none of the radio button labels, message, and title of the dialog are clipped.
</para>
<para>
The one exception to this is if the programmer specifies the width of the radio button controls using the optional
<emphasis role="italic">rbWidth</emphasis> argument. In this case the width of the radio buttons is always set to what
the programmer has specified. It is possible that the radio buttons will be clipped, but that is now the responsibility
of the programmer.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example shows a dialog that contains a two-column radio button group. The sixth radio button (the button
with the label Jun) is checked, (preselected.)
<programlisting>
<![CDATA[
months = .array~of("Jan","Feb","Mar","Apr","May","Jun", -
"Jul","Aug","Sep","Oct","Nov","Dec")
dlgTitle = "The Month You Were Born"
prompt = "Select the month of your birth:"
selectedRadioButton = 3
m = SingleSelection(prompt, dlgTitle, months, selectedRadioButton, , 6)
if m == "" then
say "The user canceled the dialog."
else
say "Born in month" m "=" months[m]
::requires "ooDialog.cls"
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="rtnTimedMessage" xreflabel="TimedMessage"><title>TimedMessage Routine</title>
<indexterm><primary>TimedMessage</primary>
<secondary>function</secondary></indexterm>
<indexterm><primary>public routines</primary>
<secondary>TimedMessage</secondary></indexterm>
<para>The TimedMessage routine provides a shortcut to invoke a
<xref linkend="clsTimedMessage"/> dialog as a function:
</para>
<programlisting>
<![CDATA[
ret = TimedMessage("We are starting...","Please wait",3000)
]]>
</programlisting><para> The parameters are the same as described in the
<xref linkend="initTimedMessage"/> method of the <computeroutput>
TimedMessage</computeroutput> class.
</para>
<para>The function returns 0, always, when the duration is non-negative. When
the duration is less than 0, the function returns a reference to the
<computeroutput>TimedMessage</computeroutput> dialog object. This is needed in
order for the programmer to manually dismiss the dialog. Below are the same 3 <link
linkend="example1TimedMessage">examples</link> listed for the <computeroutput>TimedMessage</computeroutput> dialog,
modified to work with the public routine:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Example
1:</emphasis></term>
<listitem><para>The following example shows a window with the title of <emphasis
role="italic">Infomation</emphasis> for a duration of 3 seconds:
<programlisting> <![CDATA[
ret = timedMessage("Application will be started, please wait", -
"Information", 3000)
]]>
</programlisting>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example
2:</emphasis></term>
<listitem><para>The following example shows an introductory window that displays
while an application is doing its time consuming start up routine. Since this
start up process can vary in time depending on the individual system, the window
is set to display indefinitely. When the start up process is finished, the
programmer dismisses the window and destroys the dialog manually. Note how a
reference to the <computeroutput>TimedMessage</computeroutput> dialog is
returned. The programmer only needs to use this to dismiss / destroy the dialog
<programlisting>
<![CDATA[
dlg = timedMessage("The WidgetCreator Application - loading ...", -
"The Widget Factory", -1)
ret = doStartup()
dlg~ok
if ret <> 0 then do
...
end
]]>
</programlisting>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example
3:</emphasis></term>
<listitem><para>The following example is a variation on <emphasis role="bold">
Example 2</emphasis>. In this case the Widget Factory executives decided that
they want their WidgeCreator splash screen to always display for 2 seconds to
the customer and then close. The early reply argument is used so that the start
up routine executes immediately. After 2 seconds the splash screen dismisses
and the dialog is destroyed automatically.
</para>
<programlisting> <![CDATA[
ret = timedMessage("The WidgetCreator Application - loading ...", -
"The Widget Factory", 2000)
if doStartup() <> 0 then do
...
end
]]>
</programlisting></listitem></varlistentry>
</variablelist>
</section>
</section>
</section>
<!-- <section id="clsMouse" xreflabel="Mouse"><title>Mouse Class</title> START -->
<xi:include href="mouse.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- <section id="clsMouse" xreflabel="Mouse"><title>Mouse Class</title> END -->
<!-- <section id="clsKeyboard" xreflabel="Keyboard"><title>Keyboard Class</title> START -->
<xi:include href="keyboard.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- <section id="clsMouse" xreflabel="Mouse"><title>Mouse Class</title> END -->
</chapter>