[r8598]: docs / trunk / oodialog / en-US / eventNotification.xml Maximize Restore History

Download this file

eventNotification.xml    9589 lines (8780 with data), 371.1 kB

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "oodialog.ent">
%BOOK_ENTITIES;
]>
<!--#########################################################################
#
# Description: Open Object Rexx: ooDialog Reference XML file.
#
# Copyright (c) 2005-2012, Rexx Language Association. All rights reserved.
# Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
# distribution. A copy is also available at the following address:
# http://www.oorexx.org/license.html
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the distribution.
#
# Neither the name of Rexx Language Association nor the names
# of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#########################################################################
-->
<section id="clsEventNotification" xreflabel="EventNotification"><title>EventNotification Mixin Class</title>
<indexterm><primary>EventNotification class</primary></indexterm>
<para>
The event notification class is a <emphasis role="italic">Mixin</emphasis> class that contains methods that connect
the notification of a Windows <xref linkend="ovvEvents"/> sent to the
<xref linkend="ovvUnderlying"/> dialog with a method in the Rexx dialog object. Except as noted below, the
Rexx programmer adds the method to her dialog subclass. Once the event notification is connected, each time the event
occurs, the connected method is invoked. The programmer codes the method to take the appropriate action for the event.
</para>
<para>
In the Windows user interface, as the user interacts with the system, events are generated that specify what the
action of the user was. Mouse clicks, keyboard presses, moving or sizing windows, all generate events.
</para>
<para>
Some simple examples of how this works:
<itemizedlist>
<listitem>
<para>
Push buttons notify their parent dialog of a number of events. The programmer connects one of these events to a method
in his Rexx dialog. Typically the CLICKED event is connected. Then, the connected method is called each time the
button is pressed (clicked.)
</para>
</listitem>
<listitem>
<para>
List boxes, multiple-select list boxes, and combo boxes can be connected to a method that is called each time a line
in the list box or combo box is selected.
</para>
</listitem>
<listitem>
<para>
For a scroll bar, the programmer can specify different methods that are called depending on the user action. The user
can click on the arrow buttons, drag the thumb, or use the page down / page up keys. Each of these events can be
connected to a method in the Rexx dialog.
</para>
</listitem></itemizedlist>
</para>
<para>
Whenever a dialog object is instantiated, the ooDialog framework <link
linkend="sctStandardEventMethods">automatically</link> makes several event connections. For all other events the Rexx
programmer, usually, needs to specifically connect the event to his dialog, through one of the event notification methods,
to be able to respond to the event. In a <xref linkend="clsUserDialog"/>, some of the methods that create dialog controls
have an option that automatically connects an event to a dialog method. But, for most events, say the resize or move
events, the connection needs to be made explicitly. Indeed, except for trivial dialogs, most of the programming is
deciding which events to be notified of and taking action upon receiving the notification.
</para>
<section id="sctConnectingEventHandlers"><title>Connecting Event Handlers</title>
<indexterm><primary>connecting event handlers</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connecting event handlers</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connecting event handlers</secondary></indexterm>
<para>
In general, events should be connected before the dialog is shown on the screen, or immediately after the dialog is
created. There is no reason why the programmer can not place the invocation where ever it makes the most sense.
Connecting the events in the <xref linkend="mthInitDialog"/>() method is usually sufficient. In a
<computeroutput>UserDialog</computeroutput>, the <xref linkend="mthDefineDialog"/>() method also
makes a good place for the connect event methods. If the programmer is overriding the <emphasis
role="italic">init</emphasis>() method, the connect event methods can be placed there. In this case, do not invoke
the connect event method until <emphasis role="bold">after</emphasis> the superclass has been <link
linkend="mthNewDialogObject">initialized</link>.
</para>
</section>
<section id="sctCodingEventHandlers"><title>Coding Event Handlers</title>
<indexterm><primary>coding event handlers</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>coding event handlers</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>coding event handlers</secondary></indexterm>
<para>
The methods in a Rexx dialog object connected to Windows event notifications are commonly called event handlers
because the method handles the event. In order to properly code an event handler, the Rexx programmer needs to
understand somewhat the underlying mechanism of event notification. This is particularly important in ooDialog 4.2.0
and later with its ability to <link linkend="ovvEventsDirectReply">directly</link> invoke the event handling method from
the window <link linkend="ovvWindowMessages">message</link> processing loop.
</para>
<para>
When the operating system sends an event notification to the underlying dialog, the operating system waits for a reply
to the notification in the message processing loop. This is significant because while the operating system is
waiting, in general, other messages can not be processed by the window. If an application does not reply in a timely
manner to the notification messages, it can cause the application to appear hung. With today's fast processors there
are plenty of CPU cycles for an event handler to process and reply to event notifications. But, if an application were
to do something like sleep for 10 seconds in an event handler, the user would think the application was hung.
</para>
<para>
Prior to ooDialog 4.2.0, the ooDialog framework could not directly invoke the event handling method in the Rexx dialog
object. To invoke the method, the framework used a cumbersome process involving queues and interpret. In the message
processing loop, the framework essentially queued up the method to be invoked <emphasis role="italic">at some later
time</emphasis> and replied immediately to the notification. Because of this, the event handling method could not
reply to the event notification, and in fact any return was simply lost. This meant much of the capability of a
Windows dialog was unavailable. It also meant it did not matter if the method returned in a timely manner.
</para>
<para>
With ooDialog 4.2.0 and later, the event handling method in the Rexx dialog object is invoked by the interpreter
directly from the message processing loop in the underlying Windows dialog. This allows the Rexx programmer to
<link linkend="exampleEventHandler1">return</link> a value to the notification, to <link
linkend="exampleEventHandler1">synchronize</link> the handling of notifications, or to
<link linkend="exampleEventHandler3">veto</link> an event. Remember, with this direct invocation of the event handling
methods, the interpreter is waiting in the message processing loop for the return from the method. Therefore, the
programmer needs to return from the method in a reasonable amount of time. Do not be overly worried about this, the
interpreter processes a large number of statements in a very short time. There is adequate time to process and return
a value in the event handler.
</para>
<para>
However, having the interpreter waiting for the return of an event handling method could conceivably be a problem for
some few existing programs. Since, in older ooDialog versions, the return from an event handler method was
meaningless, some programmers may not have returned from the method in a timely manner, and never realized this was a
mistake. In addition, there are a large number of event notifications in Windows where the operating system ignores
the reply. Therefore, the ooDialog framework uses two different ways to invoke the event handling method. The first,
preferred, method is for the interpreter to invoke the method directly, wait for the return, and then use the return
to reply to the Windows event notification. The second is to invoke the event handling method using the <emphasis
role="italic">startWith</emphasis>() method of the <computeroutput>Object</computeroutput> class. This starts the
event handling method concurrently, and the ooDialog framework replies to the Windows event notification immediately.
</para>
<para>
In general, whether the ooDialog framework invokes the event handling method and waits for the return, or uses
<emphasis role="italic">startWith</emphasis>() and replies to the Windows event notification immediately is determined
using these rules:
</para>
<orderedlist>
<listitem>
<para>
Event connections made using the event connection methods that existed prior to ooDialog 4.2.0, using the existing
event keywords, and existing arguments, use <emphasis role="italic">startWith</emphasis> to invoke the event handlers.
The programmer can not change this. For the purpose of this discussion, these methods will be called existing
connection methods.
</para>
</listitem>
<listitem>
<para>
All event connections made using event connection methods introduced after ooDialog 4.1.0 assume the programmer wants
the event handler invoked directly and for the ooDialog framework to wait for the return. These methods will be called
new connection methods. For instance, the <xref linkend="clsDateTimePicker"/> control did not exist in ooDialog 4.1.0, so
its event connection method, <xref linkend="mthConnectDateTimePickerEvent"/> falls into this category.
</para>
</listitem>
<listitem>
<para>
For new connection methods, when the reply to an event notification has a meaning for the notification, the framework
always invokes the event handler directly and waits for the return. The programmer can not change this. If the
programmer does not want to reply to the event, then he should simply not connect the event.
</para>
</listitem>
<listitem>
<para>
All new connection methods have an optional argument that allows the programmer to specify whether she wants the
framework to wait for the return, or use <emphasis role="italic">startWith</emphasis> and reply immediately. When the
reply to an event is ignored by the operating system, the optional argument will be used to direct the framework to
invoke the event handler directly or use <emphasis role="italic">startWith</emphasis>. By default, the framework
invokes the connected method directly.
</para>
</listitem>
<listitem>
<para>
Over time, the existing connections will be enhanced to also take an optional argument. This will allow the
programmer to specify that the framework invoke the event handler directly and wait for the return. This enhancement
has started, but is far from complete.
</para>
</listitem>
<listitem>
<para>
The documentation for each event connection method, for each event, will specify how the event handler will be
invoked.
</para>
</listitem>
</orderedlist>
<para>
The following code snippets and examples expand on these details.
</para>
<para>
Best practice would be to always code event handlers as if they are expected to return a value to the operating
system's event notification message. The considerations would be that the method does not block and that a value is
returned to the operating system in a reasonable amount of time. In general, the event handler should be unguarded to
preclude the possibility that some guarded method in the dialog object is executing at the time the event notification
is generated.
</para>
<para>
Below is a code snippet for an application that displays the current date and time, with a push button that refreshes
the display. Note these points about the code snippet. Since the <emphasis role="italic">connectButtonEvent</emphasis>
method is the replacement for the <xref linkend="ovvDeprecated"/> <emphasis
role="italic">connectButtonNotify</emphasis> it is in essence an existing connection method, using the original
arguments. Therefore, the method is invoked from the message processing loop using <emphasis
role="italic">startWith</emphasis>. Because of this, technically, it does not have to be unguarded and does not have
to return a value. Nevertheless, it is the <emphasis role="italic">correct</emphasis> way to code the event handler.
<programlisting>
<![CDATA[
::method initDialog
...
self~connectButtonEvent(IDC_PB_REFRESH, "CLICKED", updateTime)
...
::method updateTime unguarded
use arg info, hwnd
now = .DateTime~new
self~refreshDisplay(now)
return 0
]]>
</programlisting>
</para>
<para>
Consider this snippet from a similar program, but where the push button starts a process that calculates the grains of
sand in the universe. Since it is not expected that the calculation will finish in a reasonable amount of time, an
early reply is used to return a value in a timely manner. The handler also disables the push button so tha the user
can not start a second calculation until the first calculation finishes.
<programlisting>
<![CDATA[
::method initDialog
...
self~connectButtonEvent(IDC_PB_CALC_SAND, "CLICKED", onCalculateGrains)
...
::method onCalculateGrains unguarded
use arg info, hwnd
self~newPushButton(IDC_PB_CALC_SAND)~disable
reply 0
number = self~calculateSandInUniverse
self~refreshDisplay(number)
self~newPushButton(IDC_PB_CALC_SAND)~enable
return
]]>
</programlisting>
</para>
<para>
The following examples are all for events where the event handler must return a value.
</para>
<variablelist>
<varlistentry id="exampleEventHandler1"><term><emphasis role="bold">Returning Values</emphasis></term>
<listitem>
<para>
The month <xref linkend="clsMonthCalendar"/> control has the
<xref linkend="evtMonthCalendarGETDAYSTATE"/> event that is sent to request information on how certain
days are to be shown. The programmer can customize the calendar by returning a set of days that should be displayed
in bold. For instance, in a business application paid holidays could be displayed in bold.
</para>
<para>
Since the <emphasis role="italic">connectMonthCalendarEvent</emphasis> method did not exist in ooDialog 4.1.0 and
the return value for this event is meaningful, the second and third rules above apply. That is, the interpreter
invokes the event handler directly, waits for the reply, and the programmer can not change this behavior.
</para>
<programlisting>
<![CDATA[
::method initDialog
expose calendar
calendar = self~newMonthCalendar(IDC_MC_HOLIDAYS)
-- Connect the GETDAYSTATE event.
self~connectMonthCalendarEvent(IDC_MC_HOLIDAYS, "GETDAYSTATE", onGetDayState)
-- Restrict the calendar so that it only displays the year 2011.
start = .DateTime~fromStandardDate("20110101")
end = .DateTime~fromStandardDate("20111231")
...
::method onGetDayState unguarded
expose calendar
use arg startDate, count
-- Create the array to hold the .DayState objects.
dayStates = .array~new(count)
month = startDate~month
if month == 12 then month = 0
do i = 1 to count
j = month + i - 1
select
when j == 1 then dayStates[i] = .DayState~new(17)
when j == 2 then dayStates[i] = .DayState~new(21)
when j == 3 then dayStates[i] = .DayState~new
when j == 4 then dayStates[i] = .DayState~new
when j == 5 then dayStates[i] = .DayState~new(30)
when j == 6 then dayStates[i] = .DayState~new
when j == 7 then dayStates[i] = .DayState~new(4)
when j == 8 then dayStates[i] = .DayState~new
when j == 9 then dayStates[i] = .DayState~new(5)
when j == 10 then dayStates[i] = .DayState~new
when j == 11 then dayStates[i] = .DayState~new(24, 25)
when j == 12 then dayStates[i] = .DayState~new(23, 30)
otherwise dayStates[i] = .DayState~new()
end
end
buffer = .DayStates~makeDayStateBuffer(dayStates)
return buffer
]]>
</programlisting>
</listitem></varlistentry>
<varlistentry id="exampleEventHandler2"><term><emphasis role="bold">Event Synchronization</emphasis></term>
<listitem>
<para>
The <xref linkend="clsDateTimePicker"/> (date time picker) control has the
<xref linkend="mthConnectDateTimePickerEvent"/> event notification that is sent when the drop down calendar
is shown. This gives the programmer a chance to customize the month calendar that is shown. Since the month calendar
is not shown until the event handling method returns, replying directly to the notification allows the programmer to
completely finish the customizations before the month calendar appears on the screen.
</para>
<programlisting>
<![CDATA[
::method initDialog
self~connectDateTimePickerEvent(IDC_DTP, "DROPDOWN", onDropDown)
...
::method onDropDown unguarded
use arg idFrom, hwndFrom
dt = self~newDateTimePicker(IDC_DTP);
monthCal = dt~getMonthCal
monthCal~setFirstDayOfWeek(3)
monthCal~addStyle("NOTODAY")
return 0
]]>
</programlisting>
<para>
In the above example, the <emphasis role="italic">connectDateTimePickerEvent</emphasis> method did not exist in
ooDialog 4.1.0, but the return value for this event is ignored by the OS. Therefore, the second and fourth rules
above apply. That is, by default the interpreter invokes the event handler directly and waits for a reply. However
the programmer can change this behavior if he wants. If there is no reason to have the interpreter wait until the
event handler finishes, then the programmer could use the fourth optional argument. The
<computeroutput>.false</computeroutput> value tells the ooDialog framework to use the <emphasis
role="italic">startWith</emphasis> method to invoke the event handler.
</para>
<programlisting>
<![CDATA[
::method initDialog
self~connectDateTimePickerEvent(IDC_DTP, "DROPDOWN", onDropDown, .false)
...
::method onDropDown unguarded
expose userDidSeeCalendar
use arg idFrom, hwndFrom
userDidSeeCalendar = .true
]]>
</programlisting>
</listitem></varlistentry>
<varlistentry id="exampleEventHandler3"><term><emphasis role="bold">Veto Events</emphasis></term>
<listitem>
<para>
The <xref linkend="clsTab"/> control has the <xref linkend="mthConnectTabEvent"/> event.
It is sent when the user selects a different tab, and is sent <emphasis role="bold">before</emphasis> the selected
tab is changed. The programmer can <emphasis role="italic">veto</emphasis> the change to a new tab by returning
<computeroutput>.false</computeroutput> to the event notification, or allow the change by returning
<computeroutput>.true</computeroutput>. One reason for preventing the change might be that the user had entered
invalid data in the current tab page.
</para>
<para>
<emphasis role="bold">Note:</emphasis> Since the <emphasis role="italic">connectTabEvent</emphasis> method is the
replacement for the <emphasis role="italic">ovvDeprecated</emphasis> <emphasis
role="italic">connectTabNotify</emphasis> method, it essentially is a method that existed in ooDialog 4.1.0. The
above rules one and five apply. That is, when the same arguments are used as existed in 4.1.0, the event handler is
invoked using <emphasis role="italic">startWith</emphasis> and the interpreter does not wait for a return value.
With this behavior, it is impossible for the programmer to veto the change to a new tab. Therefore the programmer
has to use the fourth optional argument to change the default behavior. Specifying
<computeroutput>.true</computeroutput> causes the ooDialog framework to invoke the <emphasis
role="italic">onTabChanging</emphasis> method directly and wait for the return value.
</para>
<programlisting>
<![CDATA[
::method defineDialog
self~connectTabEvent(IDC_TAB, SELCHANGING, onTabChanging, .true)
::method onTabChanging unguarded
expose tabContent
use arg idFrom, hwndFrom
index = self~newTab(idFrom)~selectedIndex + 1
dlg = tabContent[index]
if dlg~validate then return .true
else return .false
]]>
</programlisting>
<para>
In the above example, since the <emphasis role="italic">validate</emphasis> method is returning
<computeroutput>.true</computeroutput> or <computeroutput>.false</computeroutput> the event handler could have been
coded this way:
</para>
<programlisting>
<![CDATA[
::method onTabChanging unguarded
...
return dlg~validate
]]>
</programlisting>
<para>
The example used:
<programlisting>
<![CDATA[
if dlg~validate then return .true
else return .false
]]>
</programlisting>
to emphasize that the event handler needs to return <computeroutput>.true</computeroutput> or
<computeroutput>.false</computeroutput>.
</para>
</listitem></varlistentry>
<varlistentry id="exampleEventHandler4"><term><emphasis role="bold">Lengthy Processing</emphasis></term>
<listitem>
<para>
As previously noted, the Rexx programmer does not need to be overly worried about taking to much time to return a
value from an event handler. In most very case there is plenty of time to process the event and return a value.
However, sometimes the programmer may want to, or need to, do some lengthy processing in the event handler. For
these cases, the programmer needs to figure out how to return a value from the event handler and also do the needed
processing. This is really a <emphasis role="italic">concurrency</emphasis> problem, not an event handling problem.
</para>
<para>
The two common ways to solve this problem would be to use an <emphasis role="italic">early reply</emphasis> or to
start a <emphasis role="italic">second activity</emphasis> running to do the processing. Using the
<link linkend="exampleEventHandler3">onTabChanging</link> event handler above, here are two typical ways to handle the
event when some lengthy processing is involved. As a hypothetical, say that when the user changes to a new tab, the
program needs to gather up all the data on the validated page and write it to disk, or send it somewhere. One approach
would be to validate the page, do an early reply, and then finish up the processing:
</para>
<programlisting>
<![CDATA[
::method defineDialog
self~connectTabEvent(IDC_TAB, SELCHANGING, onTabChanging, .true)
::method onTabChanging unguarded
expose tabContent
use arg idFrom, hwndFrom
index = self~newTab(idFrom)~selectedIndex + 1
dlg = tabContent[index]
if \ dlg~validate then return .false -- Tab will not be changed
reply .true -- Tab is changed for the user.
-- Now gather up the data entered on the page we just switched from.
data = dlg~getUserDataDirectory
self~writeDataToFile(data)
]]>
</programlisting>
<para>
Another approach could be to start a new activity which will run concurrently. It might be coded this way:
</para>
<programlisting>
<![CDATA[
::method onTabChanging unguarded
expose tabContent
use arg idFrom, hwndFrom
index = self~newTab(idFrom)~selectedIndex + 1
dlg = tabContent[index]
if dlg~validate then do
dp = .DataProcesser~new
dp~start("processDlgData", dlg)
return .true
end
else do
return .false
end
]]>
</programlisting>
</listitem></varlistentry>
</variablelist>
</section>
<section id="sctMethodsEventNotification"><title>Method Table</title>
<para>
The following table list the methods of the <computeroutput>EventNotification</computeroutput> class:
</para>
<table id="tblEventNotificationMethods" frame="all">
<title>EventNotification Methods</title>
<tgroup cols="2">
<colspec colwidth="2*" />
<colspec colwidth="4*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><xref linkend="mthAddUserMsg"/></entry>
<entry>Connects an operating system window message with a method in the Rexx dialog object.</entry>
</row>
<row>
<entry><xref linkend="mthConnectActivate"/></entry>
<entry>Connects the window activation event to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectAllSBEvents"/></entry>
<entry>Connects all event notifications from a scroll bar control to a single method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectButtonEvent"/></entry>
<entry>Connect an event notification from a button control to a method in the Rexx Dialog</entry>
</row>
<row>
<entry><xref linkend="mthConnectComboBoxEvent"/></entry>
<entry>Connects an event notification from a combo box to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectCommandEvents"/></entry>
<entry>Connects a command event notification from a dialog control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectDateTimePickerEvent"/></entry>
<entry>Connects an event notification form a date time picker to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectDraw"/></entry>
<entry>Connects the draw item event notification to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectEachSBEvent"/></entry>
<entry>Connects each specified event notification from a scroll bar to a separate method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectEditEvent"/></entry>
<entry>Connects an event notification from an edit control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectFKeyPressDialogObject"/></entry>
<entry>Connects a F Key key press (a F key is typed) with a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectHelp"/></entry>
<entry>Connects the Windows Help event to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectKeyPressDialogObject"/></entry>
<entry>Connects a key press (a key is typed) with a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectListBoxEvent"/></entry>
<entry>Connects an event notification from a list box control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectListViewEvent"/></entry>
<entry>Connects an event notification from a list-view control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectMonthCalendarEvent"/></entry>
<entry>Connects an event notification from a month calendar to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectMove"/></entry>
<entry>Connects the move event notification to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectNotifyEvent"/></entry>
<entry>Connects a generic event notification from a dialog control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectPosChanged"/></entry>
<entry>Connects the position has changed event notification to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectResize"/></entry>
<entry>Connects the size event notification to a method in the Rexx dialog</entry>
</row>
<row>
<entry><xref linkend="mthConnectResizing"/></entry>
<entry>Connects the sizing event notification to a method in the Rexx dialog</entry>
</row>
<row>
<entry><xref linkend="mthConnectScrollBarEvent"/></entry>
<entry>Connects an event notification from a scroll bar control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectSizeMoveEnded"/></entry>
<entry>Connects the size / move ended event notification to a method in the Rexx dialog object.</entry>
</row>
<row>
<entry><xref linkend="mthConnectStaticEvent"/></entry>
<entry>Connects an event notification from a static control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectTabEvent"/></entry>
<entry>Connects an event notification from a tab control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectTrackBarEvent"/></entry>
<entry>Connects an event notification from a track bar control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectTreeViewEvent"/></entry>
<entry>Connects an event notification from a tree view control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectUpDownEvent"/></entry>
<entry>Connects an event notification from an UpDown control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthDefListDragHandler"/></entry>
<entry>Default implementation of a drag and drop handler for a list-view control.</entry>
</row>
<row>
<entry><xref linkend="mthDefTreeDragHandler"/></entry>
<entry>Default implementation of a drag and drop handler for a tree view control.</entry>
</row>
<row>
<entry><xref linkend="mthDisconnectKeyPressDialogObject"/></entry>
<entry>Disconnects a method that was previously connected to key press event.</entry>
</row>
<row>
<entry><xref linkend="mthHasKeyPressConnectionDialogObject"/></entry>
<entry>Queries if a connection to a key press event already exists.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="mthAddUserMsg" xreflabel="addUserMsg"><title>addUserMsg</title>
<indexterm><primary>addUserMsg</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>addUserMsg</secondary></indexterm>
<indexterm><primary>EventNotification class</primary><secondary>addUserMsg</secondary></indexterm>
<programlisting>
<![CDATA[
>>--addUserMsg(-rxMsg-,-winMsg-+------+-+------+-+------+-+------+-+------+-)--><
+-,-f1-+ +-,-wP-+ +-,-f2-+ +-,-lP-+ +-,-f3-+
]]>
</programlisting>
<para>
The <emphasis role="italic">addUserMsg</emphasis> method connects a Windows window
<xref linkend="ovvWindowMessages"/> sent to the <xref linkend="ovvUnderlying"/> dialog with a
method in the Rexx dialog. This method is designed to be used by ooDialog programmers who are familiar with the
Windows API. It's use will require access to the Windows <xref linkend="defWindowsDoc"/> at a
minimum, and will likely also require access to the Windows header files in the
Windows platform <xref linkend="defPlatformSDK"/>.
</para>
<para>
Internally, ooDialog examines every window message the Windows dialog receives. If the window message matches the
arguments specified to <emphasis role="italic">addUserMsg</emphasis>, ooDialog invokes the method specified by
<emphasis role="italic">rxMsg</emphasis>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
All arguments, except for <emphasis role="italic">rxMsg</emphasis>, represent non-negative whole numbers. For
convenience, the programmer can either use the numeric value for these argument, or the numbers can be expressed in
conventional <xref linkend="defConventionalHex"/> format.
</para>
<para>
The arguments are:
<variablelist>
<varlistentry><term>rxMsg [required]</term>
<listitem>
<para>
The method in the Rexx dialog to invoke when, or if, the window message, <emphasis
role="italic">winMsg</emphasis> is sent to the underlying dialog.
</para>
</listitem></varlistentry>
<varlistentry><term>winMsg [required]</term>
<listitem>
<para>
The numeric value of the window message to match.
</para>
</listitem></varlistentry>
<varlistentry><term>f1 [optional]</term>
<listitem>
<para>
A filter to apply to the <emphasis role="italic">winMsg</emphasis>. The filter is bitwise <emphasis
role="italic">anded</emphasis> with <emphasis role="italic">winMsg</emphasis> and if the result equals <emphasis
role="italic">winMsg</emphasis>, it is considered a match. If omitted a filter of 0xFFFFFFFF is used.
</para>
</listitem></varlistentry>
<varlistentry><term>wP [optional]</term>
<listitem>
<para>
The numeric value of the <link linkend="ovvWindowMessages">WPARAM</link> parameter in the window message to
match. This defaults to 0.
</para>
</listitem></varlistentry>
<varlistentry><term>f2 [optional]</term>
<listitem>
<para>
A filter to apply to the <emphasis role="italic">wP</emphasis> argument. The filter is bitwise <emphasis
role="italic">anded</emphasis> with <emphasis role="italic">wP</emphasis> and if the result equals <emphasis
role="italic">wP</emphasis>, it is considered a match. If omitted a filter of 0 is used.
</para>
</listitem></varlistentry>
<varlistentry><term>lP [optional]</term>
<listitem>
<para>
The numeric value of the <link linkend="ovvWindowMessages">LPARAM</link> parameter in the window message to match.
This defaults to 0.
</para>
</listitem></varlistentry>
<varlistentry><term>f3 [optional]</term>
<listitem>
<para>
A filter to apply to the <emphasis role="italic">lP</emphasis> argument. The filter is bitwise <emphasis
role="italic">anded</emphasis> with <emphasis role="italic">lP</emphasis> and if the result equals <emphasis
role="italic">lP</emphasis>, it is considered a match. If omitted a filter of 0 is used.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return value is 0 for success and 1 for failure.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method is not intended for every ooDialog programmer. In particular, it requires some understanding of window
messages, the message parameters, and bitwise and. If the ooDialog programmer does not know what a bitwise and is,
that is a good indication that this method is not for them.
</para>
<para>
Details for all window messages and their parameters are available in the Windows
<xref linkend="defWindowsDoc"/>. The numeric value of the message IDs (and possibly the message parameters) can be
looked up in the Windows platform <xref linkend="defPlatformSDK"/>.
</para>
<para>
In all cases, it is preferable to use specific connect event methods provided by ooDialog. Such as
<xref linkend="mthConnectEditEvent"/>, <xref linkend="mthConnectResize"/>, etc..
<emphasis role="italic">addUserMsg</emphasis> is provided for those cases where the specific connect event method
the programmer needs is not present in ooDialog.
</para>
<para>
Note that the arguments the event handling method receives will be the numeric value of the WPARAM and LPARAM
parameters for the window message. If either WPARAM or LPARAM are pointers, the numeric value will not do the
ooDialog programmer any good. There is no way in ooDialog Rexx code to access whatever the pointer points to. (The
exception to this would be if ooDialog already had a connect event method for the specific window message. In which
case there is no need to use <emphasis role="italic">addUserMsg</emphasis>.)
</para>
<para>
Filters can be used to ensure that only the specific message desired is connected to the Rexx method, or to match
several messages and connect them to the same Rexx method.
</para>
<para>
Take the window messages WM_KEYDOWN (0x0100) and WM_KEYUP (0x0101.) When
<programlisting>
<![CDATA[
winMsg == '0x0100'
f1 == '0xFFFF'
addUserMsg('onKeyDown', winMsg, f1, 0, 0, 0, 0)
]]>
</programlisting>
only the WM_KEYDOWN message will match and <emphasis role="italic">onKeyDown</emphasis> is only invoked for that
message.
</para>
<para>
However, when
<programlisting>
<![CDATA[
winMsg == '0x0100'
f1 == '0xFFFE'
addUserMsg('onKey', winMsg, f1, 0, 0, 0, 0)
]]>
</programlisting>
both the WM_KEYDOWN and WM_KEYUP messages will match and the <emphasis role="italic">onKey</emphasis> method will be
invoked for either window message.
</para>
<para>
In a similar fashion, both the LBN_SETFOCUS (0x4) and the LBN_KILLFOCUS (0x5) notifications are sent to a list box
using the WM_COMMAND (0x0111) message. For the WM_COMMAND message, the WPARAM parameter contains the control ID in
the low word of the parameter and the notification code in the high word of the parameter.
</para>
<para>
Say the list box control has an ID of 256 (0xFF,) when
<programlisting>
<![CDATA[
winMsg == '0x0111'
f1 == '0xFFFF'
wP == '0x000400FF'
f2 == '0xFFFFFFFF'
addUserMsg('onSetFocus', winMsg, f1, wP, f2, 0, 0)
]]>
</programlisting>
only the LBN_SETFOCUS notification sent to the list box with ID of 256 will invoke the <emphasis
role="italic">onSetFocus</emphasis> method.
</para>
<para>
However, in this case
<programlisting>
<![CDATA[
winMsg == '0x0111'
f1 == '0xFFFF'
wP == '0x000400FF'
f2 == '0xFFFEFFFF'
addUserMsg('onFocus', winMsg, f1, wP, f2, 0, 0)
]]>
</programlisting>
both the LBN_SETFOCUS and LBN_KILLFOCUS notifications to the listbox will invoke the <emphasis
role="italic">onFocus</emphasis> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry id="exampleAddUserMsg"><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The WM_CANCELMODE message is sent to cancel certain modes, such as mouse capture. This example shows how an ooDialog
program that captures the mouse for some reason could add an event handler for the WM_CANCELMODE message and release
the mouse if the program had currently captured it. This is a hypothetical situation intended to show how to use the
<emphasis role="italic">addUserMsg</emphasis> method and not necessarily of any practical value.
<programlisting>
<![CDATA[
::method init
expose mouseIsCaptured
...
WM_CANCELMODE = '0x001F'
ret = self~addUserMsg('onCancelMode', WM_CANCELMODE, '0xFFFF', 0, 0, 0, 0)
if ret == 1 then do
-- Do some error handling stuff.
-- But, really this is unlikely to happen.
end
mouseIsCaptured = .false
::method doCaptureMouse private
expose mouseIsCaptured
self~captureMouse
mouseIsCaptured = .true
... -- more code
::method onCancelMode unguarded
expose mouseIsCaptured
use arg wParam, lParam
-- For WM_CANCELMODE wParam and lParam have no meaning.
if mouseIsCaptured then do
self~releaseMouseCapture
mouseIsCaptured = .false
... -- maybe some more code
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
<section id="evtAddUserMsg"><title>addUserMsg Event Handler</title>
<indexterm><primary>addUserMsg</primary><secondary>events</secondary><tertiary>generic</tertiary></indexterm>
<programlisting>
<![CDATA[
::method onEvent unguarded
use arg wParam, lParam
return 0
]]>
</programlisting>
<para>
The event handler connected through the <xref linkend="mthAddUserMsg"/> is invoked when ooDialog
internally matches a message sent to the <xref linkend="ovvUnderlying"/> Windows dialog using the
arguments specified by the programmer in the invocation of the <emphasis role="italic">addUserMsg</emphasis> method.
</para>
<para>
The default behavior is for ooDialog to ignore the return value from the event handler and the interpreter does not
wait for the return in the message processing loop. Currently, this behavior can not be changed. It is possible
that a future enhancement may allow the programmer to change the behavior.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives two arguments. However, as noted in the remarks for the
<xref linkend="mthAddUserMsg"/> this does not hold if ooDialog already has a connect event method for
the window message. In which case, the programmer should use the existing method, rather than <emphasis
role="italic">addUserMsg</emphasis>.
</para>
<variablelist>
<varlistentry><term>wParam</term>
<listitem>
<para>
The <link linkend="ovvWindowMessages">WPARAM</link> parameter to the window message that was connected through
<emphasis role="italic">addUserMsg</emphasis>. This will be the numeric value of WPARAM and may or may not be of
use to the programmer depending on the specific window message.
</para>
</listitem></varlistentry>
<varlistentry><term>lParam</term>
<listitem>
<para>
The <link linkend="ovvWindowMessages">LPARAM</link> parameter to the window message that was connected through
<emphasis role="italic">addUserMsg</emphasis>. Again, this will be the numeric value of LPARAM and may or may not be of
use to the programmer depending on the specific window message.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
Currently the return value from the event handler is ignored. A possible future enhancement to <emphasis
role="italic">addUserMsg</emphasis> may make it possible to return a meaningful value.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The <link linkend="exampleAddUserMsg">example</link> for <emphasis role="italic">addUserMsg</emphasis> shows how a
typical event handler might be coded.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Generic Event Handler -->
</section> <!-- End EventNotification::addUserMsg() -->
<section id="mthConnectActivate" xreflabel="connectActivate"><title>connectActivate</title>
<indexterm><primary>connectActivate</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectActivate</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectActivate</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectActivate(--+--------------+--)--------><
+--methodName--+
]]>
</programlisting>
<para>
Connects an <emphasis role="italic">activate</emphasis> <xref linkend="ovvEvents"/> notification sent to
the underlying dialog with a method in the Rexx dialog. This event notification is sent to both the window being
activated and the window being deactivated
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the method that is invoked each time the dialog gains or loses the activation. The method name
can not be the empty string. When this argument is omitted the name defaults to <emphasis
role="italic">onActivate</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An (internal) error prevented the message from being connected to a method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">active</emphasis> window is the <emphasis role="italic">top-level</emphasis> window that
the user is currently working with. The activate notification is only sent to top-level windows. The activate
notification is always sent in pairs, one notification to the window losing the activation and one to the window
gaining the activation. The arguments to the event handler for the notification allow the programmer to determine if
the window is gaining or losing the activation.
</para>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
<para>
The interpreter invokes the event handler directly and waits in the window <xref linkend="ovvWindowMessages"/> processing
loop for the return from the event handler. Connecting the activate event requires that the programmer reply to the event
from the event handler in a timely manner.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
sizing events happen.
</para>
<para>
The underlying dialog receives the WM_ACTIVATE message as the notification for this event.
</para>
</listitem></varlistentry>
</variablelist>
<section id="evtACTIVATE" xreflabel="ACTIVATE"><title>Activate Event Handler</title>
<indexterm><primary>dialog object</primary><secondary>events</secondary><tertiary>ACTIVATE</tertiary></indexterm>
<programlisting>
<![CDATA[
::method onActivate unguarded
use arg status, hwnd, hFocus, isMinimized
return .false
]]>
</programlisting>
<para>
The event handler for the ACTIVATE event is invoked when the dialog window is either losing or gaining the active
window status.
</para>
<para>
The programmer must return a value from the event handler and the interpreter waits for the return value from the
event handler.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives four arguments:
</para>
<variablelist>
<varlistentry><term>status</term>
<listitem>
<para>
A keyword that indicates if the dialog is gaining or losing the activation. The keyword will be exactly one of the
following:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>ACTIVE</member> <member>CLICKACTIVE</member> <member>INACTIVE</member>
</simplelist>
</para>
<variablelist>
<varlistentry><term>ACTIVE</term>
<listitem>
<para>
The dialog is gaining the activation through some means other than the user clicking the mouse on the window.
For example the user may select the window through the ALT-Tab mechanism.
</para>
</listitem></varlistentry>
<varlistentry><term>CLICKACTIVE</term>
<listitem>
<para>
The dialog is gaining the activation through a mouse click.
</para>
</listitem></varlistentry>
<varlistentry><term>INACTIVE</term>
<listitem>
<para>
The dialog is losing the activation.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term>hwnd</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> of the window being activated or deactivated, depending on the
<emphasis role="italic">status</emphasis> argument. If the keyword is INACTIVE, then this is the handle of the
window gaining the activation. If the keyword is ACTIVE or CLICKACTIVE, it is the handle of the window losing the
activation.
</para>
<para>
<emphasis role="bold">Note</emphasis> that this argument may be 0, indicating the operating system did not pass a
window handle with the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hFocus</term>
<listitem>
<para>
The window handle of the dialog control with the current focus when the dialog is being deactivated. When the
dialog is being activated <emphasis role="italic">hFocus</emphasis> will be 0.
</para>
</listitem></varlistentry>
<varlistentry><term>isMinimized</term>
<listitem>
<para>
Specifies the minimized state of the window being activated or deactivated. <emphasis
role="italic">isMinimized</emphasis> will be <computeroutput>.true</computeroutput> if the window is minimized,
otherwise <computeroutput>.false</computeroutput>.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The event handler for this notification must return <computeroutput>.true</computeroutput> or
<computeroutput>.false</computeroutput>. A return of true indicates that the notification has been processed and a
return of false indicates that the notification has not been processed. When the notification has not been processed
the interpreter passes the notification on to the operating system for its default processing.
</para>
<para>
The default processing done by the operating system includes things like restoring the focus to the dialog control
that had the focus when the dialog was deactivated, highlighting the text in an edit control if that control has the
focus, etc.. Under most circumstances, the programmer should return <computeroutput>.false</computeroutput> to allow
the dialog manager to perform this default processing. If not, the programmer should take care of these details or
the dialog may not behave as the user expects.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example comes from code ooDialog uses internally to handle a problem with a
<xref linkend="clsListView"/> control when it is used in a <xref linkend="clsTab"/> control. When
the dialog is being inactivated the handle of the focused control is saved. When it is being activated, the handle
of the last focused control is passed on the to <xref linkend="clsControlDialog"/> that contains
the list-view for processing.
<programlisting>
<![CDATA[
::method onActivate unguarded
expose listViewPageDialog lastFocused
use arg flag, hwnd, hFocused, isMinimized
reply .false
if flag == 'INACTIVE' then lastFocused = hFocused
else listViewPageDialog~updateListView(lastFocused)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Activate Event Handler -->
</section>
<section id="mthConnectAllSBEvents" xreflabel="connectAllSBEvents"><title>connectAllSBEvents</title>
<indexterm><primary>connectAllSBEvents</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectAllSBEvents(-id-,-mName-+------+-+------+-+-----+-+--------------+-)--><
+-,-mn-+ +-,-mx-+ +-,-p-+ +-,-willReply--+
]]>
</programlisting>
<para>
Connects all scroll bar events to one method.
</para>
<para>
This method requires that the <xref linkend="ovvUnderlying"/> scroll bar exists. Therefore, the method
is best invoked in the <xref linkend="mthInitDialog"/> method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:</para>
<variablelist>
<varlistentry><term>id [required]</term>
<listitem><para>The ID of the scroll bar
</para></listitem></varlistentry>
<varlistentry><term>mName [required]</term>
<listitem><para>The method that is invoked for all events sent by the scroll bar.
</para></listitem></varlistentry>
<varlistentry><term>mn, mx [optional]</term>
<listitem><para> Sets the minimum and maximum values for the range of the scroll bar.
</para></listitem></varlistentry>
<varlistentry><term>p [optional]</term>
<listitem><para>Sets the current position of the scroll bar.
</para></listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter
<link linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler. The default is
<computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. If <emphasis
role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>, the interpreter waits until the
event handling method returns a value.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>-1</term>
<listitem><para>The specified symbolic ID could not be resolved.
</para></listitem></varlistentry>
<varlistentry><term>0</term>
<listitem><para>No error.
</para></listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectButtonEvent" xreflabel="connectButtonEvent"><title>connectButtonEvent</title>
<indexterm><primary>connectButtonEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectButtonEvent(--id--,--event--+-----------+--+--------------+--)------><
+-,--mName--+ +-,-willReply--+
]]>
</programlisting>
<para>
Connects a method in the Rexx dialog to the Windows <xref linkend="ovvEvents"/> notification from a
<xref linkend="clsButton"/> control. The <emphasis role="italic">connectButtonEvent</emphasis> method is used
for all types of buttons (push button, radio button, or check box.)
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the button control this connection applies to. This can be a symbolic ID or the numeric value
of the ID.
</para>
</listitem></varlistentry>
<varlistentry><term>event [required]</term>
<listitem>
<para>
A keyword specifying the event to be connected with a method. This can be exactly one of the following, case is
not significant:
<variablelist>
<varlistentry><term>CLICKED</term>
<listitem>
<para>
The button has been clicked.
</para>
</listitem></varlistentry>
<varlistentry><term>DBLCLK</term>
<listitem>
<para>
The button has been double-clicked.
</para>
</listitem></varlistentry>
<varlistentry><term>DISABLE</term>
<listitem>
<para>
The button has been disabled.
</para>
</listitem></varlistentry>
<varlistentry><term>GOTFOCUS</term>
<listitem>
<para>
The button got the input focus.
</para>
</listitem></varlistentry>
<varlistentry><term>LOSTFOCUS</term>
<listitem>
<para>
The button lost the input focus.
</para>
</listitem></varlistentry>
<varlistentry><term>HILITE</term>
<listitem>
<para>
The button has been selected.
</para>
</listitem></varlistentry>
<varlistentry><term>UNHILITE</term>
<listitem>
<para>
The highlighting is to be removed (lost selection).
</para>
</listitem></varlistentry>
<varlistentry><term>HOTITEM</term>
<listitem>
<para>
Notifies the dialog that the mouse has moved over the button, or that the mouse is leaving the area
over the button.
</para>
</listitem></varlistentry>
<varlistentry><term>PAINT</term>
<listitem>
<para>
The button is to be repainted. This notification is only sent for owner-drawn buttons.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>mName [optional]</term>
<listitem>
<para>
The name of the method to invoke whenever the specified notification is received from the button control. Provide
a method with a matching name. If you omit this argument, a method name is generated automatically. The name
consists of the event keyword preceded by <computeroutput>on</computeroutput>. For instance:
<computeroutput>onGotFocus</computeroutput>. The method name can not be the empty string.
</para>
</listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter
<link linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler. The default is
<computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. If <emphasis
role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>, the interpreter waits until the
event handling method returns a value.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>The return codes are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error detected.
</para>
</listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem>
<para>
The resource ID could not be resolved or the event argument is incorrect.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The message was not connected correctly. From ooDialog 4.2.0 and on, it is not likely the return value will be
1.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<orderedlist>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
</listitem>
<listitem>
<para>
For all events other than the HOTITEM event, the event-handling methods will receive two arguments. The first arg
contains information about the specific control and its event. The second arg is the window handle of the button
control. The low word of the first arg is the control ID and the high word is the event ID. Example:
<programlisting>
<![CDATA[
::method handler unguarded
use arg info, handle
id = .DlgUtil~loWord(info)
eventCode = .DlgUtil~hiWord(info)
...
return 0
]]>
</programlisting>
</para>
</listitem>
<listitem>
<para>
The method for the HOTITEM event also receives two arguments. The first arg is the control id. The second arg is
.true or .false. True if the mouse moved over the button, false if it left the area over the button. Example:
<programlisting>
<![CDATA[
::method onHover unguarded
use arg id, entering
say 'onHover() id:' id 'entering:' entering
...
return 0
/* Output might be:
onHover() id: 1044 entering: 1
onHover() id: 1044 entering: 0
onHover() id: 1001 entering: 1
onHover() id: 1001 entering: 0
*/
]]>
</programlisting>
</para>
</listitem>
</orderedlist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
In order to receive the GOTFOCUS, LOSTFOCUS, and DBLCLK event notifications, the button control has to have the
NOTIFY (BS_NOTIFY) style. For user defined dialogs use the NOTIFY style keyword in the <link
linkend="sctCreateMethods">create</link> method when the button is defined. For dialogs created from a compiled resource
or a resource script file use the BS_NOTIFY style for the button resource. The other event notifications are always sent
and it is not necessary to add the NOTIFY style for those events.
</para>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any of
the button events occur.
</para>
<para>
In Windows itself, some notifications are sent to the parent dialog using the WM_COMMAND message and others are
sent using the WM_NOTIFY message.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example displays a message whenever the OK button is selected:</para>
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method init
self~init:super(...)
self~connectButtonEvent("OK", "HILITE")
::method onHilite unguarded
say "The OK button has been selected"
return 0
]]>
</programlisting>
</listitem></varlistentry>
</variablelist>
</section> <!-- End EventNotification::connectionButtonEvent() -->
<section id="mthConnectComboBoxEvent" xreflabel="connectComboBoxEvent"><title>connectComboBoxEvent</title>
<indexterm><primary>connectComboBoxEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectComboBoxEvent(--id--,--event--+---------------+--)---><
+-,--methodName-+
]]>
</programlisting>
<para>The connectComboBoxEvent method connects a particular
WM_NOTIFY message for a combo box with a method. The WM_NOTIFY message
informs the dialog that an event has occurred in the combo box.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>id</term>
<listitem><para>The <xref linkend="defResourceId"/> of the combo
box for which a notification is to be connected to a method.
</para></listitem></varlistentry>
<varlistentry><term>event</term>
<listitem><para>The event to be connected with a method:
<variablelist>
<varlistentry><term>CHANGE</term>
<listitem><para>The text in the edit control has been altered. This notification is
sent after Windows updated the screen.
</para></listitem></varlistentry>
<varlistentry><term>UPDATE</term>
<listitem><para>The text in the edit control has been altered. This notification is
sent before Windows updates the screen.
</para></listitem></varlistentry>
<varlistentry><term>CLOSEUP</term>
<listitem><para>The list of the combo box has been closed.
</para></listitem></varlistentry>
<varlistentry><term>DROPDOWN</term>
<listitem><para>The list of the combo box is about to be made visible.
</para></listitem></varlistentry>
<varlistentry><term>DBLCLK</term>
<listitem><para>An entry in the combo box list has been selected with a double click.
</para></listitem></varlistentry>
<varlistentry><term>ERRSPACE</term>
<listitem><para>An out-of-memory problem has occurred.
</para></listitem></varlistentry>
<varlistentry><term>GOTFOCUS</term>
<listitem><para>The combo box got the input focus.
</para></listitem></varlistentry>
<varlistentry><term>LOSTFOCUS</term>
<listitem><para>The combo box lost the input focus.
</para></listitem></varlistentry>
<varlistentry><term>SELCHANGE</term>
<listitem><para>Another entry in the combo box list has been selected.
</para></listitem></varlistentry>
<varlistentry><term>SELENDOK</term>
<listitem><para>The list was closed after another entry was selected.
</para></listitem></varlistentry>
<varlistentry><term>SELENDCANCEL</term>
<listitem><para>After the selection of another entry, another control or dialog was
selected, which canceled the selection of the entry.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term>msgToRaise</term>
<listitem><para>The message that is to be sent whenever the specified notification is
received from the combo control. Provide a method with a matching name. If
you omit this argument, the event is preceded by <computeroutput>On</computeroutput>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return codes are:
<variablelist>
<varlistentry><term>-1</term>
<listitem><para>The resource ID could not be resolved or the event argument is
incorrect.
</para></listitem></varlistentry>
<varlistentry><term>0</term>
<listitem><para>No errors were detected.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>The message was not connected correctly. The message was not connected
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
<para>
The event-handling methods receive two arguments: the first is a combination of the ID of the combo box and the ID of
the notification message. (Extract the low-order word to get the combo box ID.) The second argument is the window
handle of the combo box. Example:
<programlisting>
<![CDATA[
::method playSong unguarded
use arg eventID, handle
id = .DlgUtil~loWord(eventID)
if id == self~constDir[IDC_CB_PROFESSIONS] then
-- take some action
...
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example invokes method PlaySong whenever the list of the combo box with the resource ID of
IDC_CB_PROFESSIONS is about to be made visible. In this case IDC_CB_PROFESSIONS is a <xref
linkend="defSymbolicId"/> ID that has been added to the <xref linkend="atrConstDir"/> directory of the MyDlgClass in
another part of the program:
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method initDialog
self~connectComboBoxEvent("IDC_CB_PROFESSIONS", "DROPDOWN", "PlaySong")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectCommandEvents" xreflabel="connectCommandEvents"><title>connectCommandEvents</title>
<indexterm><primary>connectCommandEvents</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectCommandEvents</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectCommandEvents</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectCommandEvents(--id--,--methodName--)--><
]]>
</programlisting>
<para>
The <emphasis role="italic">connectCommandEvents</emphasis> method connects a Rexx dialog method to the command
<xref linkend="ovvEvents"/> notifications sent by a Windows dialog control to its parent dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the dialog control, may be symbolic or numeric.
</para>
</listitem></varlistentry>
<varlistentry><term>methodName [required]</term>
<listitem>
<para>
The name of the method to be invoked in the Rexx dialog object each time a command event occurs in the dialog
control. The method name can not be the empty string.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
The specified symbolic ID could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An error. Most likely, either the message table is full, or the interpreter is out of usable memory.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Two arguments are sent to the connected method. The first contains the notification code in the high word and the
ID of the control in the low word. The second argument is the window handle of the control.
</para>
<para>
The number of different notification codes and the meanings of the notifications are dependent on the type of dialog
control specified. Therefore, it is more advisable to use the specific connectXXXEvent() method for the control.
Such as the <xref linkend="mthConnectListBoxEvent"/>() method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
command events happen.
</para>
<para>
In Windows itself, command events are sent to the parent dialog using the WM_COMMAND message.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example connects a list box command event notifications to the <emphasis role="italic">onCommand</emphasis>()
method of the dialog. Note that the notification code 1 corresponds to the list box SELCHANGE event, 4 is the
SETFOCUS, and 5 is KILLFOCUS events.
<programlisting>
<![CDATA[
::method initDialog
...
self~connectCommandEvents(IDC_LB_FILES, onCommand)
::method onCommand unguarded
use arg cmdCode, hwnd
say 'cmdCode: ' cmdCode
say 'hwnd: ' hwnd
say 'hi word notification code:' .DlgUtil~hiWord(cmdCode)
say 'lo word resource ID: ' .DlgUtil~loWord(cmdCode)
say '(List box resource ID) ' self~constDir[IDC_LB_FILES]
say
return 0
/* Output might be:
cmdCode: 263147
hwnd: 0x00100AD0
hi word notification code: 4
lo word resource ID: 1003
(List box resource ID) 1003
cmdCode: 66539
hwnd: 0x00100AD0
hi word notification code: 1
lo word resource ID: 1003
(List box resource ID) 1003
cmdCode: 328683
hwnd: 0x00100AD0
hi word notification code: 5
lo word resource ID: 1003
(List box resource ID) 1003
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectDateTimePickerEvent" xreflabel="connectDateTimePickerEvent"><title>connectDateTimePickerEvent</title>
<indexterm><primary>connectDateTimePickerEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectDateTimePickerEvent(--id-,-evt--+----------+-+------------+-)-------><
+-,--mName-+ +-,-wilReply-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectDateTimePickerEvent</emphasis> method connects an
<xref linkend="ovvEvents"/> notification message from a date time <xref linkend="clsDateTimePicker"/>
control to a method in the Rexx dialog.
</para>
<para>
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the date time picker control. May be numeric or <xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>evt [required]</term>
<listitem>
<para>
Exactly one of the following keywords. The keyword specifies the event to be connected. For each event, the
documentation for the event handler, <xref linkend="evtDateTimePickerCLOSEUP"/>), <xref
linkend="evtDateTimePickerDATETIMECHANGE"/>, etc., will contain additional information about the event. Case is not
significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>CLOSEUP </member>
<member>DATETIMECHANGE</member>
<member>DROPDOWN </member>
<member>FORMAT </member>
<member>FORMATQUERY </member>
<member>USERSTRING </member>
<member>KEYDOWN </member>
<member>KILLFOCUS </member>
<member>SETFOCUS </member>
</simplelist>
<variablelist>
<varlistentry><term>CLOSEUP</term>
<listitem>
<para>
Sent by a date and time picker (DTP) control when the user closes the drop-down month calendar. The month
calendar is closed when the user chooses a date from the month calendar or clicks the drop-down arrow while
the calendar is open. The return value from the event handler is ignored for this event.
</para>
</listitem></varlistentry>
<varlistentry><term>DATETIMECHANGE</term>
<listitem>
<para>
Sent by a date and time picker (DTP) control whenever a change occurs. The return value from the event
handler is ignored for this event.
</para>
</listitem></varlistentry>
<varlistentry><term>DROPDOWN</term>
<listitem>
<para>
Sent by a date and time picker (DTP) control when the user activates the drop-down month calendar. The return
value from the event handler is ignored for this event.
</para>
</listitem></varlistentry>
<varlistentry><term>FORMAT</term>
<listitem>
<para>
Sent by a date and time picker (DTP) control to request text to be displayed in a
<link linkend="sctDTPCallback">callback</link>/> field. The <emphasis role="italic">willReply</emphasis> argument
is ignored for this event, the event handler must <link linkend="sctCodingEventHandlers">return</link> a reply.
</para>
</listitem></varlistentry>
<varlistentry><term>FORMATQUERY</term>
<listitem>
<para>
Sent by a date and time picker (DTP) control to retrieve the maximum allowable size of the string that will be
displayed in a <link linkend="sctDTPCallback">callback</link> field. The <emphasis
role="italic">willReply</emphasis> argument is ignored for this event, the event handler must
<link linkend="sctCodingEventHandlers">return</link> a reply.
</para>
</listitem></varlistentry>
<varlistentry><term>USERSTRING</term>
<listitem>
<para>
Sent by a date and time picker (DTP) control when a user finishes editing a string in the control. This
notification message is only sent by DTP controls that have the CANPARSE style. The <emphasis
role="italic">willReply</emphasis> argument is ignored for this event, the event handler must
<link linkend="sctCodingEventHandlers">return</link> a reply.
</para>
</listitem></varlistentry>
<varlistentry><term>KEYDOWN</term>
<listitem>
<para>
Sent by a date and time picker (DTP) control when the user types in a <link
linkend="sctDTPCallback">callback</link> field. The <emphasis role="italic">willReply</emphasis> argument is
ignored for this event, the event handler must <link linkend="sctCodingEventHandlers">return</link> a reply.
</para>
</listitem></varlistentry>
<varlistentry><term>KILLFOCUS</term>
<listitem>
<para>
Notifies a date and time picker control's parent window, (which is the dialog window,) that the control has
lost the input focus. The return value from the event handler is ignored for this event.
</para>
</listitem></varlistentry>
<varlistentry><term>SETFOCUS</term>
<listitem>
<para>
Notifies a date and time picker control's parent window, (which is the dialog window,) that the control has
received the input focus. The return value from the event handler is ignored for this event.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>mName [optional]</term>
<listitem>
<para>
The name of the method that is to be invoked whenever the specified notification is received from the date time
picker control. The programmer defines this method. If this argument is omitted, a method name is automatically
generated that consists of the event keyword preceded by <computeroutput>on</computeroutput>. For instance,
<computeroutput>onCloseUp</computeroutput>. If the method name is supplied, it can not be the empty string.
</para>
</listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreters waits for the reply
from the event handler. The default is <computeroutput>.true</computeroutput>, that is, the interpreter waits
until the event handling method returns a value. If <emphasis role="italic">willReply</emphasis> is
<computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. However, this argument is
ignored for the USERSTRING, KEYDOWN, FORMAT, and FORMATQUERY events. If the programmer connects any of these
events, the interpreter waits for the return from the connected method. This can not be changed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method returns <computeroutput>.true</computeroutput> if the event notification was connected correctly,
otherwise <computeroutput>.false</computeroutput> .
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected, including the use of an invalid symbolic ID or an
unrecognized event keyword.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if the
connected event happens.
</para>
<para>
The underlying dialog receives the DTN_* messages as the notifications for the date time picker events.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example creates a DTP control in the dialog template of a <computeroutput>UserDialog</computeroutput>
and then connects the drop down and close up events:
</para>
<programlisting>
<![CDATA[
::method defineDialog
self~createDateTimePicker(IDC_DTP_REPORT_DATE, 10, 7, 280, 15, "BORDER SHORT SHOWNONE")
self~createPushButton(IDOK, 85, 74, 50, 14, "DEFAULT", "Ok")
self~createPushButton(IDCANCEL, 140, 74, 50, 14, , "Cancel")
self~connectDateTimePickerEvent(IDC_DTP_REPORT_DATE, "CLOSEUP", onCloseUp)
self~connectDateTimePickerEvent(IDC_DTP_REPORT_DATE, "DROPDOWN", onDropDown)
]]>
</programlisting>
</listitem></varlistentry>
</variablelist>
<section id="evtDateTimePickerCLOSEUP" xreflabel="CLOSEUP"><title>CloseUp Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>CLOSEUP</secondary></indexterm>
<para>
The event handler for the close up event is invoked when the user closes the drop-down month calendar. The month
calendar is closed when the user chooses a date from the month calendar or clicks the drop-down arrow while the
calendar is open.
</para>
<para>
The programmer can specify for the interpreter to wait, or not wait, for the return from the the event handler by
using the <emphasis role="italic">willReply</emphasis> argument in the
<xref linkend="mthConnectDateTimePickerEvent"/> method. The actual value returned from the
event handler is ignored.
</para>
<para>
This event notification signals that the DTP control has destroyed the child month calendar control. The DTP control
creates a new month calendar each time the month calendar needs to be shown and destroys it each time the drop-down is
closed. The close up notification is sent when the month calendar is destroyed.
</para>
<para>
The programmer may have instantiated a Rexx month calendar object during the
<xref linkend="evtDateTimePickerDROPDOWN"/> event notification. Once the underlying Windows month calendar is
destroyed, the Rexx <computeroutput>MonthCalendar</computeroutput> is no longer valid.
</para>
<programlisting>
<![CDATA[
::method onCloseUp unguarded
use arg idFrom, hwndFrom
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 2 arguments:
</para>
<variablelist>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The return value from the event handler is ignored by the operating system. 0 makes a good return value.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following is an example event handler for the close up event. When the close up happens, the user may or may not
have changed the selected date. The example checks if a new data has been selected and does something if it has
been changed:
<programlisting>
<![CDATA[
::method onCloseUp unguarded
expose dtp lastChange
use arg id, hwnd
newDate = dtp~getDateTime
if newDate \= lastChange then do
lastChange = newDate
self~updateDateInfo(newDate)
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End CloseUp Event Handler -->
<section id="evtDateTimePickerDATETIMECHANGE" xreflabel="DATETIMECHANGE"><title>DateTimeChange Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>DATETIMECHANGE</secondary></indexterm>
<para>
The event handler for the date time change event is invoked whenever a change in the underlying DTP control takes
place
</para>
<para>
The programmer can specify for the interpreter to wait, or not wait, for the return from the the event handler by
using the <emphasis role="italic">willReply</emphasis> argument in the
<xref linkend="mthConnectDateTimePickerEvent"/> method. The actual value returned from the
date time change event handler is ignored.
</para>
<programlisting>
<![CDATA[
::method onDateTimeChange unguarded
use arg dateTime, valid, idFrom, hwndFrom
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>dateTime</term>
<listitem>
<para>
The <emphasis role="italic">dateTime</emphasis> argument is a <computeroutput>DateTime</computeroutput> object.
When the <emphasis role="italic">valid</emphasis> argument is true, <emphasis role="italic">dateTime</emphasis>
specifies the new displayed date and time in the DTP control. When <emphasis role="italic">valid</emphasis> is
false, <emphasis role="italic">dateTime</emphasis> will be the exact date and time that the notification was
received.
</para>
</listitem></varlistentry>
<varlistentry><term>valid</term>
<listitem>
<para>
True or false indicating whether the date time change is valid or not. <emphasis role="italic">valid</emphasis>
can only be false when the DTP control has the SHOWNONE style and the user has unchecked the check box to indicate
that no date and time is currently selected.
</para>
</listitem></varlistentry>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The return from the event handler is ignored. Returning 0 is sensible.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example updates a static control with the currently selected date and time whenever the user changes
the date and time:
<programlisting>
<![CDATA[
::method initDialog
expose dtp staticMsg
self~connectDateTimePickerEvent(IDC_DTP, "DATETIMECHANGE", onChange)
dtp = self~newDateTimePicker(IDC_DTP);
dtp~setFormat("hh':'mm':'ss dddd MMM dd', 'yyyy")
staticMsg = self~newStatic(IDC_ST1)
...
::method onChange unguarded
expose staticMsg
use arg dateTime, valid, idFrom, hwndFrom
if valid then do
sf = .SimpleFormatter~new(dateTime)
staticMsg~setText(sf~time 'on' sf~date)
end
else do
staticMsg~setText("No valid date selected.")
end
return 0
::class 'SimpleFormatter' public
::method init
expose dateTime
use strict arg dateTime
::method date
expose dateTime
dayNum = dateTime~usaDate~substr(4, 2)~strip('L', '0')
year = dateTime~standardDate~left(4)
return dateTime~dayName || ',' dateTime~monthName dayNum || ',' year
::method time
expose dateTime
return dateTime~civilTime
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DateTimeChange Event Handler -->
<section id="evtDateTimePickerDROPDOWN" xreflabel="DROPDOWN"><title>DropDown Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>DROPDOWN</secondary></indexterm>
<para>
The event handler for the drop down event is invoked when the user activates the drop down month calendar. The DTP
control sends the notification for the event after it has created the child month calendar control.
</para>
<para>
The programmer can specify for the interpreter to wait, or not wait, for the return from the the event handler by
using the <emphasis role="italic">willReply</emphasis> argument in the
<xref linkend="mthConnectDateTimePickerEvent"/> method. The actual value returned from the
event handler for the drop down event is ignored.
</para>
<programlisting>
<![CDATA[
::method onDropDown unguarded
use arg idFrom, hwndFrom
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The drop down event handler receives 2 arguments:
</para>
<variablelist>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The return from the event handler is ignored. Returning 0 is sensible.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
One reason for handling the drop down event is to adjust the style of the month calendar control when it is
displayed. Note that the DTP control creates the child month calendar control when it is needed and destroys the
month calendar when the drop down is closed up. Therefore you can not save a reference to the month calendar object
and use it later. When the <xref linkend="ovvUnderlying"/> month calendar control is destroyed the
Rexx month calendar object is no longer valid.
</para>
<para>
In Windows Vista and later versions of Windows, the DTP control has the
<xref linkend="mthSetMonthCalStyle"/> method which can be used to set the month calendar's style
once and the DTP control will then use that style each time it creates the month calendar. Therefore, the technique
of setting the month calendar style during the drop down event handler is really only needed for Windows XP and
earlier.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example demonstrates how to change the month calendar style in the drop down event handler. If the
operating system the program is running on is Vista or later, the whole process is bypassed:
<programlisting>
<![CDATA[
::method initDialog
expose dtp
dtp = self~newDateTimePicker(IDC_DTP_APPOINTMENT_TIME);
if .OS~isAtLeastVista then do
dtp~setMonthCalStyle("NOCIRCLE NOTRAILING")
end
else
self~connectDateTimePickerEvent(IDC_DTP_APPOINTMENT_TIME, "DROPDOWN", onDropDown)
do
...
::method onDropDown unguarded
expose dtp
use arg idFrom, hwndFrom
-- We know this is not Vista or later, othewise we would not
-- have gotten the event notification.
mc = dtp~getMonthCal
mc~replaceStyle('DAYSTATE MULTI WEEKNUMBERS', "NOCIRCLE NOTODAY")
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DropDown Event Handler -->
<section id="evtDateTimePickerFORMAT" xreflabel="FORMAT"><title>Format Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>FORMAT</secondary></indexterm>
<para>
The event handler for the format event is invoked when the DTP control requests the text to be displayed in a
<link linkend="sctDTPCallback">callback</link> field.
</para>
<para>
The programmer must return the text to display for the callback field and the interpreter waits for this return. This
behaviour can not be changed.
</para>
<programlisting>
<![CDATA[
::method onFormat unguarded
use arg field, dateTime, idFrom, hwndFrom
return text
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>field</term>
<listitem>
<para>
The text of the callback field identifier.
</para>
</listitem></varlistentry>
<varlistentry><term>dateTime</term>
<listitem>
<para>
A <computeroutput>DateTime</computeroutput> object that is the currently displayed date and time in the DTP
control.
</para>
</listitem></varlistentry>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The text to display for the specified callback field. The text must be no longer than 63 characters or a syntax
condition is raised.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The <computeroutput>FORMAT</computeroutput>, <xref linkend="evtDateTimePickerFORMATQUERY"/>, and <xref
linkend="evtDateTimePickerKEYDOWN"/> event notifications all work together to provide the functionality for call back
fields. It is a little difficult to grasp the concepts from small snippets of code, so a complete example program is
included in the ooDialog samples: <computeroutput>samples\oodialog\controls\fiscalReports.rex</computeroutput>.
</para>
<para>
This is an example FORMAT event handler. It comes from the complete
<computeroutput>fiscalReports.rex</computeroutput> program:
<programlisting>
<![CDATA[
::method onFormat unguarded
expose periods types currentType currentPeriod
use arg field, dt, id, hwnd
select
when field == 'XX' then do
ret = self~getPeriodNumber(dt)
end
when field == 'XXX' then do
ret = periods[currentPeriod]
end
otherwise do
ret = types[currentType]
end
end
-- End select
return ret
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Format Event Handler -->
<section id="evtDateTimePickerFORMATQUERY" xreflabel="FORMATQUERY"><title>FormatQuery Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>FORMATQUERY</secondary></indexterm>
<para>
The event handler for the format query event is invoked when the DTP control requests the maximum size needed to
display a string in a <link linkend="sctDTPCallback">callback</link> field.
</para>
<para>
The programmer must fill in a <xref linkend="clsSize"/> object with the maximum size needed and return a
value from the event handler. The interpreter waits for this return. This behavior can not be changed.
</para>
<programlisting>
<![CDATA[
::method onFormatQuery unguarded
use arg field, size, id, hwnd
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>field</term>
<listitem>
<para>
The text of the callback field identifier.
</para>
</listitem></varlistentry>
<varlistentry><term>size</term>
<listitem>
<para>
A <computeroutput>Size</computeroutput> object that is set to the maximum size required to display the
string in the call back field.
</para>
</listitem></varlistentry>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The actual value returned from the event handler is ignored by the operating system. Rather the return signals the
operating system that the <emphasis role="italic">size</emphasis> argument is now valid to access, and the OS can
use its values. Returning zero is sensible.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The <computeroutput>FORMATQUERY</computeroutput>, <xref linkend="evtDateTimePickerFORMAT"/>, and <xref
linkend="evtDateTimePickerKEYDOWN"/> event notifications all work together to provide the functionality for call back
fields. It is a little difficult to grasp the concepts from small snippets of code, so a complete example program is
included in the ooDialog samples: <computeroutput>samples\oodialog\controls\fiscalReports.rex</computeroutput>.
</para>
<para>
The following example FORMATQUERY event handler comes from that example program:
<programlisting>
<![CDATA[
::method onFormatQuery unguarded
expose dtp haveSizes xxSize xxxSize xxxxSize
use arg field, size, id, hwnd
if \ haveSizes then do
xxSize = self~calcSize('XX')
xxxSize = self~calcSize('XXX')
xxxxSize = self~calcSize('XXXX')
haveSizes = .true
end
-- The equateTo() method sets the cx and cy attributes of the receiver .Size
-- object to the cx and cy attributes of the argument .Size object.
select
when field == 'XX' then size~equateTo(xxSize)
when field == 'XXX' then size~equateTo(xxxSize)
otherwise size~equateTo(xxxxSize)
end
-- End select
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End FormatQuery Event Handler -->
<section id="evtDateTimePickerKEYDOWN" xreflabel="KEYDOWN"><title>KEYDOWN Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>KEYDOWN</secondary></indexterm>
<para>
The event handler for the key down event is invoked when the user types a key in a
<link linkend="sctDTPCallback">callback</link> field.
</para>
<para>
The programmer must return a <computeroutput>DateTime</computeroutput> object and the interpreter waits for this
return. This behavior can not be changed.
</para>
<programlisting>
<![CDATA[
::method onKeyDown unguarded
use arg field, dateTiem, vKey, idFrom, hwndFrom
return dateTime
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives xx arguments:
</para>
<variablelist>
<varlistentry><term>field</term>
<listitem>
<para>
The text of the callback field identifier.
</para>
</listitem></varlistentry>
<varlistentry><term>dateTime</term>
<listitem>
<para>
A <computeroutput>DateTime</computeroutput> object that is the currently displayed date and time in the DTP
control.
</para>
</listitem></varlistentry>
<varlistentry><term>vKey</term>
<listitem>
<para>
The virtual key code of the key the user typed in the call back field. The <xref linkend="clsVK"/> class
can be used to map the numeric key code to a symbol, making it easier to work with the codes.
</para>
</listitem></varlistentry>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The programmer returns a <computeroutput>DateTime</computeroutput> object. If the return is a date / time different
than the <emphasis role="italic">dateTime</emphasis> argument, the DTP control's date / time is updated. If it is he
same, then no action is taken by the DTP control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
By examining the <emphasis role="italic">dateTime</emphasis> and <emphasis role="italic">vKey</emphasis> arguments
the programmer can produce custom responses to the user's typed keys. The custom response is achieved by returning a
<computeroutput>DateTime</computeroutput> object that specifies a different date than the currently displayed date.
For instance, if the currently displayed date is 8:00 am July 4th 1998 and the user types the <emphasis
role="italic">home</emphasis> key, the programmer could return a date of 12:00 am January 1st 1998 to set the DTP
control's display to the first of January in 1998. Likewise, if the user typed the <emphasis
role="italic">end</emphasis> key the programmer could return December 31 1998 at 11:59 pm to set the display to the
end of the current year.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The <computeroutput>KEYDOWN</computeroutput>, <xref linkend="evtDateTimePickerFORMAT"/>, and <xref
linkend="evtDateTimePickerFORMATQUERY"/> event notifications all work together to provide the functionality for call
back fields. It is a little difficult to grasp the concepts from small snippets of code, so a
complete example program is included in the ooDialog samples:
<computeroutput>samples\oodialog\controls\fiscalReports.rex</computeroutput>.
</para>
<para>
The following example shows the KEYDOWN event handler from the <computeroutput>fiscalReports.rex</computeroutput>
example program:
<programlisting>
<![CDATA[
::method onKeyDown unguarded
use arg field, dt, vKey, idFrom, hwndFrom
select
when field == 'XX' then do
newDT = self~updatePeriodNumber(dt, vKey)
end
when field == 'XXX' then do
newDT = self~updatePeriod(dt, vKey)
end
otherwise do
newDT = self~updateReport(dt, vKey)
end
end
-- End select
return newDT
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End KEYDOWN Event Handler -->
<section id="evtDateTimePickerKILLFOCUS" xreflabel="KILLFOCUS"><title>KillFocus Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>KILLFOCUS</secondary></indexterm>
<para>
The event handler for the kill focus event is invoked when the DTP control loses the input focus.
</para>
<para>
The programmer can specify for the interpreter to wait, or not wait, for the return from the the event handler by
using the <emphasis role="italic">willReply</emphasis> argument in the
<xref linkend="mthConnectDateTimePickerEvent"/> method. The actual value returned from the
event handler for the kill focus event is ignored.
</para>
<programlisting>
<![CDATA[
::method onKillFocus unguarded
use arg idFrom, hwndFrom
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The kill focus event handler receives 2 arguments:
</para>
<variablelist>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The return from the event handler is ignored. Returning 0 is sensible.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End KillFocus Event Handler -->
<section id="evtDateTimePickerSETFOCUS" xreflabel="SETFOCUS"><title>SetFocus Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>SETFOCUS</secondary></indexterm>
<para>
The event handler for the set focus event is invoked when the DTP control gains the input focus.
</para>
<para>
The programmer can specify for the interpreter to wait, or not wait, for the return from the the event handler by
using the <emphasis role="italic">willReply</emphasis> argument in the
<xref linkend="mthConnectDateTimePickerEvent"/> method. The actual value returned from the
event handler for the set focus event is ignored.
</para>
<programlisting>
<![CDATA[
::method onSetFocus unguarded
use arg idFrom, hwndFrom
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The set focus event handler receives 2 arguments:
</para>
<variablelist>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The return from the event handler is ignored. Returning 0 is sensible.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End SetFocus Event Handler -->
<section id="evtDateTimePickerUSERSTRING" xreflabel="USERSTRING"><title>UserString Event Handler</title>
<indexterm><primary>DateTimePicker Event</primary><secondary>USERSTRING</secondary></indexterm>
<para>
The event handler for the USERSTRING event is invoked when the user has finished editing a string in the DTP control.
This event notification only occurs when the DTP control has the CANPARSE style.
</para>
<para>
The programmer must return a value from the event handler and the interpreter waits for this return. This behavior can
not be changed.
</para>
<programlisting>
<![CDATA[
::method onUserString unguarded
use arg dateTime, userStr, idFrom, hwndFrom
return newDateTime
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>dateTime</term>
<listitem>
<para>
A <computeroutput>DateTime</computeroutput> object that reflects the date and time the DTP control is currently
displaying.
</para>
</listitem></varlistentry>
<varlistentry><term>userStr</term>
<listitem>
<para>
The string the user has just finished typing into the DTP control.
</para>
</listitem></varlistentry>
<varlistentry><term>idFrom</term>
<listitem>
<para>
The <emphasis role="italic">idFrom</emphasis> argument is the resource ID of the date time picker that generated
the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwndFrom</term>
<listitem>
<para>
The window handle of the date and time picker.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The event handler must return a <computeroutput>DateTime</computeroutput> object or the
<computeroutput>.nil</computeroutput> object.
</para>
<para>
After parsing the user string, the programmer returns a new <computeroutput>DateTime</computeroutput> object that
reflects the new date and time the DTP control should display. If the returned
<computeroutput>DateTime</computeroutput> object reflects the exact same date and time as the <emphasis
role="italic">dateTime</emphasis> argument, then the DTP control takes no action. Otherwise, the DTP control updates
its display to the new date and time.
</para>
<para>
If, and only if, the DTP control has the SHOWNONE style, the programmer can return the
<computeroutput>.nil</computeroutput> object to change the date and time to <emphasis role="italic">no date and
time</emphasis> selected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This event notification allows the programmer to provide a custom response to what the user types into the DTP
control's display field. The programmer parses the string entered by the user and then updates the DTP control in a
way that corresponds to the entered string.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The distribution of the ooDialog framework contains an example program:
<computeroutput>samples\oodialog\controls\userStringDTP.rex</computeroutput> that focuses on the USERSTRING
notification. This example is a portion of the event handler for the USERSTRING event from that program.
</para>
<para>
The DTP control in the program is initially set to the current system date and time. Naturally, as the program runs,
the system date and time continue to advance. It would be difficult for the user to reset the DTP control to the
current system date and time, so the program allows the user to type a <emphasis role="italic">r</emphasis> or a
<emphasis role="italic">c</emphasis> in the DTP to reset its display to the current system date and time:
<programlisting>
<![CDATA[
::method onUserString unguarded
expose resetting stInvalid
use arg dt, userStr, id, hwnd
stInvalid~setText('')
-- Check for the shortcut to set the DTP to the current date and time.
upStr = userStr~upper
if upStr == 'C' | upStr == 'R' | upStr == 'CANCEL' | upStr == 'RESET' then do
resetting = .true
return .DateTime~new
end
...
return newDT
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End UserString Event Handler -->
</section> <!-- End EventNotification::connectDateTimePickerEvent() -->
<section id="mthConnectDraw" xreflabel="connectDraw"><title>connectDraw</title>
<indexterm><primary>connectDraw</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectDraw</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectDraw</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectDraw--(--+-----+--+---------------+--)---------------><
+--id-+ +-,--methodName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectDraw</emphasis> method connects the draw control event notification with a method
in the Rexx dialog. This notification is sent to the underlying dialog by an owner-drawn button, combo box, list box,
or menu, when a visual aspect of the control or menu has changed.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [optional]</term>
<listitem>
<para>
The resource ID of the dialog control whose notification is being connected. This can be symbolic or numeric. If
the ID is omitted, all drawing event notifications, of all owner-drawn controls in the dialog, will invoke the
method.
</para>
</listitem></varlistentry>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the method that is to be invoked each time the draw control event occurs. The method name must not be
the empty string. If this argument is omitted, then the ooDialog framework will connect the notification to the
<computeroutput>onDraw</computeroutput> method.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>
The specified symbolic ID could not be resolved.
</para>
</listitem></varlistentry>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The notification was not connected correctly.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
The notification for the draw control is only sent to the above mentioned controls when they have the OWNERDRAW
style.
</para>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
draw events happen.
</para>
<para>
In Windows itself, the dialog receives this event notification as a WM_DRAWITEM message.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectEachSBEvent" xreflabel="connectEachSBEvent"><title>connectEachSBEvent</title>
<indexterm><primary>connectEachSBEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectEachSBEvent(-id-,-mthWhenUp-,-mthWhenDown-+---------------+--------->
+-,-mthWhenDrag-+
>--+-------+-+-------+-+-------+--+-----------+-+-----------+-+----------+----->
+-,-min-+-+-,-max-+ +-,-pos-+ +-,-mthPgUp-+ +-,-mthPgDn-+ +-,-mthTop-+
>--+-------------+-+------------+-+------------+-+-------------+--)------------><
+-,-mthButtom-+ +-,-mthTrack-+ +-,-mthEndSc-+ +-,-willReply-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectEachSBEvent</emphasis> method connects an
<xref linkend="ovvEvents"/> notification message from a scroll bar to a method in the Rexx dialog object.
Optionally, the method can also initialize the scroll bar, (set the range and current position.)
</para>
<para>
This method requires that the <xref linkend="ovvUnderlying"/> scroll bar exists. Therefore, the method
is best invoked in the <xref linkend="mthInitDialog"/> method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem><para>The ID of the scroll bar.
</para></listitem></varlistentry>
<varlistentry><term>mthWhenUp [required]</term>
<listitem><para>The method that is called each time the scroll bar is incremented.
</para></listitem></varlistentry>
<varlistentry><term>mthWhenDown [required]</term>
<listitem><para>The method that is called each time the scroll bar is decremented.
</para></listitem></varlistentry>
<varlistentry><term>mthWhenDrag [optional]</term>
<listitem><para> The method that is called each time the scroll bar is dragged with
the mouse.
</para></listitem></varlistentry>
<varlistentry><term>min, max [optional]</term>
<listitem><para> The minimum and maximum values for the scroll bar.
</para></listitem></varlistentry>
<varlistentry><term>pos [optional]</term>
<listitem><para>The current or preselected value.
</para></listitem></varlistentry>
<varlistentry><term>mthPgUp [optional]</term>
<listitem><para>The method that is called each time the scroll bar is focused and the
PgUp key is pressed.
</para></listitem></varlistentry>
<varlistentry><term>mthPgDn [optional]</term>
<listitem><para>The method that is called each time the scroll bar is focused and the
PgDn key is pressed.
</para></listitem></varlistentry>
<varlistentry><term>mthTop [optional]</term>
<listitem><para>The method that is called each time the scroll bar is focused and the
Home key is pressed.
</para></listitem></varlistentry>
<varlistentry><term>mthBottom [optional]</term>
<listitem><para>The method that is called each time the scroll bar is focused and the
End key is pressed.
</para></listitem></varlistentry>
<varlistentry><term>mthTrack [optional]</term>
<listitem><para>The method that is called each time the scroll box is dragged.
</para></listitem></varlistentry>
<varlistentry><term>mthEndSc [optional]</term>
<listitem><para>The method that is called each time the scroll box is released after
the dragging.
</para></listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter
<link linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler. The default is
<computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. If <emphasis
role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>, the interpreter waits until the
event handling method returns a value.
</para>
</listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>
<variablelist>
<varlistentry><term>-1</term>
<listitem><para>The specified symbolic ID could not be resolved.
</para></listitem></varlistentry>
<varlistentry><term>0</term>
<listitem><para>No error.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
In the following example, scroll bar with symbolic ID IDC_SB is connected to three methods. The range is initialized
to 1 as the minimum and 20 as the maximum. The current position is set to 6:
<programlisting>
<![CDATA[
::class MyDialog subclass UserDialog
.
.
.
::method initDialog
self~connectEachSBEvent(IDC_SB,"Increase","Decrease","Drag",1,20,6)
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectEditEvent" xreflabel="connectEditEvent"><title>connectEditEvent</title>
<indexterm><primary>connectEditEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectEditEvent(--id--,--event--+---------------+--)-------><
+-,--methodName-+
]]>
</programlisting>
<para>The connectEditEvent method connects a particular
WM_NOTIFY message for an edit control with a method. The WM_NOTIFY message
informs the dialog that an event has occurred with regard to the edit control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>id</term>
<listitem><para>The ID of the edit control of which a notification is to be connected
to a method.
</para></listitem></varlistentry>
<varlistentry><term>event</term>
<listitem><para>The event to be connected with a method:
<variablelist>
<varlistentry><term>CHANGE</term>
<listitem><para>The text has been altered. This notification is sent after the screen
has been updated.
</para></listitem></varlistentry>
<varlistentry><term>UPDATE</term>
<listitem><para>The text has been altered. This notification is sent before the screen
is updated.
</para></listitem></varlistentry>
<varlistentry><term>ERRSPACE</term>
<listitem><para>An out-of-memory problem has occurred.
</para></listitem></varlistentry>
<varlistentry><term>MAXTEXT</term>
<listitem><para>The text inserted exceeds the specified number of characters for the
edit control. This notification is also sent when:
<itemizedlist>
<listitem><para>An edit control does not have the ES_AUTOHSCROLL or AUTOSCROLLH style
and the number of characters to be inserted would exceed the width of the
edit control.</para></listitem></itemizedlist>
<itemizedlist>
<listitem><para>The ES_AUTOVSCROLL or AUTOSCROLLV style is not set and the total number
of lines resulting from a text insertion would exceed the height of the edit
control.</para></listitem></itemizedlist>
</para></listitem></varlistentry>
<varlistentry><term>HSCROLL</term>
<listitem><para>The horizontal scroll bar has been used.
</para></listitem></varlistentry>
<varlistentry><term>VSCROLL</term>
<listitem><para>The vertical scroll bar has been used.
</para></listitem></varlistentry>
<varlistentry><term>GOTFOCUS</term>
<listitem><para>The edit control got the input focus.
</para></listitem></varlistentry>
<varlistentry><term>LOSTFOCUS</term>
<listitem><para>The edit control lost the input focus.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term>msgToRaise</term>
<listitem><para>The message that is to be sent whenever the specified notification is
received from the edit control. Provide a method with a matching name. If
you omit this argument, the event is preceded by <computeroutput>On</computeroutput>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return codes are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>No error detected.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>The resource ID could not be resolved or the event argument is
incorrect.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>The message was not connected correctly. The message was not connected
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<orderedlist>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
</listitem>
<listitem>
<para>
The event-handling method receives two arguments. The first arg contains information about the event. In the
low-order word is the ID of the edit control. The high-order word contains the event ID. The second arg is the
handle to the edit control.
</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
::method Handler unguarded
use arg info, handle
id = .DlgUtil~loWord(info)
eventID = .DlgUtil~hiWord(info
...
return 0
]]>
</programlisting>
</listitem>
</orderedlist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example verifies the input of entry line AMOUNT and resets
it to 0 when a nonnumeric value was entered:
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method init
self~init:super(...)
self~connectEditEvent("AMOUNT", "CHANGE")
::method onChange unguarded
ec = self~newEdit("AMOUNT")
if ec~GetText~Space(0) \= "" & ec~GetText~DataType("N") = 0 then do
ec~setModified(.false)
ec~select
ec~replaceSelText("0")
end
return 0
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectFKeyPressDialogObject" xreflabel="connectFKeyPress"><title>connectFKeyPress</title>
<indexterm><primary>connectFKeyPress</primary><secondary>dialog object</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectFKeyPress</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectFKeyPress(--methodName--)-------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">connectFKeyPress</emphasis> method connects a function key press event notification to a
method in the Rexx dialog object. </para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single arguments is;
<variablelist>
<varlistentry><term>methodName [required]</term>
<listitem>
<para>
The name of the method that is to be invoked when the key press event happens. The argument can not be the empty
string.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
Success.
</para>
</listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem>
<para>
The underlying mechanism in the Windows API that is used to capture key events failed.
</para>
</listitem></varlistentry>
<varlistentry><term>-6</term>
<listitem>
<para>
The maximum number of connections has been reached.
</para>
</listitem></varlistentry>
<varlistentry><term>-7</term>
<listitem>
<para>
The <emphasis role="italic">methodName</emphasis> method is already connected to a key down event for this
dialog.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks</emphasis></term>
<listitem>
<para>
This method works for function keys F2 through F24. In Windows the F1 key is the help key and the
<xref linkend="mthConnectHelp"/> method should be used for F1. This method is a convenience method and is
exactly equivalent to:
<programlisting>
<![CDATA[
::method initDialog
...
keys = .VK~F2 "-" .VK~F24
self~connectKeyPress(methodName, keys)
]]>
</programlisting>
</para>
<para>
The event handling method receives the same arguments as the <link linkend="connectKeyPressEventHandler">event</link>
handler for the <emphasis role="italic">connectKeyPress</emphasis> method.
</para>
<para>
Unlike most other methods that connect event notifications, the underlying Windows dialog must exist before this
method can be used. That means it can be used in <xref linkend="mthInitDialog"/> or any time
thereafter. There is a maximum limit of 63 methods, per dialog, that can be connected to key press events.
Connections can be removed using the <xref linkend="mthDisconnectKeyPressDialogObject"/>
method if there is no longer a need for a notification of a key press.
</para>
<para>
The dialog control object also has a <xref linkend="mthConnectFKeyPressDialogControlObject"/>()
method. The method of the dialog object (this method) will capture any F key press event when the dialog is the
active window. The method of the dialog control object will only capture a F key press when the control has the
keyboard focus.
</para>
<para>
Due to the nature of key press events, the low-level implementation of capturing the key strokes is different from
most of the other methods of the <computeroutput>EventNotification</computeroutput> class. There is no single message
sent to the underlying dialog for a key stroke event.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
In general error return codes are used to indicate incorrect usage rather than raised syntax conditions. However,
syntax errors are raised if the <emphasis role="italic">methodName</emphasis> argument is missing or the empty
string, or invoking this method before the <xref linkend="ovvUnderlying"/> dialog is created.
</para>
<para>
Raises syntax errors when some incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any F
Key key press events happen.
</para>
<para>
Due to the nature of key press events, the low-level implementation of capturing the key strokes is different from
most of the other methods of the <computeroutput>EventNotification</computeroutput> class. There is no single message
sent to the underlying dialog for a key stroke event.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example is a variation on the <link linkend="connectKeyPressExample">example</link> shown for the
<xref linkend="mthConnectKeyPressDialogObject"/> method. It connects all the function keys to the
same method and then determines what action to take by examining which key was pressed.
<programlisting>
<![CDATA[
::method initDialog
...
-- Capture all function key presses.
self~connectFKeyPress(onFKey)
...
::method onFKey unguarded
use arg keyPressed
select
when keyPressed == .VK~F2 then self~showCustomerLookupDialog
when keyPressed = 114 then do
prodNum = self~newEdit(IDC_EDIT_PRODUCT)~getText
if prodNum \== "" then self~showProductInfo(prodNum)
end
when keyPressed = 115 then self~resetAllFields
when keyPressed = 116 then self~printInvoice
otherwise do
-- Not interested in any other function keys
nop
end
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectHelp" xreflabel="connectHelp"><title>connectHelp</title>
<indexterm><primary>connectHelp</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectHelp</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectHelp</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectHelp(--+--------------+--)------------><
+--methodName--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectHelp</emphasis> method connects the Windows Help event with a method in the dialog. The Windows Help
event occurs when the user presses the F1 key. (Only the Help events generated when the dialog is the active window
are connected.)
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the method that to be invoked when the help event occurs. The name can not be the empty string. When
this argument is omitted the name defaults to <emphasis role="italic">onHelp</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An (internal) error prevented the message from being connected to a method.
</para>
</listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Note that the Windows help event notification connected by this method is not the same as the help <emphasis
role="bold">command</emphasis> event notification <link linkend="sctStandardEventMethods">automatically</link> connected
when a dialog object is instantiated.
</para>
<para>
The method connected to the Help event will receive the following four arguments in the order listed:
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the dialog, dialog control, or menu item that had the focus when the F1 key was pressed.
</para>
</listitem></varlistentry>
<varlistentry><term>type</term>
<listitem>
<para>
Specifies if the ID in argument 1 was from a window (a dialog or dialog control) or from a menu item. This
argument will either be <computeroutput>WINDOW</computeroutput> or <computeroutput>MENU
</computeroutput>.
</para>
</listitem></varlistentry>
<varlistentry><term>mouseX</term>
<listitem>
<para>
The x coordinate of the mouse at the time the F1 key was pressed. This value is an absolute screen coordinate
(pixel) and note that the mouse will not necessarily be over the dialog.
</para>
</listitem></varlistentry>
<varlistentry><term>mouseY</term>
<listitem>
<para>
The y coordinate of the mouse at the time the F1 key was pressed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
help events happen.
</para>
<para>
In Windows itself, the dialog receives this notification as a WM_HELP message.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
<programlisting>
<![CDATA[
::method init
self~init:super
...
self~connectResize(onResize)
self~connectHelp(onHelp)
...
::method onHelp unguarded
use arg id, type, mouseX, mouseY
if type == "MENU" then w = 'Menu id' id; else w = 'Dialog id' id
say "Help request:"
say " " w
say " Mouse position x:" mouseX "y:" mouseY
return 0
/* As the user presses the F1 key at various times when the dialog has the focus
* the output might be as follows:
*/
Help request:
Dialog id 12
Mouse position x: 420 y: 106
Help request:
Menu id 60
Mouse position x: 204 y: 93
Help request:
Menu id 65
Mouse position x: 203 y: 166
Help request:
Dialog id 14
Mouse position x: 218 y: 410
Help request:
Dialog id 80
Mouse position x: 387 y: 462
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectKeyPressDialogObject" xreflabel="connectKeyPress"><title>connectKeyPress</title>
<indexterm><primary>connectKeyPress</primary><secondary>dialog object</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectKeyPress</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectKeyPress</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectKeyPress(--methodName--,--keys-+------------+--)-----><
+-,--filter--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectKeyPress</emphasis> method connects a key press
<xref linkend="ovvEvents"/> notification with a method in the Rexx dialog. A single key or multiple keys can be
connected to the same method. Multiple methods can be connected for key press events, but only 1 method can be
connected to any single key.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>methodName [required]</term>
<listitem>
<para>
The name of the method that is to be invoked when the key press event happens. This argument can not be the
empty string.
</para>
</listitem></varlistentry>
<varlistentry><term>keys [required]</term>
<listitem>
<para>
The key (or keys) for which the key press event is to be connected. A single key or multiple keys can be
specified. A range of keys can be used. Each single key or range of keys is separated by a comma. A range of
keys is denoted by using the dash character &quot;-&quot;. White space within the <emphasis
role="italic">keys</emphasis> argument is ignored. This argument can not be the empty string.
</para>
<para>
The keys are specified by the numeric value defined by Microsoft for its virtual key set. These numeric values
are 0 through 255. There are some integer values between 0 and 255 that do not have a virtual key assigned to
them. For example, 0, 7, 10, 11, and 255 are not used. The <xref linkend="clsVK"/> class contains
constants for all of the defined virtual keys.
</para>
<para>
In addition, there are a few keywords that can be used to specify some common key ranges. These keywords are:
<variablelist>
<varlistentry><term>ALL</term>
<listitem>
<para>
All keys.
</para>
</listitem></varlistentry>
<varlistentry><term>FKEYS</term>
<listitem>
<para>
All Function keys, other than F1. (In Windows the F1 key is the help key and the
<xref linkend="mthConnectHelp"/> method should be used for F1.)
</para>
</listitem></varlistentry>
<varlistentry><term>ALPHA</term>
<listitem>
<para>
The keys A though Z.
</para>
</listitem></varlistentry>
<varlistentry><term>NUMERIC</term>
<listitem>
<para>
The keys 0 through 9. Note that these are the normal number keys, not the keypad numbers on an enhanced
keyboard.
</para>
</listitem></varlistentry>
<varlistentry><term>ALPHANUMERIC</term>
<listitem>
<para>
The keys A through Z and 0 through 9.
</para>
</listitem></varlistentry>
</variablelist>
</para>
<para>
<emphasis role="bold">Note</emphasis> that case is insignificant for these keywords as is the order of the
keywords. A keyword not in the list will result in a return of -9. However, if the argument contains other valid
key tokens, those keys will be connected to the method. If there are no other valid key tokens, then no
connection is made.
</para>
</listitem></varlistentry>
<varlistentry><term>filter [optional]</term>
<listitem>
<para>
A (simplistic) filter that is applied to the key press event for the key(s) specified. The filter is a string of
keywords separated by blanks. (Case is not significant, neither is the order of the words. Any words other than
the specified keywords are ignored.) The possible keywords are: <computeroutput>SHIFT, CONTROL, ALT, AND, NONE,
VIRTUAL.</computeroutput>
</para>
<para>
The VIRTUAL keyword can be abbreviated to VIRT if desired. The VIRTUAL keyword effects how the test for the
shift, control, and alt key is performed. By default the physical state of the keyboard is checked to see if the
control, alt, or shift key is depressed. However, it is common in Windows to use keystroke programs that inject
keystrokes into other application windows. Testing the physical state of the keyboard will not detect
combination keystrokes like Ctrl-S, Alt-L, etc., that are inserted by keystroke programs because the physical
state of the modifier keys control and alt will not be depressed. If the VIRTUAL keyword is used, the test for
the modifier keys being down will be altered in a way that will detect if the virtual state of the key is down.
This test will detect key events inserted into the Rexx application by third party keystroke programs.
</para>
<para>
Shift, control, and alt specify that the corresponding key must be down at the time of the key press event. These
keywords are combined in a boolean expression. The default is an OR expression. If the AND keyword is present
then the boolean expression is an AND expression. If the NONE keyword is used, it means that none of the shift,
control, or alt keys can be down at the time of the key press event. (When NONE is used, all other words,
except VIRTUAL, in the string are ignored.)
</para>
<para>
Some examples may make this more clear:
<programlisting>
<![CDATA[
::method initDialog
-- Using the below, the onAltCD method would be invoked when the user types
-- Alt-Shift-C or Alt-Shift-D. But the method would not be invoked for Alt-C
-- or Shift-D (or any other key press event.)
keys = .VK~C "," .VK~D
self~connectKeyPress(onAltCD, keys, "ALT AND SHIFT")
-- The below would invoke the onAltCD method any time a C or a D was typed
-- with either the Alt or the Control key down. This would include Alt-C,
-- Alt-Shift-C, Ctrl-Alt-Shift-C, etc..
self~connectKeyPress(onAltCD, keys, "ALT CONTROL")
-- The below would invoke the onAltCD method only when Alt-C or Alt-D was
-- typed.
self~connectKeyPress(onAltCD, keys, "ALT AND")
-- The below would invoke the onF4 method only when the F4 key was pressed by
-- itself. Alt-F4, Ctrl-F4, etc., would not invoke the method.
self~connectKeyPress(onF4, .VK~F4, "NONE")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
Success.
</para>
</listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem>
<para>
The underlying mechanism in the Windows API that is used to capture key events failed.
</para>
</listitem></varlistentry>
<varlistentry><term>-6</term>
<listitem>
<para>
The maximum number of connections has been reached.
</para>
</listitem></varlistentry>
<varlistentry><term>-7</term>
<listitem>
<para>
The <emphasis role="italic">methodName</emphasis> method is already connected to a key down event for this
dialog.
</para>
</listitem></varlistentry>
<varlistentry><term>-8</term>
<listitem>
<para>
The <computeroutput>filter</computeroutput> argument is not correct.
</para>
</listitem></varlistentry>
<varlistentry><term>-9</term>
<listitem>
<para>
An incorrect format for the <computeroutput>keys</computeroutput>. Note that it is possible to get a return of
-9 but still have some keys connected. For instance in the following example the C and D keys would be connected
and the filter applied. The &quot;"dog&quot;" token would result in -9 being returned:
<programlisting>
<![CDATA[
keys = .VK~C ", dog," .VK~D
ret = self~connectKeyPress('onAltCD', keys, "ALT AND SHIFT")
say 'Got a return of:' ret
say "Have connection to onAltCD?" self~hasKeyPressConnection('onAltCD')
-- The output would be:
Got a return of: -1
Have connection to onAltCD? 1
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks</emphasis></term>
<listitem>
<para>
Unlike most other methods that connect event notifications, the underlying Windows dialog must exist before this
method can be used. That means it can be used in <xref linkend="mthInitDialog"/> or any time
thereafter. There is a maximum limit of 63 methods, per dialog, that can be connected to key press events.
Connections can be removed using the <xref linkend="mthDisconnectKeyPressDialogObject"/>
method if there is no longer a need for a notification of a key press.
</para>
<para>
The dialog control object also has a <xref linkend="mthConnectKeyPressDialogControlObject"/>()
method. It is important to note this distinction between the two methods. The method of the dialog object (this
method) will capture all key press events when the dialog is the active window. This includes key presses when a
dialog control in the dialog has the focus.
</para>
<para>
The method of the dialog control object will only capture key press events when the specific dialog control has
the focus. This implies that if you connect the same key press event to both the dialog and to a specific dialog
control, if the key press event occurs when the dialog control has the focus, you will receive two event
notifications.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
In general error return codes are used to indicate incorrect usage rather than raised syntax conditions. However,
syntax errors are raised for missing required arguments, using the empty string for required arguments, or invoking
this method before the <xref linkend="ovvUnderlying"/> dialog is created.
</para>
<para>
Raises syntax errors when some incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
draw events happen.
</para>
<para>
Due to the nature of key press events, the low-level implementation of capturing the key strokes is different from
most of the other methods of the <computeroutput>EventNotification</computeroutput> class. There is no single message
sent to the underlying dialog for a key stroke event.
</para>
</listitem></varlistentry>
<varlistentry id="connectKeyPressEventHandler"><term><emphasis role="bold">Event Handler Method Arguments:</emphasis></term>
<listitem>
<para>
The ooDialog method connected to the key press event will receive the following five arguments in the order listed:
<variablelist>
<varlistentry><term>keyCode</term>
<listitem>
<para>
The numeric code of the key pressed.
</para>
</listitem></varlistentry>
<varlistentry><term>shift</term>
<listitem>
<para>
A boolean (true or false) that denotes whether a shift key was down or up at the time of the key press. It will
be true if a shift key was down and false if the shift key was not down.
</para>
</listitem></varlistentry>
<varlistentry><term>control</term>
<listitem>
<para>
True if a control key was down at the time of the key press, false if it was not.
</para>
</listitem></varlistentry>
<varlistentry><term>alt</term>
<listitem>
<para>
True if an alt key was down at the time of the key press, false if it was not.
</para>
</listitem></varlistentry>
<varlistentry><term>extraInfo</term>
<listitem>
<para>
This argument is a string containing keywords. It supplies extra information about the keyboard state at the
time of a key press event. The string will contain some combination of these keywords
<variablelist>
<varlistentry><term>numOn</term>
<listitem>
<para>
Num Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>numOff</term>
<listitem>
<para>
Num Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>capsOn</term>
<listitem>
<para>
Caps Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>capsOff</term>
<listitem>
<para>
Caps Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>scrollOn</term>
<listitem>
<para>
Scroll Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>scrollOff</term>
<listitem>
<para>
Scroll Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>lShift</term>
<listitem>
<para>
The left shift key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rShift</term>
<listitem>
<para>
The right shift key was down.
</para>
</listitem></varlistentry>
<varlistentry><term>lControl</term>
<listitem>
<para>
The left control key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rControl</term>
<listitem>
<para>
The right control key was down.
</para>
</listitem></varlistentry>
<varlistentry><term>lAlt</term>
<listitem>
<para>
The left alt key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rAlt</term>
<listitem>
<para>
The right alt key was down.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry id="connectKeyPressExample"><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example is from a fictitious customer order system. As the user is filling out a customer order using
the customer order dialog, he has the F2 through F5 short cut keys available. F2 brings up a customer look up
dialog. F3 looks up info on the product number entered in an edit control. F4 resets the form by clearing all the
fields. F5 is used to print out the finished invoice.
<programlisting>
<![CDATA[
::method initDialog
...
-- Capture F2 key presses, but not Ctrl-F2 or Alt-F2, etc..
self~connectKeyPress(onF2, .VK~VK_F2, "NONE")
-- Same idea for F3, F4, and F5. This uses the actual numeric value for the
-- keys without bothering to use the VK class to translate.
self~connectKeyPress(onF3, 114, "NONE")
self~connectKeyPress(onF4, 115, "NONE")
self~connectKeyPress(onF5, 116, "NONE")
...
::method onF2 unguarded
self~showCustomerLookupDialog
return 0
::method onF3 unguarded
prodNum = self~newEdit(IDC_EDIT_PRODUCT)~getText
if prodNum \== "" then self~showProductInfo(prodNum)
return 0
::method onF4 unguarded
self~resetAllFields
return 0
::method onF5 unguarded
self~printInvoice
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectListBoxEvent" xreflabel="connectListBoxEvent"><title>connectListBoxEvent</title>
<indexterm><primary>connectListBoxEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectListBoxEvent(--id--,--event--+---------------+--)----><
+-,--methodName-+
]]>
</programlisting>
<para>The connectListBoxEvent method connects a particular
WM_NOTIFY message for a list box with a method. The WM_NOTIFY message
informs the dialog that an event has occurred in the list box.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>id</term>
<listitem><para>The ID of the list box of which a notification is to be connected to
a method.
</para></listitem></varlistentry>
<varlistentry><term>event</term>
<listitem><para>The event to be connected with a method:
<variablelist>
<varlistentry><term>DBLCLK</term>
<listitem><para>An entry in the list box has been selected with a double click.
</para></listitem></varlistentry>
<varlistentry><term>ERRSPACE</term>
<listitem><para>An out-of-memory problem has occurred.
</para></listitem></varlistentry>
<varlistentry><term>GOTFOCUS</term>
<listitem><para>The list box got the input focus.
</para></listitem></varlistentry>
<varlistentry><term>LOSTFOCUS</term>
<listitem><para>The list box lost the input focus.
</para></listitem></varlistentry>
<varlistentry><term>SELCANCEL</term>
<listitem><para>The selection in the list box has been canceled.
</para></listitem></varlistentry>
<varlistentry><term>SELCHANGE</term>
<listitem><para>Another list box entry has been selected.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term>msgToRaise</term>
<listitem><para>The message that is to be sent whenever the specified notification is
received from the list box. Provide a method with a matching name. If you
omit this argument, the event is preceded by <computeroutput>On</computeroutput>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return codes are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>No error detected.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>The resource ID could not be resolved or the event argument is
incorrect.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>The message was not connected correctly. The message was not connected
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
<para>
The event-handling methods receive two arguments: the first is a combination of the ID of the listbox and the ID of
the notification message. (Extract the low-order word to get the listbox ID.) The second argument is the window
handle of the listbox. Example:
<programlisting>
<![CDATA[
::method playSong unguarded
use arg eventID, handle
id = .DlgUtil~loWord(eventID)
...
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example displays the text of the selected list box entry:
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method init
self~connectListBoxEvent(IDC_LB_PLAYLIST, "SELCHANGE", "SelectionChanged")
::method selectionChanged unguarded
li = self~newListBox(IDC_LB_PLAYLIST)
say "New selection is:" li~selected
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectListViewEvent" xreflabel="connectListViewEvent"><title>connectListViewEvent</title>
<indexterm><primary>connectListViewEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>-connectListViewEvent(--id--,--event--+---------------+--+-------------+--)--><
+-,--methodName-+ +-,-willReply-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectListViewEvent</emphasis> method connects a particular
<xref linkend="ovvEvents"/> notification from a list-view control with an event handling method in the Rexx
dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The ID of the list-view control for which a notification is to be connected. This can be symbolic or numeric.
</para>
</listitem></varlistentry>
<varlistentry><term>event [required]</term>
<listitem>
<para>
The event keyword. Use exactly one of the following keywords, case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>ACTIVATE</member>
<member>BEGINDRAG</member>
<member>BEGINEDIT</member>
<member>BEGINRDRAG</member>
<member>CHANGING</member>
<member>CHANGED</member>
<member>CHECKBOXCHANGED</member>
<member>CLICK</member>
<member>COLUMNCLICK</member>
<member>DBLCLK</member>
<member>DEFAULTEDIT</member>
<member>DELETE</member>
<member>DELETEALL</member>
<member>ENDEDIT</member>
<member>FOCUSCHANGED</member>
<member>GETINFOTIP</member>
<member>INSERTED</member>
<member>KEYDOWN</member>
<member>KEYDOWNEX</member>
<member>SELECTCHANGED</member>
<member>SELECTFOCUSCHANGED</member>
</simplelist>
</para>
<variablelist>
<varlistentry><term>ACTIVATE</term>
<listitem>
<para>
An item is activated by double-clicking the left mouse button.
</para>
</listitem></varlistentry>
<varlistentry><term>BEGINDRAG</term>
<listitem>
<para>
A drag-and-drop operation was initiated. See <xref linkend="mthDefListDragHandler"/> for information on how to
implement a drag-and-drop handler.
</para>
</listitem></varlistentry>
<varlistentry id="kywListViewBEGINEDIT" xreflabel="BEGINEDIT"><term>BEGINEDIT</term>
<listitem>
<para>
Editing a label has been started. Do not connect this event if you are using the DEFAULTEDIT keyword. The results are
undefined. The list-view must have the <xref linkend="styListViewEDIT"/> style for this notification to be sent.
</para>
<para>
The event notification for this event has been enhanced since the original ooDialog implementation. To use the
enhanced event notification, the <emphasis role="italic">willReply</emphasis> argument must be used. The value of the
argument, true or false, does not matter. If <emphasis role="italic">willReply</emphasis> is omitted, the old style
notification is used. The documentation for the <link linkend="evtListViewBEGINEDIT">BEGINEDIT</link> event handler
explains the difference between the two types of notifications.
</para>
</listitem></varlistentry>
<varlistentry><term>BEGINRDRAG</term>
<listitem>
<para>
A drag-and-drop operation involving the right mouse button was initiated. See
<xref linkend="mthDefListDragHandler"/> for information on how to implement a drag-and-drop
handler.
</para>
</listitem></varlistentry>
<varlistentry id="kywListViewDEFAULTEDIT" xreflabel="DEFAULTEDIT"><term>DEFAULTEDIT</term>
<listitem>
<para>
This keyword is used to activate the internal handling of the list-view label editing operation. With this keyword,
the ooDialog framework internally handles the BEGINEDIT and ENDEDIT notifications. The list-view must have the <xref
linkend="styListViewEDIT"/> style for the BEGINEDIT / ENDEDIT notification to be sent. While using the DEFAULTEDIT
connection may seem easier than using the BEGINEDIT / ENDEDIT connections, it does not provide the same flexibility
as using the BEGINEDIT / ENDEDIT connections.
</para>
<para>
When you specify this event connection, omit the <emphasis role="italic">methodName</emphasis> argument, the arugment
is ignored. Do not connect either the BEGINEDIT or ENDEDIT events when also using the DEFAULTEDIT connection. The
result is undefined.
</para>
</listitem></varlistentry>
<varlistentry><term>CHANGING</term>
<listitem>
<para>
An item is about to change. The notification for this event is sent before the item is changed.
</para>
</listitem></varlistentry>
<varlistentry><term>CHANGED</term>
<listitem>
<para>
An item has changed. The notification for this event is sent after the item changed.
</para>
</listitem></varlistentry>
<varlistentry><term>CHECKBOXCHANGED</term>
<listitem>
<para>
The check box state of an item changed. (The check box was checked or unchecked.) This event can only occur if
the list-view has the check box <link linkend="mthAddExtendedStyle">extended</link> list-view style. Use this
keyword instead of the CHANGED keyword.
</para>
</listitem></varlistentry>
<varlistentry><term>CLICK</term>
<listitem>
<para>
This event is generated when the list-view is clicked with the left mouse button. However, in report view only,
this excludes the column headers. Connecting the CLICK event is a replacement for the
<xref linkend="mthConnectNotifyEvent"/> method's CLICK event.
</para>
</listitem></varlistentry>
<varlistentry><term>COLUMNCLICK</term>
<listitem>
<para>
In report view only, a column header has been clicked. Contrast this with the CLICK keyword.
</para>
</listitem></varlistentry>
<varlistentry><term>DBLCLK</term>
<listitem>
<para>
This event is generated when the list-view is double-clicked with the left mouse button. However, in
report view only, this excludes the column headers. Connecting the DBLCLK event is a replacement for the
<xref linkend="mthConnectNotifyEvent"/> method's DBLCLK event.
</para>
</listitem></varlistentry>
<varlistentry><term>DELETE</term>
<listitem>
<para>
An item has been deleted.
</para>
</listitem></varlistentry>
<varlistentry><term>DELETEALL</term>
<listitem>
<para>
All items have been deleted.
</para>
</listitem></varlistentry>
<varlistentry id="kywListViewENDEDIT" xreflabel="ENDEDIT"><term>ENDEDIT</term>
<listitem>
<para>
Label editing has ended. Do not connect this event if you are using the DEFAULTEDIT keyword. The results are
undefined. The list-view must have the <xref linkend="styListViewEDIT"/> style for this notification to be sent.
</para>
<para>
The event notification for this event has been enhanced since the original ooDialog implementation. To use the
enhanced event notification, the <emphasis role="italic">willReply</emphasis> argument must be used. The value of the
argument, true or false, does not matter. If <emphasis role="italic">willReply</emphasis> is omitted, the old style
notification is used. The documentation for the <link linkend="evtListViewENDEDIT">ENDEDIT</link> event handler
explains the difference between the two types of notifications.
</para>
</listitem></varlistentry>
<varlistentry><term>FOCUSCHANGED</term>
<listitem>
<para>
The focus state of an item changed. (The item gained or lost the focus.) Use this keyword instead of the
CHANGED keyword.
</para>
</listitem></varlistentry>
<varlistentry id="kywListViewGETINFOTIP" xreflabel="GETINFOTIP"><term>GETINFOTIP</term>
<listitem>
<para>
The list-view control is requesting text to display an info tip. The notification is only sent when the list-view
control has the extended <link linkend="styListViewInfoTip">INFOTIP</link> style. The extended list-view styles must
be set using the <link linkend="mthAddExtendedStyle">addExtendedStyle</link> method.
</para>
</listitem></varlistentry>
<varlistentry><term>INSERTED</term>
<listitem>
<para>
A new item has been inserted.
</para>
</listitem></varlistentry>
<varlistentry><term>KEYDOWN</term>
<listitem>
<para>
A key was pressed inside the list view. This notification is not sent while a label is being edited.
</para>
</listitem></varlistentry>
<varlistentry><term>KEYDOWNEX</term>
<listitem>
<para>
A key was pressed inside the list view. This notification is not sent while a label is being edited.
</para>
<para>
This event is exactly the same as the KEYDOWN event. Except, when this keyword is used, the ooDialog framework sends
a different set of arguments to the event handler. The additional arguments provide more information to the
programmer than the
arguments sent when the KEYDOWN keyword is used. The two keywords are needed to provide backwards compatibility.
</para>
</listitem></varlistentry>
<varlistentry><term>SELECTCHANGED</term>
<listitem>
<para>
The selection state of an item changed. (The item was selected or unselected.) Use this keyword instead of the
CHANGED keyword.
</para>
</listitem></varlistentry>
<varlistentry><term>SELECTFOCUSCHANGED</term>
<listitem>
<para>
The selection state or the focus state of an item changed. This event argument combines the selection changed
and the focus changed event into one connection. When this event is connected, separate selection changed and
focus changed events can not be connected. This keyword can be abbreviated to SELECTFOCUS. Use this keyword
instead of the CHANGED keyword.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the event handling method. This method is invoked each time the specified event occurs for the list
view control. The method name can not be the empty string. If you omit this argument, the event handler method
name is generated for you. This name will be the event keyword, preceded by <computeroutput>on</computeroutput>. For
example: <emphasis role="italic">onColumnClick</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The value of the <emphasis role="italic">willReply</emphasis> argument must be true or false. The arugment controls
whether the interpreter <link linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler. The
default is <computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. If <emphasis
role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>, the interpreter waits until the
event handling method returns a value.
</para>
<para>
<emphasis role="bold">Note:</emphasis> The <emphasis role="italic">willReply</emphasis> argument is ignored for the
GETINFOTIP event, the interpreter always waits for the reply. It makes no sense to connect this event when not planning
to return a value.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error detected.
</para>
</listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem>
<para>
The resource ID could not be resolved or the event argument is incorrect.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The event was not connected correctly. The error is likely caused by the message table being full, but could also
indicate the interpreter is out of memory.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Microsoft continually enhances the Windows User Interface and therefore the dialog controls evolve over time. The
<computeroutput>connectListViewEvent</computeroutput> method uses several event keywords that provide more
information, for the same event, than that provided by the original ooDialog implementation. For instance, the
CHECKBOXCHANGED, SELECTIONCHANGED, FOCUSCHANGED, and SELECTFOCUSCHANGED keywords all connect the same event as the
CHANGED keyword. However, these keyword connections all provide more specific, detailed information in the arguments
passed to the connected method than that provided by using the CHANGED keyword.
</para>
<para>
Likewise, the <computeroutput>connectListViewEvent</computeroutput> CLICK keyword provides much better information
than that provided by the <xref linkend="mthConnectNotifyEvent"/>'s CLICK keyword.
</para>
<para>
<emphasis role="bold">Note:</emphasis> If the same event, for the same control, is connected using two different
connectXXX methods, only one connection will be in effect. Which connectXXX method is invoked is undefined. For example,
take a dialog that has a list-view control with resource ID of 109. If the mouse click event is connected for that
control using the <computeroutput>connectNotifyEvent</computeroutput> method and then the mouse click event is also
connected using the <computeroutput>connectListViewEvent</computeroutput> method, only one connection will be active.
Which one is active is undefined.
</para>
<para>
When using <computeroutput>connectListViewEvent</computeroutput> a separate method can be connected to each of the
CHECKBOXCHANGED, SELECTIONCHANGED, and FOCUSCHANGED events. These event connections are all replacements for the CHANGED
event.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example connects the column-clicked event for the list-view EMPLOYEES with method ColumnAction and
changes the style of the list-view from REPORT to SMALLICON:
</para>
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method init
self~init:super(...)
self~connectListViewEvent("EMPLOYEES", "COLUMNCLICK", "columnAction")
::method columnAction unguarded
use arg id, column
lc = self~newListView("EMPLOYEES")
lc~replaceStyle("REPORT", "SMALLICON EDIT SINGLESEL ASCENDING")
if column > 0 then ...
return 0
]]>
</programlisting>
</listitem></varlistentry>
</variablelist>
<section id="evtListViewBEGINDRAG" xreflabel="BEGINDRAG"><title>BeginDrag Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>BEGINDRAG</secondary></indexterm>
<para>
The event-handling method connected to BEGINDRAG receives three arguments: the control ID of the list-view control,
the index of the list item to be dragged, and the point where the mouse cursor was pressed (x and y positions,
separated by a blank).
</para>
<programlisting>
<![CDATA[
::method onBeginDrag unguarded
use arg id, item, where
return 0
]]>
</programlisting>
</section>
<section id="evtListViewBEGINRDRAG" xreflabel="BEGINRDRAG"><title>BeginRDrag Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>BEGINRDRAG</secondary></indexterm>
<para>
The event-handling method connected to BEGINRDRAG receives three arguments: the control ID of the list-view control,
the index of the list item to be dragged, and the point where the mouse cursor was pressed (x and y positions,
separated by a blank).
</para>
<programlisting>
<![CDATA[
::method onBeginRightDrag unguarded
use arg id, item, where
return 0
]]>
</programlisting>
</section>
<section id="evtListViewBEGINEDIT" xreflabel="BEGINEDIT"><title>BeginEdit Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>BEGINEDIT</secondary></indexterm>
<para>
The event handler for the BEGINEDIT event is invoked when the user begins a label editing operation on an item of the
list-view. When label editing begins, an edit control is created by the operating systm, but not positioned or displayed.
Before it is displayed, the tree-view control sends a BEGINEDIT notification message. A label editing operation is only
available when the list-view has the <xref linkend="styListViewEDIT"/> style.
</para>
<para>
In general, the programmer would connect both the BEGINEDIT and <xref linkend="evtListViewENDEDIT"/> notifications. Both of
these event notifications have been enhanced since the original ooDialog implementation. If the <emphasis
role="italic">willReply</emphasis> argument to the <xref linkend="mthConnectListViewEvent"/> method is omitted the old
implementation is used. If the argument is not omitted, the new implementation is used. How the two event handlers work is
described separately.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">New event handler description:</emphasis></term>
<listitem>
<para>
Whether the programmer must return a value and if the interpreter waits, or does not wait, for this return is
determined by the value of the <emphasis role="italic">willReply</emphasis> argument. If <emphasis
role="italic">willReply</emphasis> is true, the programmer must return true or false from the event handler and the
interpreter waits for that reply. If <emphasis role="italic">willReply</emphasis> is false the interpreter does not
wait for a reply.
</para>
<programlisting>
<![CDATA[
::method onBeginEdit unguarded
use arg id, itemID, editCtrl, listViewCtrl
return zz
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource id of the list-view sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>itemID</term>
<listitem>
<para>
The item index whose label is about to be edited.
</para>
</listitem></varlistentry>
<varlistentry><term>editCtrl</term>
<listitem>
<para>
The Rexx edit control object used for the editing operation. The programmer can customize the editing operation by
using the methods of the <link linkend="clsEdit">Edit</link> class.
</para>
<para>
<emphasis role="bold">Note</emphasis> that this object is only valid during the editing operation. When the user
ends the editing, the operating system destroys the underlying edit control and the Rexx object is no longer valid.
Each time the user starts a new editing operation, the operating system creates a new edit control.
</para>
</listitem></varlistentry>
<varlistentry><term>listViewCtrl</term>
<listitem>
<para>
The Rexx list-view object whose underlying list-view control has sent the notification. This is a convenience for
the programmer. It is the same Rexx object the programmer would recieve through the <xref
linkend="mthNewListView"/> method. Unlike the <emphasis role="italic">editCtrl</emphasis> object, this object is
valid as long as the dialog is executing.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
When the programmer used true for the <emphasis role="italic">willReply</emphasis> argument, the event handler must
return true or false. To allow the editing operation to begin, return true. To cancel the editing operation, return
false. Returning a value from the event handler gives the programmer the option determining if the label for the
specific list-view item should or should not be edited.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example shows a possible event handler for the BEGINEDIT event. It uses the <emphasis
role="italic">itemIndex</emphasis> argument to determine which item is about the have its label edited, and checks
that editing is allowed for that item. If it is, it returns true to allow the operation. If it is not, it returns
false to cancel the operation and puts up a message box to inform the user:
<programlisting>
<![CDATA[
::method onBeginEdit unguarded
use arg id, itemIndex, editCtrl, listViewCtrl
rec = listViewCtrl~getItemData(itemIndex)
if rec~isEditable then return .true
reply .false
msg = "The record for" rec~FirstName rec~LastName 'can not be changed.'
title = "Label Edit Error"
j = MessageDialog(msg, self~hwnd, title, , "WARNING")
return
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Old event handler description:</emphasis></term>
<listitem>
<para>
The old style event notification is used when the programmer omits the <emphasis role="italic">willReply</emphasis>
argument in the invocation of the <xref linkend="mthConnectListViewEvent"/> method. The return from the event handler is
completely ignored, the interpreter does not wait for this return.
</para>
<programlisting>
<![CDATA[
::method onBeginEdit unguarded
use arg id, useless
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 2 arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource id of the list-view sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>useless</term>
<listitem>
<para>
This is an operating system value that has no meaning within Rexx code. It can not be used for anything and its value
does not correlate with anything accessible to the Rexx programmer.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
Returning, or not returning, a value has no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks</emphasis></term>
<listitem>
<para>
Connecting this event and not using the <emphasis role="italic">willReply</emphasis> argument does not make much sense.
The event handler really serves no purpose.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BeginEdit Event Handler -->
<section id="evtListViewCHECKBOXCHANGED" xreflabel="CHECKBOXCHANGED"><title>CheckBoxChanged Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>CHECKBOXCHANGED</secondary></indexterm>
<para>
The event handler for the checkbox changed event is invoked when the user checks or unchecks a checkbox in the
<computeroutput>ListView</computeroutput> control. The method receives three arguments:
</para>
<programlisting>
<![CDATA[
::method onCheckboxChanged unguarded
use arg id, itemIndex, state
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the list-view control whose item had the checkbox state changed.
</para>
</listitem></varlistentry>
<varlistentry><term>itemIndex</term>
<listitem>
<para>
The index of the item whose checkbox was changed.
</para>
</listitem></varlistentry>
<varlistentry><term>state</term>
<listitem><para>This argument reports whether the check box was checked or
unchecked. Its value will be either &quot;CHECKED&quot; or &quot;UNCHECKED&quot;
</para></listitem></varlistentry>
</variablelist>
<para>
<emphasis role="bold">Example:</emphasis> The following example is from an address book application. A list-view
control is filled with the information from the address book, one item for each entry. The check box changed event is
connected to the <emphasis role="italic">onCheckboxChanged</emphasis> method. The <emphasis
role="italic">onCheckboxChanged</emphasis> method will receive 3 arguments: the resource ID of the control, the index
of the item whose check box changed, and the changed state. If the user checks the check box, that entry is added to a
mail merge being constructed. If the user unchecks the box, the entry is removed from the mail merge.
</para>
<programlisting>
<![CDATA[
::class MailingListDlg subclass UserDialog
::method initDialog
expose mailList
...
mailList = self~newListView(IDC_LV_ADDRESSES)
...
-- Since the methodName argument is omitted, ooDialog will construct a default
-- name of 'onCheckboxChanged'
self~connectListViewEvent(IDC_LV_ADDRESSES, "CHECKBOXCHANGED")
...
::method onCheckboxChanged unguarded
expose mailList
use arg id, itemIndex, state
if state == "CHECKED" then
self~addToMailMerge(mailList, itemIndex)
else
self~removeFromMailMerge(mailList, itemIndex)
return 0
]]>
</programlisting>
</section> <!-- End CheckBoxChanged Event Handler -->
<section id="evtListViewCLICK" xreflabel="CLICK"><title>Click / Double Click Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>CLICK</secondary></indexterm>
<indexterm><primary>ListView Event</primary><secondary>DBLCLK</secondary></indexterm>
<para>
The event handling method for the CLICK event is invoked when the user clicks on the list-view with the left mouse.
The event handler for the DBLCLK is invoked when the user double clicks on the list-view. This excludes the column
headers in report view. Both event handlers receive the same arguments.
</para>
<para>
Note that the user can click on a list-view item, or on the background of the list view. When the click is on the
background of the list-view then both the <emphasis role="italic">itemIndex</emphasis> and <emphasis
role="italic">columnIndex</emphasis> will be -1. The method will receive four arguments:
</para>
<programlisting>
<![CDATA[
::method onClick unguarded
use arg id, itemIndex, columnIndex, keyState
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the list-view control whose item was clicked.
</para>
</listitem></varlistentry>
<varlistentry><term>itemIndex</term>
<listitem>
<para>
The zero-based index of the item that was clicked, or -1 if the background of the list-view was clicked. In report
view this is often thought of as the row index.
</para>
</listitem></varlistentry>
<varlistentry><term>columnIndex</term>
<listitem>
<para>
The zero-based index of the subitem that was clicked, or -1 if the click was on the background of the list view. In
report view this is often thought of as the column of row. In all views other than report view, this arg will always
be 0.
</para>
</listitem></varlistentry>
<varlistentry><term>keyState</term>
<listitem>
<para>
This argument reports the state of the shift, control, and alt keys at the time of the mouse click. The argument is
a string of keywords separated by blanks. The keywords consist of: SHIFT, CONTROL, ALT, or NONE. The presence of a
keyword indicates the key was held down when the user clicked on the list-view control. NONE of course indicates
that none of the keys were down. If the user managed to hold all three of the keys down at the time of the mouse
click, the argument would be the string: <emphasis role="italic">SHIFT CONTROL ALT</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="evtListViewCOLUMNCLICK" xreflabel="COLUMNCLICK"><title>ColumnClick Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>COLUMNCLICK</secondary></indexterm>
<para>
The event-handling method connected to COLUMNCLICK receives two arguments: the control ID of the list-view control and
the zero-based column number of which the header button was pressed.
</para>
<programlisting>
<![CDATA[
::method onColumnClick unguarded
use arg id, column
return 0
]]>
</programlisting>
</section>
<section id="evtListViewENDEDIT" xreflabel="ENDEDIT"><title>EndEdit Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>ENDEDIT</secondary></indexterm>
<para>
The event handler for the ENDEDIT event is invoked when the user finishes a label editing operation on an item of the
list-view. A label editing operation is only available when the list-view has the <xref linkend="styListViewEDIT"/> style.
</para>
<para>
In general, the programmer would connect both the <xref linkend="evtListViewBEGINEDIT"/> and ENDEDIT notifications. Both
of these event notifications have been enhanced since the original ooDialog implementation. If the <emphasis
role="italic">willReply</emphasis> argument to the <xref linkend="mthConnectListViewEvent"/> method is omitted the old
implementation is used. If the argument is not omitted, the new implementation is used. How the two event handlers work is
described separately.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">New event handler description:</emphasis></term>
<listitem>
<para>
Whether the programmer must return a value and if the interpreter waits, or does not wait, for this return is
determined by the value of the <emphasis role="italic">willReply</emphasis> argument. If <emphasis
role="italic">willReply</emphasis> is true, the programmer must return true or false from the event handler and the
interpreter waits for that reply. If <emphasis role="italic">willReply</emphasis> is false the interpreter does not
wait for a reply.
</para>
<programlisting>
<![CDATA[
::method onEndEdit unguarded
use arg id, itemID, text, listViewCtrl
return trueOrFalse
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource id of the list-view sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>itemID</term>
<listitem>
<para>
The item index whose label being edited.
</para>
</listitem></varlistentry>
<varlistentry><term>text</term>
<listitem>
<para>
If the user canceled the edit operation then the <emphasis role="italic">text</emphasis> argument will be the .nil
object. If the edit operation was not canceled then this argument will be the text the user entered.
</para>
</listitem></varlistentry>
<varlistentry><term>listViewCtrl</term>
<listitem>
<para>
The Rexx list-view object whose underlying list-view control has sent the notification. This is a convenience for
the programmer. It is the same Rexx object the programmer would recieve through the <xref
linkend="mthNewListView"/> method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
When the programmer used true for the <emphasis role="italic">willReply</emphasis> argument, the event handler must
return true or false. To accept the edit text, return true. To disallow the the change to the label, return false.
If, the edit operation was canceled by the user, the operating system ignores the return from the event handler.
Returning a value from the event handler gives the programmer the option of determining if the new label for the
specific list-view item is acceptable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example checks the new text entered by the user. The label for the list-view items is displayed as last
name, comma, first name. If the user's text is not in that format, the new text is rejected by returning false:
<programlisting>
<![CDATA[
::method onEndEdit unguarded
use arg id, itemIndex, text, listViewCtrl
if text == .nil then return .false
if text~words == 2 & text~word(1)~right(1) == ',' then do
reply .true
rec = listViewCtrl~getItemData(itemIndex)
rec~FirstName = text~word(2)
rec~LastName = text~word(1)~strip('T', ',')
return
end
reply .false
msg = "The format for a record label must be" || .endOfLine || -
"last name, comma, first name. For" || .endOfLine || -
"example: Swift, Tom" || .endOfLine~copies(2) || -
"The change is rejected."
title = "Label Editing Error"
j = MessageDialog(msg, self~hwnd, title, , "WARNING")
return
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Old event handler description:</emphasis></term>
<listitem>
<para>
The old style event notification is used when the programmer omits the <emphasis role="italic">willReply</emphasis>
argument in the invocation of the <xref linkend="mthConnectListViewEvent"/> method. The return from the event handler is
completely ignored, the interpreter does not wait for this return. If the user canceled the edit operation, the label
will be unchanged. If the user did not cancel the edit operation, the label of the item is changed to the text the user
entered.
</para>
<programlisting>
<![CDATA[
::method onEndEdit unguarded
use arg id, itemIndex, maybeText
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 3 arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource id of the list-view sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>itemIndex</term>
<listitem>
<para>
The index of the list-view item that was edited.
</para>
</listitem></varlistentry>
<varlistentry><term>text [optional]</term>
<listitem>
<para>
If the user canceled the edit operation, the <emphasis role="italic">text</emphasis> argument is omitted. If the user
did not cancel, then the <emphasis role="italic">text</emphasis> argument is the text the user entered.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
Returning, or not returning, a value has no meaning. The interpreter does not wait for the return and its value, if any
is discarded.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks</emphasis></term>
<listitem>
<para>
When the user does not cancel the edit operation, the operating system automatically changes the label of the item to
what the user entered. To prevent this behavior, the programmer needs to use the new style event handler by using the
<emphasis role="italic">willReply</emphasis> argument to the <xref linkend="mthConnectListViewEvent"/> method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</section> <!-- End EndEdit Event Handler -->
<section id="evtListViewGETINFOTIP"><title>GetInfoTip Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>GETINFOTIP</secondary></indexterm>
<para>
The event handler method connected to the get info tip event is invoked when the list-view control requests the text to
display in the info tip. The programmer must return a string value and the interpreter waits for this return. The <emphasis
role="italic">willRepy</emphasis> argument of the <link linkend="mthConnectListViewEvent">connectListViewEvent</link>
method is ignored for this event.
</para>
<programlisting>
<![CDATA[
::method onGetInfoTip unguarded
use arg id, itemIndex, text, maxLen
return infoText
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the list-view control requesting the info tip text.
</para>
</listitem></varlistentry>
<varlistentry><term>itemIndex</term>
<listitem>
<para>
The index of the list-view item that the info tip is for.
</para>
</listitem></varlistentry>
<varlistentry><term>text</term>
<listitem>
<para>
The current text the list-view intends to display. Note that most often this is the empty string. However, in some
cases it will not be the empty string. For instance, in report view, if the column is not wide enough to display the
entire text for the item, the <emphasis role="italic">text</emphasis> argument will contain the entire item's text.
Microsoft suggests that if <emphasis role="italic">text</emphasis> is not the empty string, the application should
append its text to the end of the string.
</para>
</listitem></varlistentry>
<varlistentry><term>maxLen</term>
<listitem>
<para>
The maximum length of the string that will be displayed. The programmer should not assume what this length is. However,
testing shows that it is usually 1023. If the returned text is longer than the <emphasis
role="italic">maxLen</emphasis> value, the text will automatically be truncated to <emphasis
role="italic">maxLen</emphasis> characters.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The event handler must return a string value. If the string is not the empty string, it will be displayed as the info
tip. If the empty string is returned, then the the previous value of <emphasis role="italic">text</emphasis> is
displayed. That is, if <emphasis role="italic">text</emphasis> is the empty string, no info tip will be shown. However,
if <emphasis role="italic">text</emphasis> is not the empty string, that text will be displayed unchanged.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example example displays an info tip that shows expanded record information for the list-view item. The
<emphasis role="italic">useInfoTips</emphasis> variable is used to determine if an info tip should be displayed or not.
If <emphasis role="italic">useInfoTips</emphasis> is false, no tip is displayed. If true the record information is
formatted and returned. Note that new line characters are used to break up the information into lines:
<programlisting>
<![CDATA[
::method onGetInfoTip unguarded
expose lv records useInfoTips
use arg id, item, text, maxLen
text = ''
if useInfoTips then do
r = records[item + 1]
text = r~firstName r~lastName '('r~age')' || .endOfLine || -
r~street || .endOfLine || -
r~city',' r~state r~zipcode
end
return text
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End GetInfoTip Event Handler -->
<section id="evtListViewKEYDOWN" xreflabel="KEYDOWN"><title>KeyDown Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>KEYDOWN</secondary></indexterm>
<para>
The event-handling method connected to KEYDOWN receives two arguments: the control ID of the list-view control and the
virtual key code pressed. Use the <xref linkend="mthKey2Name"/> method of the
<xref linkend="clsVK"/> class to determine which key was pressed.
</para>
<programlisting>
<![CDATA[
::method onKeyDown unguarded
use arg id, vkey
say "Key" .VK~key2name(vkey) "was pressed."
return 0
]]>
</programlisting>
</section>
<section id="evtListViewKEYDOWNEX" xreflabel="KEYDOWNEX"><title>KeyDown (extended) Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>KEYDOWNEX</secondary></indexterm>
<para>
The event-handling method connected through the KEYDOWNEX keyword is similar to the event handler for the <link
linkend="evtListViewKEYDOWN">KeyDown</link> event handler. It is invoked for the same event, when the user presses a key
within the list-view. However, it receives a different set of arguments than that provided when the KEYDOWN keyword is
used.
</para>
<programlisting>
<![CDATA[
::method onKeyDownEx unguarded
use arg vKey, isShift, isCtrl, isAlt, extraInfo, listViewObj
return response
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Event Handler Method Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 6 arguments:
</para>
<variablelist>
<varlistentry><term>vKey</term>
<listitem>
<para>
The virtual key code of of the key pressed. Use the <xref linkend="mthKey2Name"/> method of the <xref linkend="clsVK"/>
class to determine which key was pressed.
</para>
</listitem></varlistentry>
<varlistentry><term>isShift</term>
<listitem>
<para>
A boolean (true or false) that denotes whether a shift key was down or up at the time of the key press. It will
be true if a shift key was down and false if the shift key was not down.
</para>
</listitem></varlistentry>
<varlistentry><term>isCtrl</term>
<listitem>
<para>
True if a control key was down at the time of the key press, false if it was not.
</para>
</listitem></varlistentry>
<varlistentry><term>isAlt</term>
<listitem>
<para>
True if an alt key was down at the time of the key press, false if it was not.
</para>
</listitem></varlistentry>
<varlistentry><term>extraInfo</term>
<listitem>
<para>
This argument is a string containing keywords. It supplies extra information about the keyboard state at the
time of a key press event. The string will contain some combination of these keywords
<variablelist>
<varlistentry><term>extended</term>
<listitem>
<para>
The character event is for one of the extended keys previously mentioned, INS, DEL, HOME, END, PAGE UP, PAGE
DOWN, or one of the arrow keys.
</para>
</listitem></varlistentry>
<varlistentry><term>numOn</term>
<listitem>
<para>
Num Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>numOff</term>
<listitem>
<para>
Num Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>capsOn</term>
<listitem>
<para>
Caps Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>capsOff</term>
<listitem>
<para>
Caps Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>scrollOn</term>
<listitem>
<para>
Scroll Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>scrollOff</term>
<listitem>
<para>
Scroll Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>lShift</term>
<listitem>
<para>
The left shift key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rShift</term>
<listitem>
<para>
The right shift key was down.
</para>
</listitem></varlistentry>
<varlistentry><term>lControl</term>
<listitem>
<para>
The left control key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rControl</term>
<listitem>
<para>
The right control key was down.
</para>
</listitem></varlistentry>
<varlistentry><term>lAlt</term>
<listitem>
<para>
The left alt key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rAlt</term>
<listitem>
<para>
The right alt key was down.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>listViewObj</term>
<listitem>
<para>
The Rexx <computeroutput>ListView</computeroutput> object whose underlying Windows list-view had the keydown event.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
When the <emphasis role="italic">willReply</emphasis> argument to the <link linkend="mthConnectListViewEvent"></link>
method is true, the event handler must return a value. However, the operating system ignores the return value, so any
value can be used. 0 makes a good return.
</para>
<para>
If <emphasis role="italic">willReply</emphasis> is false, the event handler does not <emphasis
role="italic">have</emphasis> to return a value, but good practice would be to always return a value from an event
handler.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example uses an event handler that deletes the selected item if the user presses the DEL key while holding
down the control key. The next item following the deleted item is then selected. However, if the deleted item is the last
item in the last, then the previous item is selected. If the deleted item is the last item in the list, then nothing is
selected:
<programlisting>
<![CDATA[
::method onKeyDownEx unguarded
use arg vKey, isShift, isCtrl, isAlt, extraInfo, listViewObj
if vKey == .VK~DELETE & isCtrl then do
selectedIndex = listView~selected
if selectedIndex <> -1 then do
listView~delete(selectedIndex)
if selectedIndex == listView~items then do
if selectedIndex == 0 then do
-- Do nothing, there are no items in the list-view now.
nop
end
else do
listView~select(selectedIndex - 1)
end
end
else do
listView~select(selectedIndex)
end
end
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="evtListViewFOCUSCHANGED" xreflabel="FOCUSCHANGED"><title>FocusChanged Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>FOCUSCHANGED</secondary></indexterm>
<para>
The event handler for the focus changed event is invoked when an item gains or loses focus. The method receives three
arguments:
</para>
<programlisting>
<![CDATA[
::method onFocusChanged unguarded
use arg id, itemIndex, state
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the list-view control whose item had the focus changed.
</para>
</listitem></varlistentry>
<varlistentry><term>itemIndex</term>
<listitem>
<para>
The index of the item which gained or lost the focus.
</para>
</listitem></varlistentry>
<varlistentry><term>state</term>
<listitem>
<para>
This argument reports whether the focus was gained or lost. Its value will be either &quot;FOCUSED&quot; or
&quot;UNFOCUSED&quot;
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="evtListViewSELECTCHANGE" xreflabel="SELECTCHANGE"><title>SelectChange Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>SELECTCHANGE</secondary></indexterm>
<para>
The event handler for the selection changed event is invoked when the selection state of an item changes. The method
receives three arguments:
</para>
<programlisting>
<![CDATA[
::method onSelectChanged unguarded
use arg id, itemIndex, state
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the list-view control whose item had the selection changed.
</para>
</listitem></varlistentry>
<varlistentry><term>itemIndex</term>
<listitem>
<para>
The index of the item whose selection was changed.
</para>
</listitem></varlistentry>
<varlistentry><term>state</term>
<listitem>
<para>
This argument reports whether the item was selected or unselected. Its value will be either
&quot;SELECTED&quot; or &quot;UNSELECTED&quot;
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="evtListViewSELECTFOCUSCHANGED" xreflabel="SELECTFOCUSCHANGED"><title>SelectFocusChanged Event Handler</title>
<indexterm><primary>ListView Event</primary><secondary>SELECTFOCUSCHANGED</secondary></indexterm>
<para>
The event handle for the selection or focus changed event is invoked when either the selection or the focus of an item
changes. The method receives 3 arguments:
</para>
<programlisting>
<![CDATA[
::method onSelectFocusChanged unguarded
use arg id, itemIndex, state
return 0
]]>
</programlisting>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the list-view control whose item had the either the focus or the selection changed.
</para>
</listitem></varlistentry>
<varlistentry><term>itemIndex</term>
<listitem>
<para>
The index of the item where the state was changed.
</para>
</listitem></varlistentry>
<varlistentry><term>state</term>
<listitem>
<para>
This argument reports whether the focus was gained or lost and whether the selection was gained or lost. Its
value will contain at least one of the keywords: &quot;SELECTED&quot;, &quot;UNSELECTED&quot;,
&quot;FOCUSED&quot; or &quot;UNFOCUSED&quot;. It is possible for both the selection and focus changed to be
reported at once, however sometimes each change is reported separately. (This has nothing to do with ooDialog,
it is how the operating system sends the messages.)
</para>
</listitem></varlistentry>
</variablelist>
</section>
</section>
<section id="mthConnectMonthCalendarEvent" xreflabel="connectMonthCalendarEvent"><title>connectMonthCalendarEvent</title>
<indexterm><primary>connectMonthCalendarEvent</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectMonthCalendarEvent</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectMonthCalendarEvent</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectMonthCalendarEvent(--id-,-event-+---------+-+------------+--)-------><
+-,-mName-+ +-,-wilReply-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectMonthCalendarEvent</emphasis> method connects an
<xref linkend="ovvEvents"/> notification message from a month <xref linkend="clsMonthCalendar"/>
control to a method in the Rexx dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the month calendar control. May be numeric or <xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>event [required]</term>
<listitem>
<para>
Exactly one of the following keywords. The keyword specifies the event to be connected. Case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>GETDAYSTATE</member> <member>SELECT</member> <member>VIEWCHANGE</member>
<member>RELEASED</member> <member>SELCHANGE</member>
</simplelist>
</para>
<variablelist>
<varlistentry><term>GETDAYSTATE</term>
<listitem>
<para>
Sent by a month calendar control to request information about how individual days should be displayed. This
notification message is only sent if the month calendar control has the DAYSTATE style. The <emphasis
role="italic">willReply</emphasis> argument is ignored for this event, the event handler must
<link linkend="sctCodingEventHandlers">return</link> a reply.
</para>
</listitem></varlistentry>
<varlistentry><term>RELEASED</term>
<listitem>
<para>
Sent by the month calendar when the control is releasing the mouse capture. The return value from the event
handler is ignored for this event.
</para>
</listitem></varlistentry>
<varlistentry><term>SELECT</term>
<listitem>
<para>
Sent by a month calendar control when the user makes an explicit date selection within the control. The return
value from the event handler is ignored for this event.
</para>
</listitem></varlistentry>
<varlistentry><term>SELCHANGE</term>
<listitem>
<para>
Sent by a month calendar control when the currently selected date or range of dates changes. The return value
from the event handler is ignored for this event.
</para>
</listitem></varlistentry>
<varlistentry><term>VIEWCHANGE</term>
<listitem>
<para>
<emphasis role="bold">Requires Windows Vista or later</emphasis>. Sent by a month calendar control when the
current view changes. The return value from the event handler is ignored for this event.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term>mName [optional]</term>
<listitem>
<para>
The name of the method that is to be invoked whenever the specified notification is received from the month
calendar control. The programmer defines this method. If this argument is omitted, a method name is
automatically generated that consists of the event keyword preceded by <computeroutput>on</computeroutput>. For
instance, <computeroutput>onGetDayState</computeroutput>. If the method name is supplied, it can not be the
empty string.
</para>
</listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreters waits for the reply
from the event handler. The default is <computeroutput>.true</computeroutput>, the interpreter waits until the
event handling method returns a value. If <emphasis role="italic">willReply</emphasis> is
<computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. However, this argument is
ignored for the GETDAYSTATE event. If the programmer connects the GETDAYSTATE, the interpreter waits for the
return from the connected method. This can not be changed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method returns <computeroutput>.true</computeroutput> if the event notification was connected correctly,
otherwise <computeroutput>.false</computeroutput> .
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected, including the use of an invalid symbolic ID or an
unrecognized event keyword. A syntax error is raised if the programmer tries to connect the VIEWCHANGED event when
the operating system is not Windows Vista or later.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if the
connected event happens.
</para>
<para>
The underlying dialog receives the MCN_* messages as the notifications for the month calendar events.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example updates the text of a static control whenever the user selects a new date in the calendar.
</para>
<programlisting>
<![CDATA[
::method initDialog
self~connectMonthCalendarEvent(IDC_MC, "SELECT", onSelect)
::method onSelect unguarded
expose dateText
use arg startDate, endDate
dateText~setText(self~formatDate(startDate))
return 0
]]>
</programlisting>
</listitem></varlistentry>
</variablelist>
<section id="evtMonthCalendarGETDAYSTATE" xreflabel="GETDAYSTATE"><title>GetDayState Event Handler</title>
<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>GETDAYSTATE</tertiary></indexterm>
<programlisting>
<![CDATA[
::method onGetDayState unguarded
use arg startDate, count, id, hwnd
return dayStateBuffer
]]>
</programlisting>
<para>
The event handler for the get day state event is invoked when the month calendar control requests information on how
to display days in the calendar. The notification is only sent when the month calendar has the DAYSTATE style. The
programmer must reply to this notification and <emphasis role="bold">must</emphasis> use the
<xref linkend="clsDayStates"/> class to properly construct the reply. The interpreter waits for the reply.
</para>
<para>
The reply is a buffer containing a sequential collection of <xref linkend="clsDayState"/> values. Each
individual day state value specifies how each day in a single month should be displayed. If a day in the day state
value is turned on, the day is displayed in bold. If a day is not turned on, it is displayed with no emphasis. The
<computeroutput>DayStates</computeroutput> and <computeroutput>DayState</computeroutput> classes provide methods to
properly construct the day state values and the buffer containing the values.
</para>
<para>
Essentially, the programmer constructs a number of day state values and then returns a buffer containing those values.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives three arguments:
</para>
<variablelist>
<varlistentry><term>startDate</term>
<listitem>
<para>
A <computeroutput>DateTime</computeroutput> object that specifies the start date the month calendar control needs
day state values for. Each day state value specifies the state for every day in a month, even if the <emphasis
role="italic">dayState</emphasis> arg is a date in the middle of a month. I.e., if the start date is January 11,
2011, the first day state value should be for the month of January.
</para>
</listitem></varlistentry>
<varlistentry><term>count</term>
<listitem>
<para>
The number of day state values required.
</para>
</listitem></varlistentry>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID for the month calendar control requesting the information.
</para>
</listitem></varlistentry>
<varlistentry><term>hwnd</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> for the month calendar control requesting the information.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The reply is a buffer containing a sequential collection of <xref linkend="clsDayState"/> values. Each
individual day state value specifies how each day in a single month should be displayed. If a day in the day state
value is turned on, the day is displayed in bold. If a day is not turned on, it is displayed with no emphasis. The
returned buffer must be constructed by using the <xref linkend="clsDayStates"/> class.
</para>
<para>
The <computeroutput>DayStates</computeroutput> and <computeroutput>DayState</computeroutput> classes provide methods
to properly construct the day state values and the buffer containing the values. Essentially, the programmer
constructs a number of day state values and then returns a buffer containing those values.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example is used in a application that displays the 1st and the 15th of each month in bold. The start
date can be ignored in this case because the day state value is the same for any month.
<programlisting>
<![CDATA[
::method initDialog
-- Connect the GETDAYSTATE event.
self~connectMonthCalendarEvent(IDC_MC_PAYDAYS, "GETDAYSTATE", onGetDayState)
::method onGetDayState unguarded
use arg startDate, count, id, hwnd
dayStates = .array~new(count)
do i = 1 to count
dayStates[i] = .DayState~new(1, 15)
end
buffer = .DayStates~makeDayStateBuffer(dayStates)
return buffer
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End GetDayState Event Handler -->
<section id="evtMonthCalendarRELEASED" xreflabel=""><title>Released Event Handler</title>
<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>RELEASED</tertiary></indexterm>
<programlisting>
<![CDATA[
::method onReleased unguarded
use arg id, hwnd
return 0
]]>
</programlisting>
<para>
The event handler for the released event is invoked when the month calendar releases the mouse capture. The
interpreter waits, or does not wait, for the reply as specified by the programmer in the
<xref linkend="mthConnectMonthCalendarEvent"/> method. The operating system ignores the value
of the reply.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives two arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the month calendar sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwnd</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> for the month calendar control sending the notification
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
Since the return value is ignored by the operating system, any value can be used. Typically, 0 is returned.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Released Event Handler -->
<section id="evtMonthCalendarSELCHANGED" xreflabel="SELCHANGED"><title>SelChanged Event Handler</title>
<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>SELCHANGED</tertiary></indexterm>
<programlisting>
<![CDATA[
::method onSelChanged unguarded
use arg selStart, selEnd, id, hwnd
return 0
]]>
</programlisting>
<para>
The event handler for the selection changed event is invoked when the currently selected date or range of dates
changes. This notification is sent when the user explicitly changes the selection within the current month or when the
selection is implicitly changed by the user navigating to another month. The operating system also sends this
notification at regular intervals so that the month calendar control can respond to date changes.
</para>
<para>
The notification is similar to the <xref linkend="evtMonthCalendarSELECT"/> notification, except that the SELECT
notification is only sent when the user explicitly changes the date. This notification is sent when the selected date
is changed for any reason.
</para>
<para>
The interpreter waits, or does not wait, for the reply as specified by the programmer in the
<xref linkend="mthConnectMonthCalendarEvent"/> method. The operating system ignores the value
of the reply.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives three arguments:
</para>
<variablelist>
<varlistentry><term>selStart</term>
<listitem>
<para>
A <computeroutput>DateTime</computeroutput> object that is the new selected date, or the first selected date in a
range of selected dates.
</para>
</listitem></varlistentry>
<varlistentry><term>selEnd</term>
<listitem>
<para>
A <computeroutput>DateTime</computeroutput> object that is the last selected date in a range of selected dates. If
only a single date is selected, then <emphasis role="italic">selEnd</emphasis> will be the same date as <emphasis
role="italic">selStart</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the month calendar sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwnd</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> for the month calendar control sending the notification.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The return value is ignored by the operating system and the programmer can return any value. Typically 0 is
returned.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End SelChanged Event Handler -->
<section id="evtMonthCalendarSELECT" xreflabel="SELECT"><title>Select Event Handler</title>
<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>SELECT</tertiary></indexterm>
<programlisting>
<![CDATA[
::method onSelect unguarded
use arg selStart, selEnd, id, hwnd
return 0
]]>
</programlisting>
<para>
The SELECT event handler is invoked when the user explicitly selects a new date. Contrast this with the <xref
linkend="evtMonthCalendarSELCHANGED"/> event handler which is invoked when the selected date is changed for any reason.
</para>
<para>
The interpreter waits, or does not wait, for the reply as specified by the programmer in the
<xref linkend="mthConnectMonthCalendarEvent"/> method. The operating system ignores the value
of the reply.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives four arguments:
</para>
<variablelist>
<varlistentry><term>selStart</term>
<listitem>
<para>
A <computeroutput>DateTime</computeroutput> object that is the new selected date, or the first selected date in a
range of selected dates.
</para>
</listitem></varlistentry>
<varlistentry><term>selEnd</term>
<listitem>
<para>
A <computeroutput>DateTime</computeroutput> object that is the last selected date in a range of selected dates. If
only a single date is selected, then <emphasis role="italic">selEnd</emphasis> will be the same date as <emphasis
role="italic">selStart</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the month calendar sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwnd</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> for the month calendar control sending the notification.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The programmer can return any value because the operating system ignores the returned value. Typically 0 is
returned.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Select Event Handler -->
<section id="evtMonthCalendarVIEWCHANGE" xreflabel="VIEWCHANGE"><title>ViewChange Event Handler</title>
<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>VIEWCHANGE</tertiary></indexterm>
<programlisting>
<![CDATA[
::method onViewChange unguarded
use arg oldView, newView, id, hwnd
return 0
]]>
</programlisting>
<para>
The view change notification is sent when the current view changes. The notification is only sent on Windows Vista or
later. A syntax exception is raised if the VIEWCHANGE event is connected when the program is not running on Vista or
later.
</para>
<para>
The interpreter waits, or does not wait, for the reply as specified by the programmer in the
<xref linkend="mthConnectMonthCalendarEvent"/> method. The operating system ignores the value
of the reply.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives four arguments:
</para>
<variablelist>
<varlistentry><term>oldView</term>
<listitem>
<para>
The <emphasis role="italic">oldView</emphasis> argument is a keyword denoting what the previous view was. It will be
one of: month, year, decade, or century.
</para>
</listitem></varlistentry>
<varlistentry><term>newView</term>
<listitem>
<para>
The <emphasis role="italic">newView</emphasis> argument is a keyword denoting what the view was changed to. It also
will be one of: month, year, decade, or century.
</para>
</listitem></varlistentry>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the month calendar sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hwnd</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> for the month calendar control sending the notification
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ViewChange Event Handler -->
</section> <!-- End EventNotification::connectionMonthCalendarEvent() -->
<section id="mthConnectMove" xreflabel="connectMove"><title>connectMove</title>
<indexterm><primary>connectMove</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectMove</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectMove</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectMove(--+--------------+--)------------><
+--methodName--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectMove</emphasis> method connects a dialog move event notification with a method in
the Rexx dialog. The notification is sent after the position of the dialog has changed.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the method that will be invoked each time the dialog has moved. The name can not be the empty string.
When this argument is omitted the name defaults to <emphasis role="italic">onMove</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An (internal) error prevented the message from being connected to a method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
move events happen.
</para>
<para>
The underlying dialog receives this event notification as a WM_MOVE message.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method init
forward class (super) continue
self~connectMove(onMove)
::method onMove unguarded
use arg unUsed, posInfo
-- The dialog position has changed, print out where we are.
x = .DlgUtil~loWord(posInfo)
y = .DlgUtil~hiWord(posInfo)
say 'At coordinate (' x',' y' ) on the screen. (In pixels.)'
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectNotifyEvent" xreflabel="connectNotifyEvent"><title>connectNotifyEvent</title>
<indexterm><primary>connectNotifyEvent</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectNotifyEvent</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectNotifyEvent</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectNotifyEvent(--id--,--event--+---------------+--)-----><
+-,--methodName-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectNotifyEvent</emphasis> method connects one of the generic event notifications from
a dialog control to a method in the Rexx dialog object.
</para>
<para>
Most event notifications are specific to the particular type of control that sends them. These generic event
notifications are common to a number of dialog controls. In general, if one of the dialog control specific event
connection methods, such as <xref linkend="mthConnectListViewEvent"/> can make a connection
for the event, then <emphasis role="italic">connectNotifyEvent</emphasis> should not be used. In these cases, the
dialog control does not send one of the generic event notifications. It sends a notification specific to itself.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>id</term>
<listitem><para>The ID of the dialog control of which a notification is to be connected
to a method.
</para></listitem></varlistentry>
<varlistentry><term>event</term>
<listitem><para>The event to be connected with a method:
<variablelist>
<varlistentry><term>OUTOFMEMORY</term>
<listitem><para>The dialog control went out of memory.
</para></listitem></varlistentry>
<varlistentry><term>CLICK</term>
<listitem><para>The left mouse button was clicked on the dialog control.
</para></listitem></varlistentry>
<varlistentry><term>DBLCLK</term>
<listitem><para>The left mouse button was double-clicked on the dialog control.
</para></listitem></varlistentry>
<varlistentry><term>ENTER</term>
<listitem><para>The return key was pressed in the dialog item.
</para></listitem></varlistentry>
<varlistentry><term>RCLICK</term>
<listitem><para>The right mouse button was clicked on the dialog item.
</para></listitem></varlistentry>
<varlistentry><term>RDBLCLK</term>
<listitem><para>The right mouse button was double-clicked on the dialog control.
</para></listitem></varlistentry>
<varlistentry><term>GOTFOCUS</term>
<listitem><para>The dialog item got the input focus.
</para></listitem></varlistentry>
<varlistentry><term>LOSTFOCUS</term>
<listitem><para>The dialog item lost the input focus.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term>methodName</term>
<listitem><para>The message that is to be sent whenever the specified notification is
received. Provide a method with a matching name. If you omit this argument,
the event is preceded by <computeroutput>On</computeroutput>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return codes are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>No error detected.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>The resource ID could not be resolved or the event argument is
incorrect.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>The message was not connected correctly. The message was not connected
</para></listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if the
connected event happen.
</para>
<para>
In Windows itself, these events are sent to the parent dialog using the WM_NOTIFY message.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example connects the double-click of the left mouse button on dialog control DLGITEM1 with method
onDblClk:
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method init
self~init:super(...)
self~connectNotifyEvent(DLGITEM1, "DBLCLK")
::method onDblClk unguarded
use arg id, hwnd
say "Control" id " has been double-clicked! It's window handle is:" hwnd
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectPosChanged" xreflabel="connectPosChanged"><title>connectPosChanged</title>
<indexterm><primary>connectPosChanged</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectPosChanged</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectPosChanged</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectPosChanged(--+--------------+--)------><
+--methodName--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectPosChanged</emphasis> method connects the position changed event notification sent
to a dialog to a method in the Rexx dialog object. This notification is sent to the dialog when its size, position, or
place in the Z order has changed.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the method that will be invoked each time the dialog has moved. The name can not be the empty string.
When this argument is omitted the name defaults to <emphasis role="italic">onPosChanged</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An (internal) error prevented the message from being connected to a method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
position changed events happen.
</para>
<para>
In Windows itself, the dialog receives this event notification as a WM_WINDOWPOSCHANGED message.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
<programlisting>
<![CDATA[
::class 'MyDlgClass' subclass UserDialog
::method initDialog
...
self~connectPosChanged("onNewPos")
::method onNewPos unguarded
rect = self~windowRect
say "The new dialog window rectangle is:"
say " Left: " rect~left
say " Top: " rect~top
say " Right: " rect~right
say " Bottom:" rect~bottom
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectResize" xreflabel="connectResize"><title>connectResize</title>
<indexterm><primary>connectResize</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectResize</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectResize</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectResize(--+--------------+--+---------+--)------------><
+--methodName--+ +-,-synch-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectResize</emphasis> method connects a size event notification to the underlying
dialog with a method in the Rexx dialog. The notification is sent to the dialog after its size has changed.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the method that is invoked each time the size of the dialog has changed. The method name can not be the
empty string. When this argument is omitted the name defaults to <emphasis role="italic">onResize</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>synch [optional]</term>
<listitem>
<para>
A boolean value that specifies if the interpreter should invoke the event handler <xref
linkend="ovvEventsDirectReply"/>, or not. The default is <computeroutput>.true</computeroutput>, see the remarks. If
this behavior is not desired, the <emphasis role="italic">synch</emphasis> argument can be used to specify that the
interpreter should not wait for a reply.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An (internal) error prevented the message from being connected to a method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Typically when the user is resizing a window, there are many event notifications that come quickly. In older
ooDialog versions, where the notification was placed on a queue to be processed at a later date, this caused a
number of notifications to be placed on the queue before a single notification was processed. Programs that
connected the resize event perform poorly when many notifications pile up before they are processed.
</para>
<para>
The poor performance is mostly fixed by having the interpreter invoke the event handler directly, which causes each
notification to be processed one by one. When <emphasis role="italic">synch</emphasis> is true, all ooDialog
programs that connect the resize event are likely to perform much better. This is why the default is true.
</para>
<para>
Normally, when the interpreter waits for the event handler to return, a syntax condition is raised if a value is not
returned from the event handler. The <emphasis role="italic">synch</emphasis> option causes the interpreter to wait
until the event handler returns, but to not expect a returned value. This provides backwards compatibility for older
programs where the programmer <emphasis role="bold"><emphasis role="italic">mistakenly</emphasis></emphasis> did not
return a value from event handlers. Best practice is to <emphasis role="italic">always</emphasis> return a value
from an event handler. If the operating system ignores the return value, return 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
size events happen.
</para>
<para>
The underlying dialog receives the WM_SIZE message as the notification for this event.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example 1:</emphasis></term>
<listitem>
<programlisting>
<![CDATA[
dlg = .ResizingDialog~new
dlg~createCenter(100, 60, "Resize Me", "THICKFRAME")
dlg~execute("SHOWTOP")
::requires 'ooDialog.cls'
::class 'ResizingDialog' subclass UserDialog
::method init
forward class (super) continue
self~connectResize("onSize")
::method onSize unguarded
use arg sizeEvent, sizeInfo
-- sizeInfo contains information about the new width and height in pixels.
w = .DlgUtil~loWord(sizeinfo)
h = .DlgUtil~hiWord(sizeinfo)
say "New width=" w ", new height=" h
return 0
]]>
</programlisting>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example 2:</emphasis></term>
<listitem>
<para>
This example is pulled from the File Viewer <link linkend="exampleFileViewer">example</link> at the end of the
&quot;Appearance and Behavior Methods&quot; section. A complete working example is presented there that uses a number of
the dialog methods.
<programlisting>
<![CDATA[
::method defineDialog
expose wasMinimized
wasMinimized = .false
style = "VSCROLL HSCROLL MULTILINE READONLY"
self~createEdit(IDC_MULTILINE, 0, 0, 170, 180, style, "cEntry")
self~connectResize("onSize")
...
/* The first arg, sizeEvent, is a flag that the OS sends specifying the type of
* size event. We are only interested in these 3 flags:
*
* SIZE_RESTORED = 0
* SIZE_MINIMIZED = 1
* SIZE_MAXIMIZED = 2
*/
::method onSize unguarded
expose wasMinimized
use arg sizeEvent, sizeInfo
if sizeEvent = 1 then wasMinimized = .true
if sizeEvent = 0 | sizeEvent = 2 then do
if \ wasMinimized then self~resizeEditControl
wasMinimized = .false
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectResizing" xreflabel="connectResizing"><title>connectResizing</title>
<indexterm><primary>connectResizing</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectResizing</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectResizing</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectResizing(--+--------------+--)--------><
+--methodName--+
]]>
</programlisting>
<para>
Connects a <emphasis role="italic">sizing</emphasis> <xref linkend="ovvEvents"/> notification sent to the
underlying dialog with a method in the Rexx dialog. The notification is sent to the dialog <emphasis
role="italic">before</emphasis> its size has changed.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the method that is invoked each time the size of the dialog is about to be changed. The method name
can not be the empty string. When this argument is omitted the name defaults to <emphasis
role="italic">onResizing</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An (internal) error prevented the message from being connected to a method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
By processing the sizing event notification, the programmer can monitor the size and position of the drag rectangle
of the dialog being resized and, if desired, can change its size or position.
</para>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
<para>
The interpreter invokes the event handler directly and waits in the window <xref linkend="ovvWindowMessages"/> processing
loop for the return from the event handler. Connecting the sizing event requires that the programmer reply to the event
from the event handler in a timely manner.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Event Handler:</emphasis></term>
<listitem>
<para>
The event handler for the sizing event is invoked when the user is dragging the sizing border of the dialog to
change the size of the dialog. The programmer must reply <computeroutput>.true</computeroutput> or
<computeroutput>.false</computeroutput> to this notification.
</para>
<para>
The event handler receives 2 arguments. The first argument is a <computeroutput>Rect</computeroutput> object with
the coordinates of the new size for the dialog. The programmer can change the coordinates in the
<computeroutput>Rect</computeroutput> object and reply <computeroutput>.true</computeroutput>. This causes the
dialog to be resized to the changed coordinates in the <computeroutput>Rect</computeroutput> object rather than the
coordinates originally specified.
</para>
<para>
If the programmer replies <computeroutput>.false</computeroutput>, then any changes to the coordinates in the
<computeroutput>Rect</computeroutput> object are ignored and the dialog's size is changed to the size originally
specified.
</para>
<para>
A typical event handler would look like this:
</para>
<programlisting>
<![CDATA[
::method onResizing unguarded
use arg rect, direction
...
return boolean
]]>
</programlisting>
<para>
The arguments to the event handler are:
<variablelist>
<varlistentry><term>rect</term>
<listitem>
<para>
A <computeroutput>Rect</computeroutput> object that specifies the size the dialog is about to be changed to.
</para>
</listitem></varlistentry>
<varlistentry><term>direction</term>
<listitem>
<para>
A keyword that specifies which edge of the dialog window is being sized. The keyword will be exactly one of the
following:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BOTTOM</member> <member>BOTTOMLEFT</member> <member>BOTTOMLEFT</member>
<member>LEFT</member> <member>RIGHT</member> <member>TOP</member>
<member>TOPLEFT</member> <member>TOPRIGHT</member>
</simplelist>
</para>
<variablelist>
<varlistentry><term>BOTTOM</term>
<listitem>
<para>
The bottom edge is being dragged.
</para>
</listitem></varlistentry>
<varlistentry><term>BOTTOMLEFT</term>
<listitem>
<para>
The bottom-left corner is being dragged.
</para>
</listitem></varlistentry>
<varlistentry><term>BOTTOMRIGHT</term>
<listitem>
<para>
The bottom-right corner is being dragged.
</para>
</listitem></varlistentry>
<varlistentry><term>LEFT</term>
<listitem>
<para>
The left edge is being dragged.
</para>
</listitem></varlistentry>
<varlistentry><term>RIGHT</term>
<listitem>
<para>
The right edge is being dragged.
</para>
</listitem></varlistentry>
<varlistentry><term>TOP</term>
<listitem>
<para>
The top edge is being dragged.
</para>
</listitem></varlistentry>
<varlistentry><term>TOPLEFT</term>
<listitem>
<para>
The top-left corner is being dragged.
</para>
</listitem></varlistentry>
<varlistentry><term>TOPRIGHT</term>
<listitem>
<para>
The top-right corner is being dragged.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
sizing events happen.
</para>
<para>
The underlying dialog receives the WM_SIZING message as the notification for this event.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows, partially, how to prevent a resizable dialog from being sized smaller than 300 pixels high. A
complete implementation would also have to handle the TOPLEFT, TOPRIGHT, etc., directions. And, normally, an
implementation would also enforce a minimum width.
</para>
<para>
A complete implementation can be found in the <computeroutput>dlgAreaDemoThree.rex</computeroutput> example program.
<programlisting>
<![CDATA[
::method init
...
self~connectResizing("onSizing")
::method onSizing unguarded
use arg rect, direction
select
when direction == 'TOP' then do
if rect~bottom - rect~top < 300 then do
rect~top = rect~bottom - 300
return .true
end
end
when direction == 'BOTTOM' then do
if rect~bottom - rect~top < 300 then do
rect~bottom = rect~top + 300
return .true
end
end
...
otherwise
nop
end
return .false
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectScrollBarEvent" xreflabel="connectScrollBarEvent"><title>connectScrollBarEvent</title>
<indexterm><primary>connectScrollBarEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectScrollBarEvent(--id--,--event--+---------+-+-------------+--)-------><
+-,-mName-+ +-,-willReply-+
]]>
</programlisting>
<para>
Connects a method in the Rexx dialog to the Windows <xref linkend="ovvEvents"/> notification from a
scroll <xref linkend="clsScrollBar"/> control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the scroll bar whose event notification is to be connected. May be numeric or
<xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>event [required]</term>
<listitem>
<para>
A keyword specifying which scroll bar event should be connected. This methods connects either a vertical or a
horizontal scroll bar. The symbolic keyword names are orientated towards which type the scroll bar is. But the
values that the scroll bar sends are the same for similar events.
</para>
<para>
I.e., one event is to move 1 unit towards the upper left. For a vertical scroll bar this is one line up (LINEUP),
for a horizontal scroll bar this is one unit to the left (LINELEFT). But, the numeric value that a scroll bar sends
for the event is the same. Therefore, the LINEUP and LINELEFT keywords produce the identical effect. If the scroll
bar is a vertical scroll bar, using the LINELEFT keyword produces the same effect as using the LINEUP keyword. The
programmer can use whichever keyword makes the most sense.
</para>
<para>
The keyword must be one of the following, case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>LINEUP </member>
<member>LINELEFT </member>
<member>LINEDOWN </member>
<member>LINERIGHT</member>
<member>PAGEUP </member>
<member>PAGELEFT </member>
<member>PAGEDOWN </member>
<member>PAGERIGHT</member>
<member>POSITION </member>
<member>DRAG </member>
<member>TOP </member>
<member>LEFT </member>
<member>BOTTOM </member>
<member>RIGHT </member>
<member>ENDSCROLL</member>
</simplelist>
<variablelist>
<varlistentry><term>LINEUP LINELEFT</term>
<listitem>
<para>
The scroll bar was scrolled to the left or up by one unit.
</para>
</listitem></varlistentry>
<varlistentry><term>LINEDOWN LINERIGHT</term>
<listitem>
<para>
The scroll bar was scrolled to the right or down by one unit.
</para>
</listitem></varlistentry>
<varlistentry><term>PAGELEFT PAGEUP</term>
<listitem>
<para>
The scroll bar was scrolled to the left or up by one page size.
</para>
</listitem></varlistentry>
<varlistentry><term>PAGERIGHT PAGEDOWN</term>
<listitem>
<para>
The scroll bar was scrolled to the right or down by one page size.
</para>
</listitem></varlistentry>
<varlistentry><term>DRAG</term>
<listitem>
<para>
The user is dragging the scroll box. This message is sent repeatedly until the user releases the mouse button.
</para>
</listitem></varlistentry>
<varlistentry><term>TOP LEFT</term>
<listitem>
<para>
The scroll bar was scrolled completely to the top or to the left.
</para>
</listitem></varlistentry>
<varlistentry><term>BOTTOM RIGHT</term>
<listitem>
<para>
The scroll bar was scrolled completely to the bottom or to the right.
</para>
</listitem></varlistentry>
<varlistentry><term>ENDSCROLL</term>
<listitem>
<para>
Scrolling has been ended, that is, the appropriate key or mouse button has been released.
</para>
</listitem></varlistentry>
<varlistentry><term>POSITION</term>
<listitem>
<para>
The scroll box (thumb) of the scroll bar was dragged and the user has released the mouse button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>mName [optional]</term>
<listitem>
<para>
The name of the method that is to be invoked whenever the specified notification is received from the scroll bar. If
this argument is omitted, the method name is automatically generated by concatenating <emphasis
role="italic">on</emphasis> with the event keyword. For example, <emphasis role="italic">onLineUp</emphasis>.
</para> </listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter
<link linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler. The default is
<computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. If <emphasis
role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>, the interpreter waits until the
event handling method returns a value.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return codes are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error detected.
</para>
</listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem>
<para>
The resource ID could not be resolved or the event argument is incorrect.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The messages was not connected correctly.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks</emphasis></term>
<listitem>
<para>
This method requires that the <xref linkend="ovvUnderlying"/> scroll bar exists. Therefore, the method
is best invoked in the <xref linkend="mthInitDialog"/> method. At some later point in the life cycle
of the dialog is fine. If the method is invoked before the underlying dialog has been created a syntax condition is
raised.
</para>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
<para>
When the user interacts with a scroll bar, the operating system does not reposition the scroll box (thumb.) Rather,
the operating system relies on the application, (in essence the programmer,) to update the scroll bar position
during the scroll bar event notification. Therefore, if the scroll bar event is not connected, or the programmer
does not reposition the scroll box in the event handler, it will appear to the user that the scroll box can not be
moved.
</para>
<para>
The event handler receives two arguments as shown:
<programlisting>
<![CDATA[
::method onScrollBarEvent unguarded
use arg posInfo, hwnd
return 0
]]>
</programlisting>
The <emphasis role="italic">posInfo</emphasis> argument contains the scroll bar event code in the low word of the
argument. For the POSITION and the DRAG events, the high word contains the position of the scroll box. For the other
events, the high word is not used. When the notification comes from a <xref linkend="clsScrollBar"/> bar
control, the <emphasis role="italic">hwnd</emphasis> argument is the window handle of the scroll bar. When the
notification does not come from a scroll bar control, <emphasis role="italic">hwnd</emphasis> is 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example connects the POSITION event with a method in the Rexx dialog. Since the third argument is
omitted, the ooDialog framework automatically connects the event to the <emphasis
role="italic">onPosition</emphasis> method. The event handler extracts the new position from the notification
arguments and sets the position for the scroll bar. It also displays the new position and the event type. The
<computeroutput>ScrollBar</computeroutput> class provides the <link linkend="sctSBEventCode">THUMBPOSITION</link>
constant, whose value is the value of the POSITION event code.
<programlisting>
<![CDATA[
::class 'SimpleDialog subclass UserDialog
::method initDialog
self~connectScrollBarEvent(IDC_SB_FILE, "POSITION")
::method onPosition unguarded
use arg posInfo, hwnd
pos = .DlgUtil~hiWord(posData)
eventCode = .DlgUtil~loWord(posData)
-- Set the scroll bar to the new position and have it redraw itself.
self~newScrollBar(IDC_SB_FILE)~setPos(pos, .true)
say "Pos:" pos
say "Verify event code:
say " THUMBPOSITION:" .ScrollBar~THUMBPOSITION
say " This event: " eventCode
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectSizeMoveEnded" xreflabel="connectSizeMoveEnded"><title>connectSizeMoveEnded</title>
<indexterm><primary>connectSizeMoveEnded</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectSizeMoveEnded</secondary></indexterm>
<indexterm><primary>EventNotification</primary><secondary>connectSizeMoveEnded</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectSizeMoveEnded(--+--------------+--+--------------+--)---------------><
+--methodName--+ +-,-willReply--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectSizeMoveEnded</emphasis> method connects the Windows exit size / move
<xref linkend="ovvEvents"/> with an event handling method in the Rexx dialog object. This event is sent exactly
one time when the user has stopped moving or stopped resizing the dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the event handling method that to be invoked when the the size / move exit event occurs. The name must
not be the empty string. When this argument is omitted the name defaults to <emphasis
role="italic">onSizeMoveEnded</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The default behavior is for the interpreter to wait in the window <xref linkend="ovvWindowMessages"/> processing loop
for the return from the event handler, (the default for <emphasis role="italic">willReply</emphasis> is
<computeroutput>.true</computeroutput>). However, the operating system ignores the return from this event notification.
Specifying <computeroutput>.false</computeroutput> changes the default behavior so that the interpreter does not wait
for the return from the event handling method.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
An (internal) error prevented the message from being connected to a method.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Unlike most event handlers, the event handling method for the size / move ended event does not receive any
arguments. As noted above, the Windows operating system ignores the return value to the event notification.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
exit size / move events happen.
</para>
<para>
In Windows itself, the dialog receives this notification as a WM_EXITSIZEMOVE message.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from a resizable dialog implemented through the <xref linkend="clsDlgAreaU"/>
class. It turns off forcing the dialog controls to redraw in the <computeroutput>DlgAreaU</computeroutput> object,
and only has the controls redraw once when the sizing is finished.
<programlisting>
<![CDATA[
::method init
expose sizing
self~init:super
...
self~connectResize('onResize')
self~connectSizeMoveEnded('onExitSizeMove')
sizing = .false
...
::method defineDialog
expose u
u = .dlgAreaU~new(self)
u~updateOnResize = .false
::method onResize unguarded
expose u sizing
use arg ignored, sizeinfo
sizing = .true
u~resize(self, sizeinfo)
return 0
::method onExitSizeMove unguarded
expose sizing
if sizing then do
-- The user has stopped sizing the dialog, we'll now show all the dialog
-- controls we hid previously, and force the controls to redraw.
self~showAllControls
self~update
sizing = .false
end
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectStaticEvent" xreflabel="connectStaticEvent"><title>connectStaticEvent</title>
<indexterm><primary>connectStaticEvent</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectStaticEvent</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectStaticNotify(--id--,--event--,-+---------------+--)--><
+-,--methodName-+
]]>
</programlisting>
<para>
<emphasis role="italic">connectStaticEvent</emphasis> connects a notification message from a static control to a
method, defined by the programmer, in the Rexx dialog object. Normally, static controls do not send notification
messages. A static control will only send the messages when it has the NOTIFY style. The notification messages
inform the dialog that an event has occurred with regard to the static control.
</para>
<para>
For user defined dialogs use the NOTIFY style keyword in the <link linkend="sctCreateStaticControls">create...</link>
static control methods when the control is defined. For dialogs created from a compiled resource or a resource script file
use the SS_NOTIFY style when defining the control in a resource editor.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the static control. May be numeric or symbolic.
</para>
</listitem></varlistentry>
<varlistentry><term>event [required]</term>
<listitem>
<para>
A keyword specifying the event to be connected with a method:
<variablelist>
<varlistentry><term>CLICK</term>
<listitem>
<para>
The static control has been clicked with the mouse.
</para>
</listitem></varlistentry>
<varlistentry><term>DBLCLK</term>
<listitem>
<para>
The static control has been double-clicked with the mouse.
</para>
</listitem></varlistentry>
<varlistentry><term>DISABLE</term>
<listitem>
<para>
The static control has been disabled.
</para>
</listitem></varlistentry>
<varlistentry><term>ENABLE</term>
<listitem>
<para>
The static control has been enabled.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The method that is to be invoked whenever the specified notification is received from the static control. The
programmer defines this method. The method name can not be the empty string. If this argument is omitted, a
method name is automatically generated that consists of the event keyword preceded by
<computeroutput>on</computeroutput>. For instance, <computeroutput>onClick</computeroutput>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return codes are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error detected.
</para>
</listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem>
<para>
The resource ID could not be resolved or the event argument is incorrect.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
The message was not connected correctly. The message was not connected
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<orderedlist>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
</listitem>
<listitem>
<para>
The defined event-handling method will receive two arguments. The first arg contains information about the
specific control and its event. The second arg is the window handle of the static control.
</para>
<para>
The low word of the first arg is the control ID and the high word is the event ID.
</para>
</listitem>
</orderedlist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example comes from an application that displays employee statistics. A single click on the employee
number field advances the display to the next employee. A double click on either the employee name or employee job
duties allows those fields to be edited.
</para>
<programlisting>
<![CDATA[
::method initDialog
self~connectStaticEvent(IDC_ST_EMPNO, "CLICK", empLookup)
self~connectStaticEvent(IDC_ST_EMPJOB, "DBLCLK", editStats)
self~connectStaticEvent(IDC_ST_EMPNAME, "DBLCLK", editStats)
first = self~initDatabase
self~setStats(first)
]]>
</programlisting>
<para>
In this example, (a continuation of the above example,) the control ID determines if the user has double clicked on
the employee job duties field, or the employee name field. The event ID is not used, or needed. Its purpose in the
code snippet is simply an example. The same thing applies to the window handle.
</para>
<programlisting>
<![CDATA[
::method editStats unguarded
use arg ctrlInfo, ctrlHwnd
ctrlID = .DlgUtil~loWord(ctrlInfo)
eventID = .DlgUtil~hiWord(ctrlInfo)
rec = self~getCurrentRecord
if self~userUpdate(ctrlID, rec) then self~setStats(rec)
return 0
]]>
</programlisting>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectTabEvent" xreflabel="connectTabEvent"><title>connectTabEvent</title>
<indexterm><primary>connectTabEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectTabEvent(--id--,--event--+---------------+--+--------------+--)-----><
+-,--methodName-+ +-,--willReply-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectTabEvent</emphasis> method connects a specific
<xref linkend="ovvEvents"/> notification from a tab control with an event handling method in the Rexx
dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the tab control whose event notification is to be connected to a method in the Rexx dialog.
May be numeric or <xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>event [required]</term>
<listitem>
<para>
A single keyword indicating which event is to be connected. The event keywords are:
<variablelist>
<varlistentry><term>KEYDOWN</term>
<listitem>
<para>
The notification is sent when a key has been pressed while the tab control has the focus.
</para>
</listitem></varlistentry>
<varlistentry><term>SELCHANGE</term>
<listitem>
<para>
A new tab has been selected in the tab control. This method is called after the selection has changed.
</para>
</listitem></varlistentry>
<varlistentry><term>SELCHANGING</term>
<listitem>
<para>
A new tab has been selected in the tab control. This method is called before the selection is changed. The
programmer can prevent the selected tab being changed at this point if the <emphasis
role="italic">willReply</emphasis> argument is set to <computeroutput>.true</computeroutput>.
</para>
<para>
The selection is prevented from changing by returning <computeroutput>.false</computeroutput>
from the event handler for this event. Returning <computeroutput>.true</computeroutput> allows the change.
Again, <emphasis role="bold">note</emphasis>, that preventing the change is only possible by specifying
<computeroutput>.true</computeroutput> for the <emphasis role="italic">willReply</emphasis> argument. If
<emphasis role="italic">willReply</emphasis> is <computeroutput>.false</computeroutput>, the default, the
reply from the event handling method is ignored.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The method name that is invoked whenever the specified notification is received from the tab control. Provide
a method with a matching name. If you omit this argument, the method name is automatically generated by the
ooDialog framework. The generated name will be the event keyword preceded by
<computeroutput>on</computeroutput>, for example <emphasis role="italic">onSelChanging</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter
<link linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler. The default is
<computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. If <emphasis
role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>, the interpreter waits until the
event handling method returns a value.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return codes are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>No error detected.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>The resource ID could not be resolved or the event argument is
incorrect.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>The messages was not connected correctly.
</para></listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
<para>
The event-handling method for the KEYDOWN event receives two arguments: info about the event, the control ID of the
tab control is in the low order word of this argument. The second argument is the virtual key code that was pressed.
Use the the <xref linkend="clsVK"/> class to determine which key was pressed. Example:
<programlisting>
<![CDATA[
::method onKeyDown unguarded
use arg info, vkey
id = .DlgUtil~loWord(info)
if vKey == .VK~NEXT | vKey == .VK~PREVIOUS then do
-- do something ...
end
else if vKey == .VK~HOME | vKey == .VK~END then do
-- do something else ...
end
-- Other keys are ignored
return 0
]]>
</programlisting>
</para>
<para>
The event-handling method for the SELCHANGE event receives two arguments: info about the event, the control ID of
the tab control is in the low order word of this argument. The second argument is the window handle of the tab
control. Example:
<programlisting>
<![CDATA[
::method onSelChange unguarded
use arg info, hwndFrom
id = .DlgUtil~loWord(info)
...
return 0
]]>
</programlisting>
</para>
<para>
The event-handling method for the SELCHANGING event also receives two arguments. The arguments differ slightly
depending on the value of <emphasis role="italic">willReply</emphasis>.
</para>
<para>
If <emphasis role="italic">willReply</emphasis> is <computeroutput>.false</computeroutput>, the first argument is
info about the event, the control ID of the tab control is in the low order word of this argument. The second
argument is the window handle of the tab control. If <emphasis role="italic">willReply</emphasis> is
<computeroutput>.true</computeroutput>, the first argument is simply the control ID of the tab. The second argument
is the window handle of the tab control. Examples
<programlisting>
<![CDATA[
::method initDialog
self~connectTabEvent(IDC_TAB, "SELCHANGING")
::method onSelChanging unguarded
use arg info, hwndFrom
id = .DlgUtil~loWord(info)
...
return 0
/* This example allows the programmer to cancel the pending tab change. */
::method initDialog
self~connectTabEvent(IDC_TAB, "SELCHANGING", .true)
::method onSelChanging unguarded
use arg idFrom, hwndFrom
currentTab = self~newTab(IDC_TAB)~selectedIndex
if \ self~validateTab(currentTab) then do
-- The programmer should put up a message explaining
-- why the page of the tab is not changing ...
return .false
end
return .true
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example invokes the method <emphasis role="italic">onSelChange</emphasis> whenever another tab is
selected in the tab control:
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method init
self~connectTabEvent(IDC_TAB, "SELCHANGE")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthConnectToolTipEvent" xreflabel="connectToolTipEvent"><title>connectToolTipEvent</title>
<indexterm><primary>connectToolTipEvent</primary></indexterm>
<indexterm><primary>dialog object</primary><secondary>connectToolTipEvent</secondary></indexterm>
<indexterm><primary>EventNotification class</primary><secondary>connectToolTipEvent</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectToolTipEvent(--id--,--event--+-----------+--+-------------+--)------><
+-,-mthName-+ +-,-willReply-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectUpDownEvent</emphasis> method connects an <xref linkend="ovvEvents"/>
notification message from a <xref linkend="clsUpDown"/> control to a method in the Rexx dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the up-down control whose notification message is to be connected to a Rexx dialog's method.
May be numeric or <xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>event [required]</term>
<listitem>
<para>
Exactly one of the following keywords. The keyword specifies the event to be connected and case is not
significant. Unlike most controls, the up-down control only has one event notification.
</para>
<variablelist>
<varlistentry><term>DELTAPOS</term>
<listitem>
<para>
Sent when the position of the control is about to change. This happens when the user requests a change in the
value by pressing the control's up or down arrow. The event handler must
<link linkend="sctCodingEventHandlers">return</link> a reply for this event. The interpreter waits for that reply.
</para>
<para>
The DELTAPOS notification is sent before the scroll message which actually changes the control's position.
This allows the programmer to examine, allow, modify, or disallow the change in position.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the method that is to be invoked whenever the specified notification is received from the up-down
control. The programmer defines this method. If this argument is omitted, a method name is automatically
generated that consists of the event keyword preceded by <computeroutput>on</computeroutput>. For instance,
<computeroutput>onDeltaPos</computeroutput>. The method name can not be the empty string.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns <computeroutput>.true</computeroutput> if the event was connected correctly, otherwise
<computeroutput>.false</computeroutput>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected, including the use of an invalid symbolic ID or an
unrecognized event keyword.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if the
connected event happens.
</para>
<para>
The underlying dialog receives the UDN_* messages as the notifications for the up-down events.
</para>
</listitem></varlistentry>
</variablelist>
<section id="evtToolTipSHOW" xreflabel="SHOW"><title>Show Event Handler</title>
<indexterm><primary>ToolTip class</primary><secondary>events</secondary><tertiary>SHOW</tertiary></indexterm>
<programlisting>
<![CDATA[
::method onShow unguarded
use arg what
return what
]]>
</programlisting>
<para>
The event handler for the up-down DELTAPOS event is invoked when when the position of the control is about to change.
The arguments the event handler receives allow the programmer to examine the proposed change in position, to modify
the change, or to cancel the change all together.
</para>
<para>
The programmer must return a value from the event handler and the interpreter waits for this return. The
<xref linkend="mthDeltaPosReply"/> class method of the <xref linkend="clsUpDown"/> class is
used to properly construct the return value from the event handler.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives four arguments:
</para>
<variablelist>
<varlistentry><term>pos</term>
<listitem>
<para>
A signed whole number that contains the up-down control's current position.
</para>
</listitem></varlistentry>
<varlistentry><term>delta</term>
<listitem>
<para>
A signed whole number that contains the proposed change in the up-down control's position. This is positive if the
user has clicked the up button or used the up arrow key. If the user has clicked the down button or used the down
arrow key, this number will be negative.
</para>
</listitem></varlistentry>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the up-down control whose position is about to change.
</para>
</listitem></varlistentry>
<varlistentry><term>hwnd</term>
<listitem>
<para>
The window <xref linkend="defHandle"/> of the up-down control whose position is about to change.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
A delta position buffer must be returned by the event handler. This buffer can only be constructed properly by
using the <xref linkend="clsUpDown"/> class's <xref linkend="mthDeltaPosReply"/>
method. The arguments to <emphasis role="italic">deltaPosReply</emphasis> allow the programmer to return a value
that makes no change to the new position, cancels altogether the change in position, or modifies the resulting new
position.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example examines the change in position in the up-down control and modifies it so that the position in
the up-down control is always an even number. Note that the <emphasis role="italic">deltaPosReply</emphasis> method
ignores the second and third arguments when the first argument is <computeroutput>.false</computeroutput>. So, in
the code below, if <emphasis role="italic">change</emphasis> remains <computeroutput>.false</computeroutput>, then
the values of <emphasis role="italic">cancel</emphasis> and <emphasis role="italic">delta</emphasis> do not matter.
<programlisting>
<![CDATA[
::method initDialog
...
self~connectUpDownEvent(IDC_UPD, "DELTAPOS", onPosChange)
...
::method onPosChange unguarded
use arg pos, delta, id, hwnd
change = .false
cancel = .false
if ((pos + delta) // 2) <> 0 then do
change = .true
if delta > 0 then delta += 1
else delta -= 1
end
return .UpDown~deltaPosReply(change, cancel, delta)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Sjpw Event Handler -->
</section> <!-- End EventNotification::connectToolTipEvent() -->
<section id="mthConnectTrackBarEvent" xreflabel="connectTrackBarEvent"><title>connectTrackBarEvent</title>
<indexterm><primary>connectTrackBarEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>--connectTrackBarEvent(--id--,--event--+---------------+--)---><
+-,--methodName-+
]]>
</programlisting>
<para>The connectTrackBarEvent method connects a particular
WM_NOTIFY message for a trackbar control, which is also called a track bar,
with a method. The WM_NOTIFY message informs the dialog that an event has
occurred with regard to the trackbar control.</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:
<variablelist>
<varlistentry><term>id</term>
<listitem><para>The ID of the trackbar control of which a notification is to be connected
to a method.
</para></listitem></varlistentry>
<varlistentry><term>event</term>
<listitem><para>The event to be connected with a method:
<variablelist>
<varlistentry><term>UP</term>
<listitem><para>The Up or right key has been pressed.
</para></listitem></varlistentry>
<varlistentry><term>DOWN</term>
<listitem><para>The Down or left key has been pressed.
</para></listitem></varlistentry>
<varlistentry><term>TOP</term>
<listitem><para>The Home key has been pressed.
</para></listitem></varlistentry>
<varlistentry><term>BOTTOM</term>
<listitem><para>The End key has been pressed.
</para></listitem></varlistentry>
<varlistentry><term>PAGEUP</term>
<listitem><para>The PgUp key has been pressed.
</para></listitem></varlistentry>
<varlistentry><term>PAGEDOWN</term>
<listitem><para>The PgDn key has been pressed.
</para></listitem></varlistentry>
<varlistentry><term>DRAG</term>
<listitem><para>The trackbar has been moved.
</para></listitem></varlistentry>
<varlistentry><term>POSITION</term>
<listitem><para>The left mouse button has been released, following a DRAG notification.
</para></listitem></varlistentry>
<varlistentry><term>ENDTRACK</term>
<listitem><para>The trackbar movement is completed, that is, the appropriate key or mouse
button has been released.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term>msgToRaise</term>
<listitem><para>The message that is to be sent whenever the specified notification is
received from the trackbar control. Provide a method with a matching name. If
you omit this argument, the event is preceded by <computeroutput>On</computeroutput>.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem><para>The return codes are:
<variablelist>
<varlistentry><term>0</term>
<listitem><para>No error detected.
</para></listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem><para>The resource ID could not be resolved or the event argument is
incorrect.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>The messages was not connected correctly.
</para></listitem></varlistentry>
</variablelist>
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem><para>The following example connects the POSITION event (release mouse button
after dragging) with method PosSet, which extracts the new trackbar position
from the notification arguments and displays it together with the event type
for POSITION, which should be 4:
<programlisting>
<![CDATA[
::class MyDlgClass subclass UserDialog
::method initDialog
self~InitDialog:super(...)
self~connectTrackBarEvent("MYSLIDER", "POSITION", posSet)
::method posSet unguarded
use arg ev_pos, hnd
pos = .DlgUtil~hiWord(ev_pos)
say "Verify event code (should be 4):" .DlgUtil~loWord(ev_pos)
return 0
]]>
</programlisting>
</para></listitem></varlistentry>
</variablelist>
<note><title>Notes</title><para>
<orderedlist>
<listitem><para>The method can only be called after the trackbar was created by Windows.
A good location for this connection is the initDialog method.</para></listitem>
<listitem><para>The event-handling methods receive two arguments: an event-position pair
and the handle to the trackbar control. For some events, you can retrieve the
trackbar position by extracting the high-oder word. Example:
<programlisting>
<![CDATA[
::method handler unguarded
use arg ev_pos, handle
position = .DlgUtil~hiWord(ev_pos)
return 0
]]>
</programlisting></para></listitem>
</orderedlist>
</para></note>
</section>
<section id="mthConnectTreeViewEvent" xreflabel="connectTreeViewEvent"><title>connectTreeViewEvent</title>
<indexterm><primary>connectTreeViewEvent</primary></indexterm>
<programlisting>
<![CDATA[
>>-connectTreeViewEvent(--id--,--event--+-------------+--+-------------+--)----><
+-,--mthName--+ +-,-willReply-+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectTreeViewEvent</emphasis> method connects a method in a Rexx dialog to a particular
tree view <xref linkend="ovvEvents"/>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The arguments are:</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource ID of the tree view control. This can be the numeric or symbolic ID.
</para>
</listitem></varlistentry>
<varlistentry><term>event</term>
<listitem>
<para>
A keyword indicating which event is to be connected. Case is not significant. The keyword must be one of the following:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BEGINDRAG</member>
<member>BEGINEDIT</member>
<member>BEGINRDRAG</member>
<member>DEFAULTEDIT</member>
<member>DELETE</member>
<member>ENDEDIT</member>
<member>EXPANDED</member>
<member>EXPANDING</member>
<member>GETINFOTIP</member>
<member>KEYDOWN</member>
<member>KEYDOWNEX</member>
<member>SELECTCHANGED</member>
<member>SELECTCHANGING</member>
</simplelist>
</para>
<variablelist>
<varlistentry id="kywTreeViewBEGINDRAG" xreflabel="BEGINDRAG"><term>BEGINDRAG</term>
<listitem>
<para>
A drag-and-drop operation using the left mouse button was initiated. The documentation for the
<xref linkend="mthDefTreeDragHandler"/>() method contains further information on how to implement a drag-and-drop
handler. Not that if the tree-view control is give the <xref linkend="styTreeViewNODRAG"/> style, the BEGINDRAG
notification is not sent.
</para>
</listitem></varlistentry>
<varlistentry id="kywTreeViewBEGINEDIT" xreflabel="BEGINEDIT"><term>BEGINEDIT</term>
<listitem>
<para>
Editing a label has been started. Do not connect this event if you are using the DEFAULTEDIT keyword. The results are
undefined. The tree-view must have the <xref linkend="styTreeViewEDIT"/> style for this notification to be sent.
</para>
<para>
The event notification for this event has been enhanced since the original ooDialog implementation. To use the
enhanced event notification, the <emphasis role="italic">willReply</emphasis> argument must be used. The value of the
argument, true or false, does not matter. If <emphasis role="italic">willReply</emphasis> is omitted, the old style
notification is used. The documentation for the <link linkend="evtTreeViewBEGINEDIT">BEGINEDIT</link> event handler
explains the difference between the two types of notifications.
</para>
</listitem></varlistentry>
<varlistentry><term>BEGINRDRAG</term>
<listitem>
<para>
A drag-and-drop operation involving the right mouse button was initiated. The documentation for the
<xref linkend="mthDefTreeDragHandler"/>() method contains further information on how to
implement a drag-and-drop handler. handler.
</para>
</listitem></varlistentry>
<varlistentry id="kywTreeViewDEFAULTEDIT" xreflabel="DEFAULTEDIT"><term>DEFAULTEDIT</term>
<listitem>
<para>
This keyword is used to activate the internal handling of the tree-view label editing operation. With this keyword,
the ooDialog framework internally handles the BEGINEDIT and ENDEDIT notifications. The tree-view must have the
<xref linkend="styTreeViewEDIT"/> style for the BEGINEDIT / ENDEDIT notification to be sent. While using the
DEFAULTEDIT connection may seem easier than using the BEGINEDIT / ENDEDIT connections, it does not provide the same
flexibility as using the BEGINEDIT / ENDEDIT connections.
</para>
<para>
When you specify this event connection, omit the <emphasis role="italic">methodName</emphasis> argument, the arugment
is ignored. Do not connect either the BEGINEDIT or ENDEDIT events when also using the DEFAULTEDIT connection. The
result is undefined.
</para>
</listitem></varlistentry>
<varlistentry><term>DELETE</term>
<listitem>
<para>
An item has been deleted.
</para>
</listitem></varlistentry>
<varlistentry id="kywTreeViewENDEDIT" xreflabel="ENDEDIT"><term>ENDEDIT</term>
<listitem>
<para>
Label editing has ended. Do not connect this event if you are using the DEFAULTEDIT keyword. The results are
undefined. The tree-view must have the <xref linkend="styTreeViewEDIT"/> style for this notification to be sent.
</para>
<para>
The event notification for this event has been enhanced since the original ooDialog implementation. To use the
enhanced event notification, the <emphasis role="italic">willReply</emphasis> argument must be used. The value of the
argument, true or false, does not matter. If <emphasis role="italic">willReply</emphasis> is omitted, the old style
notification is used. The documentation for the <link linkend="evtTreeViewENDEDIT">ENDEDIT</link> event handler
explains the difference between the two types of notifications.
</para>
</listitem></varlistentry>
<varlistentry><term>EXPANDED</term>
<listitem>
<para>
An item has expanded or collapsed. This notification is sent after the item expanded or collapsed.
</para>
</listitem></varlistentry>
<varlistentry><term>EXPANDING</term>
<listitem>
<para>
An item is about to expand or collapse. This notification is sent before the item has expanded or collapsed.
</para>
</listitem></varlistentry>
<varlistentry id="kywTreeViewGETINFOTIP" xreflabel="GETINFOTIP"><term>GETINFOTIP</term>
<listitem>
<para>
The tree-view control is requesting text to display an info tip. The notification is only sent when the tree-view
control has the <link linkend="styTreeViewINFOTIP">INFOTIP</link> style.
</para>
</listitem></varlistentry>
<varlistentry><term>KEYDOWN</term>
<listitem>
<para>
A key was pressed inside the tree view. This notification is not sent while a label is being edited.
</para>
</listitem></varlistentry>
<varlistentry><term>KEYDOWNEX</term>
<listitem>
<para>
A key was pressed inside the tree view. This notification is not sent while a label is being edited.
</para>
<para>
This event is exactly the same as the KEYDOWN event. Except, when this keyword is used, the ooDialog framework sends
a different set of arguments to the event handler. The additional arguments provide more information to the
programmer than the arguments sent when the KEYDOWN keyword is used. The two keywords are needed to provide
backwards compatibility.
</para>
</listitem></varlistentry>
<varlistentry><term>SELCHANGED</term>
<listitem>
<para>
Another item was selected. This notification is sent after the selection was changed.
</para>
</listitem></varlistentry>
<varlistentry><term>SELCHANGING</term>
<listitem>
<para>
Another item is about to be selected. This notification is sent before the selection has changed.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term>mthName</term>
<listitem>
<para>
The name of the event handling method. This method is invoked each time the specified event occurs for the tree
view control. If you omit this argument, the method name is generated for you. This name will be the event
keyword, preceded by <computeroutput>on</computeroutput>. For example: <emphasis
role="italic">onExpanded</emphasis>. The method name can not be the empty string.
</para>
</listitem></varlistentry>
<varlistentry><term>willReply [optional]</term>
<listitem>
<para>
The value of the <emphasis role="italic">willReply</emphasis> argument must be true or false. The arugment controls
whether the interpreter <link linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler. The
default is <computeroutput>.false</computeroutput>, the interpreter will not wait for the reply. If <emphasis
role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>, the interpreter waits until the
event handling method returns a value.
</para>
<para>
<emphasis role="bold">Note:</emphasis> Currently the <emphasis role="italic">willReply</emphasis> argument is ignored
for all events except the BEGINEDIT, ENDEDIT, EXPANDING, EXPANDED, and KEYDOWNEX events. For the GETINFOTIP event, the
interpreter always waits for the reply. For all other events, the interpreter never waits for the reply from the event
handler. Future enhancements to the <computeroutput>TreeView</computeroutput> class may allow the <emphasis
role="italic">willReply</emphasis> to have effect for all tree-view event notifications.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
No error detected.
</para>
</listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem>
<para>
The resource ID was symbolic and it could not be resolved, or the event keyword is not correct.
</para>
</listitem></varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>
Some other error and the message was not connected correctly. This may indicate the message table is full, or the
interpreter is out of usable memory.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link
linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Syntax errors are raised when incorrect usage is detected.
</para>
<para>
If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if any
command events happen.
</para>
<para>
In Windows itself, tree view event notifications are sent to the parent dialog using the WM_NOTIFY message.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example connects the selection-changed event for the tree-view with the symbolic ID of IDC_TV_FILES with
the method newTreeSelection in the Rexx dialog. The event handling method displays the text of the new selection:
<programlisting>
<![CDATA[
::class 'FileDlg' subclass UserDialog
::method init
self~connectTreeViewEvent(IDC_TV_FILES, "SELCHANGED", "newTreeSelection")
::method newTreeSelection unguarded
tc = self~newTreeView(IDC_TV_FILES)
text = tc~itemText(tc~selected)
say "The label of the new selection is:" text
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
<section id="evtTreeViewBEGINDRAG" xreflabel="BEGINDRAG"><title>BeginDrag Event Handler</title>
<indexterm><primary>TreeView Event</primary><secondary>BEGINDRAG</secondary></indexterm>
<para>
The event-handling method connected to BEGINDRAG receives three arguments: the control ID of the tree view control, the
tree item to be dragged, and the point where the mouse cursor was pressed (x and y positions, separated by a blank).
Example:
<programlisting>
<![CDATA[
::method onBeginDrag unguarded
use arg id, item, where
say "Item with handle" item "is in drag-and-drop mode"
parse var where x y
say "The drag operation started at point ("x","y")"
return 0
]]>
</programlisting>
</para>
</section>
<section id="evtTreeViewBEGINRDRAG" xreflabel="BEGINRDRAG"><title>BeginRDrag Event Handler</title>
<indexterm><primary>TreeView Event</primary><secondary>BEGINRDRAG</secondary></indexterm>
<para>
The event-handling method connected to BEGINRDRAG receives three arguments: the control ID of the tree view control, the
tree item to be dragged, and the point where the mouse cursor was pressed (x and y positions, separated by a blank).
Example:
<programlisting>
<![CDATA[
::method onBeginDrag unguarded
use arg id, item, where
say "Item with handle" item "is in drag-and-drop mode"
parse var where x y
say "The drag operation started at point ("x","y")"
return 0
]]>
</programlisting>
</para>
</section>
<section id="evtTreeViewBEGINEDIT" xreflabel="BEGINEDIT"><title>BeginEdit Event Handler</title>
<indexterm><primary>TreeView Event</primary><secondary>BEGINEDIT</secondary></indexterm>
<para>
The event handler for the BEGINEDIT event is invoked when the user begins a label editing operation on an item of the
tree-view. When label editing begins, an edit control is created by the operating systm, but not positioned or displayed.
Before it is displayed, the tree-view control sends a BEGINEDIT notification message. A label editing operation is only
available when the tree-view has the <xref linkend="styTreeViewEDIT"/> style.
</para>
<para>
In general, the programmer would connect both the BEGINEDIT and <xref linkend="kywTreeViewENDEDIT"/> notifications. Both of
these event notifications have been enhanced since the original ooDialog implementation. If the <emphasis
role="italic">willReply</emphasis> argument to the <xref linkend="mthConnectTreeViewEvent"/> method is omitted the old
implementation is used. If the argument is not omitted, the new implementation is used. How the two event handlers work is
described separately.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">New event handler description:</emphasis></term>
<listitem>
<para>
Whether the programmer must return a value and if the interpreter waits, or does not wait, for this return is
determined by the value of the <emphasis role="italic">willReply</emphasis> argument. If <emphasis
role="italic">willReply</emphasis> is true, the programmer must return true or false from the event handler and the
interpreter waits for that reply. If <emphasis role="italic">willReply</emphasis> is false the interpreter does not
wait for a reply.
</para>
<programlisting>
<![CDATA[
::method onBeginEdit unguarded
use arg id, hItem, editCtrl, treeViewCtrl, userData
return zz
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource id of the list-view sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hItem</term>
<listitem>
<para>
The tree-view item handle whose label is about to be edited.
</para>
</listitem></varlistentry>
<varlistentry><term>editCtrl</term>
<listitem>
<para>
The Rexx edit control object used for the editing operation. The programmer can customize the editing operation by
using the methods of the <link linkend="clsEdit">Edit</link> class.
</para>
<para>
<emphasis role="bold">Note</emphasis> that this object is only valid during the editing operation. When the user
ends the editing, the operating system destroys the underlying edit control and the Rexx object is no longer valid.
Each time the user starts a new editing operation, the operating system creates a new edit control.
</para>
</listitem></varlistentry>
<varlistentry><term>treeViewCtrl</term>
<listitem>
<para>
The Rexx tree-view object whose underlying tree-view control has sent the notification. This is a convenience for
the programmer. It is the same Rexx object the programmer would recieve through the <xref
linkend="mthNewTreeView"/> method. Unlike the <emphasis role="italic">editCtrl</emphasis> object, this object is
valid as long as the dialog is executing.
</para>
</listitem></varlistentry>
<varlistentry><term>userData</term>
<listitem>
<para>
The user <link linkend="mthSetItemDataClsTreeView">data</link> object assigned to the tree-view item whose label is
about to be edited. If no user data has been assigned, this argument will be the
<computeroutput>.nil</computeroutput> object.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
When the programmer used true for the <emphasis role="italic">willReply</emphasis> argument, the event handler must
return true or false. To allow the editing operation to begin, return true. To cancel the editing operation, return
false. Returning a value from the event handler gives the programmer the option determining if the label for the
specific tree-view item should or should not be edited.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
The following example shows a possible event handler for the BEGINEDIT event. It uses the <emphasis
role="italic">hItem</emphasis> argument to determine which item is about the have its label edited, and checks that
editing is allowed for that item. If it is, it returns true to allow the operation. If it is not, it returns false to
cancel the operation and puts up a message box to inform the user. Note that the <emphasis
role="italic">userData</emphasis> argument is assigned to the <emphasis role="italic">rec</emphasis> variable in this
example, just to make it clear that the argument sent to the event handler is the user data object. In this
particular program the user data object is a record object:
<programlisting>
<![CDATA[
::method onBeginEdit unguarded
use arg id, hItem, editCtrl, treeViewCtrl, userData
rec = userData
if rec~isEditable then return .true
reply .false
msg = "The record for" rec~FirstName rec~LastName 'can not be changed.'
title = "Label Edit Error"
j = MessageDialog(msg, self~hwnd, title, , "WARNING")
return
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Old event handler description:</emphasis></term>
<listitem>
<para>
The old style event notification is used when the programmer omits the <emphasis role="italic">willReply</emphasis>
argument in the invocation of the <xref linkend="mthConnectListViewEvent"/> method. The return from the event handler is
completely ignored, the interpreter does not wait for this return.
</para>
<programlisting>
<![CDATA[
::method onBeginEdit unguarded
use arg id, hItem
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 2 arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource id of the list-view sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>hItem</term>
<listitem>
<para>
The handle to the tree-view item whose label is about to be edited.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
Returning, or not returning, a value has no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks</emphasis></term>
<listitem>
<para>
Connecting this event and not using the <emphasis role="italic">willReply</emphasis> argument does not make much sense.
The event handler really serves no purpose.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</section> <!-- End BeginEdit Event Handler -->
<section id="evtTreeViewENDEDIT" xreflabel="ENDEDIT"><title>EndEdit Event Handler</title>
<indexterm><primary>TreeView Event</primary><secondary>ENDEDIT</secondary></indexterm>
<para>
The event handler for the ENDEDIT event is invoked when the user finishes a label editing operation on an item of the
tree-view. A label editing operation is only available when the tree-view has the <xref linkend="styTreeViewEDIT"/> style.
</para>
<para>
In general, the programmer would connect both the <xref linkend="evtTreeViewBEGINEDIT"/> and ENDEDIT notifications. Both of
these event notifications have been enhanced since the original ooDialog implementation. If the <emphasis
role="italic">willReply</emphasis> argument to the <xref linkend="mthConnectTreeViewEvent"/> method is omitted the old
implementation is used. If the argument is not omitted, the new implementation is used. How the two event handlers work is
described separately.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">New event handler description:</emphasis></term>
<listitem>
<para>
Whether the programmer must return a value and if the interpreter waits, or does not wait, for this return is
determined by the value of the <emphasis role="italic">willReply</emphasis> argument. If <emphasis
role="italic">willReply</emphasis> is true, the programmer must return true or false from the event handler and the
interpreter waits for that reply. If <emphasis role="italic">willReply</emphasis> is false the interpreter does not
wait for a reply.
</para>
<programlisting>
<![CDATA[
::method onEndEdit unguarded
use arg id, hItem, text, treeViewCtrl, userData
return trueOrFalse
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 4 arguments:
</para>
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The resource id of the list-view sending the notification.
</para>
</listitem></varlistentry>
<varlistentry><term>itemID</term>
<listitem>
<para>
The item index whose label being edited.
</para>
</listitem></varlistentry>
<varlistentry><term>text</term>
<listitem>
<para>
If the user canceled the edit operation then the <emphasis role="italic">text</emphasis> argument will be the .nil
object. If the edit operation was not canceled then this argument will be the text the user entered.
</para>
</listitem></varlistentry>
<varlistentry><term>listViewCtrl</term>
<listitem>
<para>
The Rexx list-view object whose underlying list-view control has sent the notification. This is a convenience for
the programmer. It is the same Rexx object the programmer would recieve through the <xref
linkend="mthNewListView"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term>userData</term>
<listitem>
<para>
The user <link linkend="mthSetItemDataClsTreeView">data</link> object assigned to the tree-view item whose label
was edited. If no user data has been assigned, this argument will be the <computeroutput>.nil</computeroutput>
object.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>