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

Close

[r8573]: docs / trunk / oodialog / en-US / menus.xml Maximize Restore History

Download this file

menus.xml    9593 lines (9090 with data), 378.2 kB

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