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

Download this file

4073 lines (3815 with data), 157.5 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
<?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) 2012-2013 Rexx Language Association. 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="clsToolTip" xreflabel="ToolTip"><title>ToolTip Controls</title>
<indexterm><primary>ToolTip class</primary></indexterm>
<para>
Tooltip controls are pop-up windows that display text. Typically the text describes a <emphasis
role="italic">tool</emphasis>. A <emphasis role="italic">tool</emphasis> is either a window or an application defined area
within a window. Conceptually, a ToolTip is a dialog control that contains tools. Each ToolTip can contain any number of
<emphasis role="italic">tools</emphasis>. A ToolTip with no added tool will never display text. In ooDialog, the tools
added to a ToolTip are usually other dialog controls.
</para>
<para>
ToolTips are hidden most of the time. They appear automatically, or pop up, when the user pauses the mouse pointer over a
tool. The ToolTip appears near the pointer and disappears when the user clicks a mouse button or moves the pointer away
from the tool.
</para>
<para>
ToolTip controls can display single or multiple lines of text. They can have square or rounded corners. They might or might
not have a stem that points to the tools like a cartoon balloon. ToolTip text can be stationary or can move with the mouse
pointer, these are called tracking ToolTips. Stationary text can be displayed adjacent to a tool or it can be displayed
over a tool, which is referred to as in-place ToolTips. Standard ToolTips are stationary, display a single line of text,
have square corners, and have no stem pointing to the tool.
</para>
<para>
The <computeroutput>ToolTip</computeroutput> class provides methods to work with and manipulate the underlying Windows
ToolTip dialog control which it represents. It is a concrete subclass of the dialog control <link
linkend="chpDialogControlObject">object</link> and therefore has all methods of the dialog control object.
</para>
<para>
The following classes, and methods from other classes, are needed, or are useful, when working with ToolTip controls:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">ToolInfo Class</emphasis></term>
<listitem>
<para>
The <link linkend="clsToolInfo">ToolInfo</link> class represents the information a ToolTip control uses to manage the
<emphasis role="italic">tools</emphasis> it contains. The attributes of a <computeroutput>ToolInfo</computeroutput>
object represent the information specific to a single tool within a ToolTip. Many of the methods of the
<computeroutput>ToolTip</computeroutput> class require a <computeroutput>ToolInfo</computeroutput> object as an argument,
or return information using a <computeroutput>ToolInfo</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Creation:</emphasis></term>
<listitem>
<para>
Unlike most other types of dialog controls, a ToolTip can not be added to a dialog <link
linkend="ovvDialogTemplate">template</link>. ToolTips are created dynamically using the <link
linkend="tmthCreateToolTip">createToolTip</link> method. ToolTips can only be created after the underlying Windows dialog
exists. Therefore, ToolTips can not be created in the <xref linkend="mthDefineDialog"/> method of the <link
linkend="clsUserDialog">UserDialog</link> class.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term>
<listitem>
<para>
Use the <link linkend="tmthNewToolTip">newToolTip</link> method of the <link linkend="chpDialogObject">dialog</link>
object to retrieve a Rexx ToolTip object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Event Notification</emphasis></term>
<listitem>
<para>
To connect the <link linkend="ovvEvents">event</link> notifications sent by the underlying ToolTip control to a method in
the Rexx dialog object use the <link linkend="mthConnectToolTipEvent">connectToolTipEvent</link> method.
</para>
</listitem></varlistentry>
</variablelist>
<section id="sctToolIdentification"><title>Tool Identification</title>
<indexterm><primary>ToolTip class</primary><secondary>tool identification</secondary></indexterm>
<para>
Each ToolTip can contain more than one <emphasis role="italic">tool</emphasis>. Because of this, the ToolTip control
needs a way of uniquely identifying each individual tool. In the operating system, each tool is identified using a
combination of a window <link linkend="defHandle">handle</link> and an ID. The ID however, can be either another window
handle or a unique number. When the ID is a number, the number is similar to a <xref linkend="defResourceId"/>.
</para>
<para>
For the operating system, the first part of the 2-part identifier is the handle of the window that the ToolTip will send
notifications to. The second part of the identifier can be a second window handle, if the ToolTip is going to subclass that
window, or an unique number if the ToolTip is not going to subclass the tool. This may seem somewhat complicated to the
Rexx programmer, especially if the programer has little experience with the underlying details of programming dialog
controls.
</para>
<para>
The ooDialog framework attempts to simplify this somewhat by allowing the Rexx programmer to identify an unique tool in
several different ways. For the most common use of ToolTips, identifying a tool is simple and can be done with one Rexx
object. However, ooDialog also supplies the means needed to identify a tool when more advanced use of ToolTips is desired.
</para>
<para>
This documentation refers to a tool identifier as a <emphasis role="italic">Rexx object combination</emphasis>. This can be
a combination of two Rexx objects, but quite often only one object is needed to indentify a tool.
<computeroutput>ToolTip</computeroutput> methods that require a tool to be identifed, have a required argument, a <emphasis
role="italic">toolHwnd</emphasis> argument, followed by a second optional argument a <emphasis
role="italic">toolID</emphasis> argument. The <emphasis role="italic">toolHwnd</emphasis> argument is usually argument 1,
followed by the <emphasis role="italic">toolID</emphasis> argument. However, in some cases the <emphasis
role="italic">toolHwnd</emphasis> argument may be argument 2 followed by the <emphasis role="italic">toolID</emphasis> as
argument 3.
</para>
<para>
The combination of the two arguments, <emphasis role="italic">toolHwnd</emphasis> and <emphasis
role="italic">toolID</emphasis>, is always handled in the same way, which is as follows:
</para>
<variablelist>
<varlistentry><term>if <emphasis role="italic">hwndTool</emphasis> == a <computeroutput>ToolInfo</computeroutput> object</term>
<listitem>
<para>
A <xref linkend="clsToolInfo"/> object always uniquely identifies a tool. When the <emphasis
role="italic">toolHwnd</emphasis> argument is a <computeroutput>ToolInfo</computeroutput> object that is sufficient and
the second <emphasis role="italic">toolID</emphasis> argument is ignored.
</para>
</listitem></varlistentry>
<varlistentry><term>if <emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is omitted</term>
<listitem>
<para>
It is very common that a ToolTip tool is a dialog control. For example quite often ToolTips are used for push buttons,
so that some label can be displayed when the user hovers the mouser over the button. ooDialog makes it easy for the
Rexx programmer to identify this type of tool by using just the dialog control object. When the <emphasis
role="italic">toolHwnd</emphasis> argument is not a <computeroutput>ToolInfo</computeroutput> object, and the <emphasis
role="italic">toolID</emphasis> is omitted, then the <emphasis role="italic">toolHwnd</emphasis> argument must be a
dialog control object. This dialog control object is the tool identifier. The ooDialog framework deduces the proper
values to identify the tool to the operating system.
</para>
</listitem></varlistentry>
<varlistentry><term>if <emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is not omitted</term>
<listitem>
<para>
This combination of identifying objects is needed when some more advanced uses of ToolTips are desired. It allows the
programmer to specify the exact values that should be passed on to the operarting system to identify the tool. For this
combination, <emphasis role="italic">hwndTool</emphasis> can be either a dialog object, or a dialog control object. When
<emphasis role="italic">hwndTool</emphasis> is a dialog object, then <emphasis role="italic">toolID</emphasis> must be
either a dialog control object or an unique whole number. The first part of the 2-part operating system ID for the tool
is set to the window handle of the Rexx object, the dialog window handle or the dialog control window handle.
</para>
<para>
The <emphasis role="italic">toolID</emphasis> argument can be either a dialog control, or an unique non-negative whole
number. If the <emphasis role="italic">toolHwnd</emphasis> argument is a dialog, then <emphasis
role="italic">toolID</emphasis> can be a dialog control or a number. However, if <emphasis
role="italic">toolHwnd</emphasis> is a dialog control, the <emphasis role="italic">toolID</emphasis> must be a number.
The second part of the 2-part operating system identifier is set to the window handle of the dialog control, if <emphasis
role="italic">toolID</emphasis> is a dialoog control. Otherwise the second part is set to the number specified. Note that
numbers can be specified using <link linkend="defSymbolicId">symbolic</link> IDs just as other types of resource IDs are.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Tool Identification Section -->
<section id="sctMethodsToolTip"><title>Method Table</title>
<para>
The following table provides links to the documentation for the primary methods and attributes used in working
with ToolTip objects, including the pertinent methods from other classes:
</para>
<table id="tblToolTipMethods" frame="all">
<title>Important ToolTip Methods</title>
<tgroup cols="2">
<colspec colwidth="3*" /><colspec colwidth="8*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Useful</emphasis></entry>
<entry align="center"><emphasis role="bold">Classes</emphasis></entry>
</row>
<row>
<entry><link linkend="clsToolInfo">ToolInfo</link></entry>
<entry>A <computeroutput>ToolInfo</computeroutput> object is used to supply tool information to, or recieve tool information from, the ToolTip control.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Useful</emphasis></entry>
<entry align="center"><emphasis role="bold">External Methods</emphasis></entry>
</row>
<row>
<entry><link linkend="tmthCreateToolTip">createToolTip</link></entry>
<entry>Creates the underlying Windows ToolTip control and returns an instantiated Rexx ToolTip object.</entry>
</row>
<row>
<entry><link linkend="tmthConnectToolTipEvent">connectToolTipEvent</link></entry>
<entry>Connects tool tip event notifications to a method in the Rexx dialog object</entry>
</row>
<row>
<entry><link linkend="tmthNewToolTip">newToolTip</link></entry>
<entry>Returns the Rexx <computeroutput>ToolTip</computeroutput> object for the tool tip control with the specified ID.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="mthActivate"/></entry>
<entry>Activates or deactivates this ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthAddTool"/></entry>
<entry>Adds a tool to this ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthAddToolEx"/></entry>
<entry>Adds the tool, specified by a <computeroutput>ToolInfo</computeroutput> object, to this ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthAddToolRect"/></entry>
<entry>Adds a tool that uses a rectangular area in the dialog as its trigger point.</entry>
</row>
<row>
<entry><xref linkend="mthAdjustRect"/></entry>
<entry>Calculates a ToolTip control's text display rectangle from its window rectangle, or the ToolTip window rectangle needed to display a specified text display rectangle.</entry>
</row>
<row>
<entry><xref linkend="mthDelTool"/></entry>
<entry>Removes the specified tool from this ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthEnumTools"/></entry>
<entry>Retrieves a <xref linkend="clsToolInfo"/> object for the tool at the specified index.</entry>
</row>
<row>
<entry><xref linkend="mthGetBubbleSize"/></entry>
<entry>Returns the width and height, as a <xref linkend="clsSize"/> object, of this ToolTip control.</entry>
</row>
<row>
<entry><xref linkend="mthGetCurrentToolInfo"/></entry>
<entry>Retrieves a <xref linkend="clsToolInfo"/> object whose attributes represent the current tool in this tool tip.</entry>
</row>
<row>
<entry><xref linkend="mthGetDelayTime"/></entry>
<entry>Retrieves one of the 3 delay times currently set for this ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthGetMargin"/></entry>
<entry>Returns a rectangle that describes the margins of the ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthGetMaxTipWidth"/></entry>
<entry>Retrieves the maximum width for this ToolTip window.</entry>
</row>
<row>
<entry><xref linkend="mthGetTextClsToolTip"/></entry>
<entry>Retrieves the text information this ToolTip control maintains about the specified tool.</entry>
</row>
<row>
<entry><xref linkend="mthGetTipBkColor"/></entry>
<entry>Retrieves the background color for this ToolTip's window.</entry>
</row>
<row>
<entry><xref linkend="mthGetTipTextColor"/></entry>
<entry>Retrieves the text color fot this ToolTip's window.</entry>
</row>
<row>
<entry><xref linkend="mthGetTitle"/></entry>
<entry>Retrieves information concerning the title and icon of this ToolTip control.</entry>
</row>
<row>
<entry><xref linkend="mthGetToolCount"/></entry>
<entry>Retrieves the number of tools this ToolTip contains.</entry>
</row>
<row>
<entry><xref linkend="mthGetToolInfo"/></entry>
<entry>Retrieves the information, as a <xref linkend="clsToolInfo"/> object, that this tool tip control maintains about the specified tool.</entry>
</row>
<row>
<entry><xref linkend="mthHasCurrentTool"/></entry>
<entry>Tests if this ToolTip has a current tool.</entry>
</row>
<row>
<entry><xref linkend="mthHitTestClsToolTip"/></entry>
<entry>Tests a point to determine whether it is within the bounding rectangle of a tool within the window specified and, if it is, retrieves information about the tool.</entry>
</row>
<row>
<entry><xref linkend="mthManageAtypicalTool"/></entry>
<entry>Initiates the management of a ToolTip tool that is a dialog control.</entry>
</row>
<row>
<entry><xref linkend="mthNewToolRect"/></entry>
<entry>Sets a new bounding rectangle for a tool.</entry>
</row>
<row>
<entry><xref linkend="mthPop"/></entry>
<entry>Removes, hides, this ToolTip's display window.</entry>
</row>
<row>
<entry><xref linkend="mthPopup"/></entry>
<entry>Causes this ToolTip to display at the coordinates of the last mouse message.</entry>
</row>
<row>
<entry><xref linkend="mthSetDelayTime"/></entry>
<entry>Sets the initial, pop-up, and reshow durations for this ToolTip control.</entry>
</row>
<row>
<entry><xref linkend="mthSetMargin"/></entry>
<entry>Sets the top, left, bottom, and right margins for this ToolTip window. A margin is the distance, in pixels, between the ToolTip window border and the text contained within the ToolTip window.</entry>
</row>
<row>
<entry><xref linkend="mthSetMaxTipWidth"/></entry>
<entry>Sets the maximum width, in pixels, for this ToolTip window.</entry>
</row>
<row>
<entry><xref linkend="mthSetTipBkColor"/></entry>
<entry>Sets the background color for this ToolTip window.</entry>
</row>
<row>
<entry><xref linkend="mthSetTipTextColor"/></entry>
<entry>Sets the text color for this ToolTip window.</entry>
</row>
<row>
<entry><xref linkend="mthSetTitleClsToolTip"/></entry>
<entry>Adds a title string and optionally an icon image to this ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthSetToolInfo"/></entry>
<entry>Sets the information that this ToolTip control maintains for a tool.</entry>
</row>
<row>
<entry><xref linkend="mthSetWindowTheme"/></entry>
<entry>Sets the visual style of a ToolTip control.</entry>
</row>
<row>
<entry><xref linkend="mthTrackActivate"/></entry>
<entry>Activates or deactivates a tracking ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthTrackPosition"/></entry>
<entry>Sets the position of a tracking ToolTip.</entry>
</row>
<row>
<entry><xref linkend="mthUpdateClsToolTip"/></entry>
<entry>Forces the current tool to be redrawn.</entry>
</row>
<row>
<entry><xref linkend="mthUpdateTipText"/></entry>
<entry>Sets the ToolTip text for a tool.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="tmthConnectToolTipEvent"><title>connectToolTipEvent (dialog object method)</title>
<para>
To connect event notifications from an tool tip control use the <link
linkend="mthConnectToolTipEvent">connectToolTipEvent</link>() method of the <link
linkend="chpDialogObject">dialog</link> object. The basic syntax is:
<programlisting> <![CDATA[
>>--connectToolTipEvent(--id--,--event--+-----------+--+-------------+--)------><
+-,-mthName-+ +-,-willReply-+
]]>
</programlisting>
</para>
</section> <!-- End connectToolTipEvent() [EventNotification method] -->
<section id="tmthCreateToolTip"><title>createToolTip (dialog object method)</title>
<para>
To create the underlying Windows ToolTip control use the <link linkend="mthCreateToolTip">createToolTip</link> method of
the <link linkend="chpDialogObject">dialog</link> object. This method also returns the instantiated Rexx object that
represents the created tool tip control. The basic syntax is:
<programlisting>
<![CDATA[
>>--createToolTip(--id--+----------+--)-------------><
+-,-style--+
]]>
</programlisting>
</para>
</section> <!-- End createToolTipt() [PlainBaseDialog method] -->
<section id="tmthNewToolTip"><title>newToolTip (dialog object method)</title>
<para>
ToolTip objects can not be instantiated by the programmer from Rexx code using the normal <emphasis
role="italic">new</emphasis> method. Rather a ToolTip object is obtained either by using the <xref
linkend="mthCreateToolTip"/> method or the <link linkend="mthNewToolTip">newToolTip</link> method of the dialog <link
linkend="chpDialogObject">object</link>. The syntax for the <emphasis role="italic">newToolTip</emphasis> is:
<programlisting>
<![CDATA[
>>-newToolTip(--id--)---------------------><
]]>
</programlisting>
</para>
</section> <!-- End newToolTip() [PlainBaseDialog method] -->
<section id="mthActivate" xreflabel="activate"><title>activate</title>
<indexterm><primary>activate</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>activate</secondary></indexterm>
<programlisting>
<![CDATA[
>>--activate(--+------------+--)-----------------><
+--activate--+
]]>
</programlisting>
<para>
Activates or deactivates this ToolTip.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single optional argument is:
</para>
<variablelist>
<varlistentry><term>activate [optional]</term>
<listitem>
<para>
If true, activates this tool it, if false, deactivate this tool tip. The default if the argument is omitted is true.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
A ToolTip control can be either active or inactive. When it is active, the ToolTip text appears when the mouse pointer is
on a tool. When it is inactive, the ToolTip text does not appear, even if the pointer is on a tool.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::activate() -->
<section id="mthAddTool" xreflabel="addTool"><title>addTool</title>
<indexterm><primary>addTool</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>addTool</secondary></indexterm>
<programlisting>
<![CDATA[
>>--addTool(--tool--+---------+--+---------+--+------------+--)----------------><
+-,-text--+ +-,-flags-+ +-,-userData-+
]]>
</programlisting>
<para>
Adds a tool to this ToolTip.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>tool [required]</term>
<listitem>
<para>
The dialog control that defines the tool being added.
</para>
</listitem></varlistentry>
<varlistentry><term>text [optional]</term>
<listitem>
<para>
Text for the tool. If omitted, or the empty string, or the string: TEXTCALLBACK, then the tool tip sends the <xref
linkend="kywToolTipNEEDTEXT"/> notification and the program supplies the text.
</para>
<para>
The length of the text must be less than 1024 characters, which includes any possible end of line (0x0D0A) sequences.
</para>
</listitem></varlistentry>
<varlistentry><term>flags [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant. If this argument is
omitted, the flags are set to IDISHWND SUBCLASS:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>ABSOLUTE </member>
<member>CENTERTIP </member>
<member>IDISHWND </member>
<member>PARSELINKS </member>
<member>RTLREADING </member>
<member>SUBCLASS </member>
<member>TRACK </member>
<member>TRANSPARENT</member>
</simplelist>
<variablelist>
<varlistentry><term>ABSOLUTE</term>
<listitem>
<para>
Positions the ToolTip window at the exact same coordinates specified by the <xref linkend="mthTrackPosition"/>
method. Without this flag the ToolTip control chooses where to display the ToolTip window based on the
coordinates specified, which places the ToolTip close to the tool. This flag must be used with the TRACK flag.
</para>
</listitem></varlistentry>
<varlistentry><term>CENTERTIP</term>
<listitem>
<para>
Centers the ToolTip window below the tool specified by the <emphasis role="italic">tool</emphasis> argument.
</para>
</listitem></varlistentry>
<varlistentry><term>IDISHWND</term>
<listitem>
<para>
Indicates that the ID part of the tool <link linkend="sctToolIdentification">identification</link> is the window
handle to the tool. If this flag is not set, the ID part is the tool's identification number. For the <emphasis
role="italic">addTool</emphasis> method, the ooDialog framework always sets this flag, it does not need to be
specified by the programmer. The window <link linkend="defHandle">handle</link> of the <emphasis
role="italic">tool</emphasis> argument is always the ID part of the tool identification.
</para>
</listitem></varlistentry>
<varlistentry id="kywToolTipPARSELINKS" xreflabel="PARSELINKS"><term>PARSELINKS</term>
<listitem>
<para>
Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later.
</para>
<para>
Indicates that links in the ToolTip text should be parsed.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Indicates that the ToolTip text will be displayed in the opposite direction to the text in the parent window.
</para>
</listitem></varlistentry>
<varlistentry><term>SUBCLASS</term>
<listitem>
<para>
Indicates that the ToolTip control should subclass the tool's window to intercept messages, such as WM_MOUSEMOVE.
If this flag is not set, the <xref linkend="mthManageAtypicalTool"/> method must be used so the mouse messages
are forwarded to the ToolTip control. For the simple case that the <emphasis role="italic">addTool</emphasis>
method is designed for, the <emphasis role="italic">manageAtypicalTool</emphasis> method will not work. The
ooDialog framwork always sets this flag during the <emphasis role="italic">addTool</emphasis> method, the
programmer does not need to include this flag.
</para>
</listitem></varlistentry>
<varlistentry><term>TRACK</term>
<listitem>
<para>
Positions the ToolTip window next to the tool to which it corresponds and moves the window according to
coordinates supplied by the <xref linkend="mthTrackPosition"/> method. The programmer must activate this
type of tool using the <xref linkend="mthTrackActivate"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term>TRANSPARENT</term>
<listitem>
<para>
Causes the ToolTip control to forward mouse event messages to the parent window. This is limited to mouse events
that occur within the bounds of the ToolTip window.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>userData [optional]</term>
<listitem>
<para>
A user data value to be associated with the tool. This can be any Rexx object the programmer wants. Note that the
value is associated with the tool, not the tool tip.
</para>
</listitem></varlistentry>
</variablelist>
</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">addTool</emphasis> method is intended to be a convenient method for use in the most common
case of adding a tool. The case where the tool is a simple dialog control. Use the <xref linkend="mthAddToolRect"/> or
the <xref linkend="mthAddToolEx"/> methods to add a tool with characteristics that need to be more explicitly defined.
</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 creates a ToolTip and then adds a tool to it. The tool is defined using a push button dialog control and
the text for the tool is specified at the time the tool is added:
<programlisting>
<![CDATA[
pbTest = self~newPushButton(IDC_PB_TEST)
count = 0
...
ttTest = self~createToolTip(IDC_TT_TEST)
ttTest~addTool(pbTest, "Push the Test button to start the regression testing.")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::addTool() -->
<section id="mthAddToolEx" xreflabel="addToolEx"><title>addToolEx</title>
<indexterm><primary>addToolEx</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>addToolEx</secondary></indexterm>
<programlisting>
<![CDATA[
>>--addToolEx(--tool--)--------------------------><
]]>
</programlisting>
<para>
Adds the specified tool to this ToolTip.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>tool [required]</term>
<listitem>
<para>
A <xref linkend="clsToolInfo"/> object that defines the tool being added.
</para>
</listitem></varlistentry>
</variablelist>
</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>
There are a number of different attributes that can be set when adding a tool to a tool tip. The <emphasis
role="italic">addToolEx</emphasis> method is designed to let the programmer specify any valid combination of attributes
allowed by the operating system. To do this, it requires the specifier of the tool to be a
<computeroutput>ToolInfo</computeroutput> object. The programmer is responsible for setting the tool attriubtes as he
wishes.
</para>
<para>
For the simple case of adding a tool that is a dialog control, the <xref linkend="mthAddTool"/> is a more convenient
method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example creates a ToolTip and then adds a tool that will supply customized tool tips for a tree-view:
<programlisting>
<![CDATA[
tv = self~newTreeView(IDC_TREE)
rect = tv~clientRect
tt = self~createToolTip(IDC_TT)
toolInfo = .ToolInfo~new(tv, ID_TREE_TOOL, '', 'TRANSPARENT', rect)
tt~addToolEx(toolInfo)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::addToolEx() -->
<section id="mthAddToolRect" xreflabel="addToolRect"><title>addToolRect</title>
<indexterm><primary>addToolRect</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>addToolRect</secondary></indexterm>
<programlisting>
<![CDATA[
>>--addToolRect(--dlg-,-id-,-rect--+--------+-+---------+-+------------+--)----><
+-,-txt--+ +-,-flags-+ +-,-userData-+
]]>
</programlisting>
<para>
Adds a tool that uses a rectangular area in the dialog as its trigger point.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>dlg [required]</term>
<listitem>
<para>
The dialog <link linkend="chpDialogObject">object</link> that contains the rectangular area specified by the
<emphasis role="italic">rect</emphasis> argument.
</para>
</listitem></varlistentry>
<varlistentry><term>id [required]</term>
<listitem>
<para>
An unique, non-negative, whole number that identifies the tool being added. May be numeric or <xref
linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>rect [required]</term>
<listitem>
<para>
A <xref linkend="clsRect"/> object that specifies the bounding rectangle coordinates of the tool. The coordinates are
in client <link linkend="defScreenCoordinates">coordinates</link> of the dialog identified by the <emphasis
role="italic">dlg</emphasis> argument.
</para>
</listitem></varlistentry>
<varlistentry><term>txt [optional]</term>
<listitem>
<para>
Text for the tool. If omitted, or the empty string, or the string: TEXTCALLBACK, then the ToolTip sends the <xref
linkend="kywToolTipNEEDTEXT"/> notification and the program supplies the text.
</para>
<para>
The length of the text must be less than 1024 characters, which includes any possible end of line (0x0D0A) sequences.
</para>
</listitem></varlistentry>
<varlistentry><term>flags [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant. If this argument is
omitted, the flags are set to SUBCLASS:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>ABSOLUTE </member>
<member>CENTERTIP </member>
<member>IDISHWND </member>
<member>PARSELINKS </member>
<member>RTLREADING </member>
<member>SUBCLASS </member>
<member>TRACK </member>
<member>TRANSPARENT</member>
</simplelist>
<variablelist>
<varlistentry><term>ABSOLUTE</term>
<listitem>
<para>
Positions the ToolTip window at the exact same coordinates specified by the <xref linkend="mthTrackPosition"/>
method. Without this flag the ToolTip control chooses where to display the ToolTip window based on the
coordinates specified, which places the ToolTip close to the tool. This flag must be used with the TRACK flag.
</para>
</listitem></varlistentry>
<varlistentry><term>CENTERTIP</term>
<listitem>
<para>
Centers the ToolTip window below the tool specified by the <emphasis role="italic">tool</emphasis> argument.
</para>
</listitem></varlistentry>
<varlistentry><term>IDISHWND</term>
<listitem>
<para>
Indicates that the ID part of the tool <link linkend="sctToolIdentification">identification</link> is the window
handle to the tool. This flag can not be used for the <emphasis role="italic">addToolRect</emphasis> method. If
it is present, the ooDialog framework removes it.
</para>
</listitem></varlistentry>
<varlistentry><term>PARSELINKS</term>
<listitem>
<para>
Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later.
</para>
<para>
Indicates that links in the ToolTip text should be parsed.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Indicates that the ToolTip text will be displayed in the opposite direction to the text in the parent window.
</para>
</listitem></varlistentry>
<varlistentry><term>SUBCLASS</term>
<listitem>
<para>
Indicates that the ToolTip control should subclass the tool's window to intercept messages, such as WM_MOUSEMOVE.
If this flag is not set, some means must be used so that the mouse messages are forwarded to the ToolTip control.
For the use case that the <emphasis role="italic">addToolRect</emphasis> method is designed for, this flag
should always be set. The ooDialog framwork always sets this flag during the <emphasis
role="italic">addToolRect</emphasis> method, the programmer does not need to include this flag.
</para>
</listitem></varlistentry>
<varlistentry><term>TRACK</term>
<listitem>
<para>
Positions the ToolTip window next to the tool to which it corresponds and moves the window according to
coordinates supplied by the <xref linkend="mthTrackPosition"/> method. The programmer must activate this
type of tool using the <xref linkend="mthTrackActivate"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term>TRANSPARENT</term>
<listitem>
<para>
Causes the ToolTip control to forward mouse event messages to the parent window. This is limited to mouse events
that occur within the bounds of the ToolTip window.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>userData [optional]</term>
<listitem>
<para>
A user data value to be associated with the tool. This can be any Rexx object the programmer wants. Note that the
value is associated with the tool, not the tool tip.
</para>
</listitem></varlistentry>
</variablelist>
</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 usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example was created solely as a demonstration of how ToolTips work, it has no real practical value. It displays
ToolTips as the mouse moves over a dialog:
<programlisting>
<![CDATA[
tt = self~createToolTip(IDC_TT_MAIN)
clRect = self~clientRect
hMidpoint = trunc((clRect~right - clRect~left) / 2) + clRect~left
vMidpoint = trunc((clRect~bottom - clRect~top) / 2) + clRect~top
clRect1 = .Rect~new(clRect~left, clRect~top, hMidpoint, vMidpoint)
clRect2 = .Rect~new(hMidpoint + 1, clRect~top, clRect~right, vMidpoint + 1)
clRect3 = .Rect~new(clRect~left, vMidpoint + 1, hMidpoint + 1, clRect~bottom)
clRect4 = .Rect~new(hMidpoint + 1, vMidpoint + 1, clRect~right, clRect~bottom)
text1 = 'Over main dialog, top left quadrant'
text2 = 'Over main dialog, top right quadrant'
text3 = 'Over main dialog, bottom left quadrant'
text4 = 'Over main dialog, bottom right quadrant'
ret = tt~addToolRect(self, IDTOOL_DLG_RECT1, clRect1, text1, 'TRANSPARENT')
ret = tt~addToolRect(self, IDTOOL_DLG_RECT2, clRect2, text2, 'TRANSPARENT')
ret = tt~addToolRect(self, IDTOOL_DLG_RECT3, clRect3, text3, 'TRANSPARENT')
ret = tt~addToolRect(self, IDTOOL_DLG_RECT4, clRect4, text4, 'TRANSPARENT')
self~connectToolTipEvent(IDC_TT_MAIN, 'SHOW', onShow)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::addToolRect() -->
<section id="mthAdjustRect" xreflabel="adjustRect"><title>adjustRect</title>
<indexterm><primary>adjustRect</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>adjustRect</secondary></indexterm>
<programlisting>
<![CDATA[
>>--adjustRect(--rect--+-----------+--)----------><
+-,-larger--+
]]>
</programlisting>
<para>
Calculates a ToolTip control's text display rectangle from its window rectangle, or the ToolTip window rectangle needed to
display a specified text display rectangle.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>rect [required]</term>
<listitem>
<para>
A <xref linkend="clsRect"/> object used to specify the rectangle to adjust. On a successful return, the coordinates
in the rectangle will be adjusted as specified by the <emphasis role="italic">larger</emphasis> arguent.
</para>
</listitem></varlistentry>
<varlistentry><term>larger [optional]</term>
<listitem>
<para>
True or false to specify how the rectangle is adjusted. If omitted, the default is false.
</para>
<para>
If true, <emphasis role="italic">rect</emphasis> is used to specify a text-display rectangle and it is updated to
contain the corresponding window rectangle. On return the rectangle is <emphasis role="italic">larger</emphasis> in
this case. If false, <emphasis role="italic">rect</emphasis> is used to specify a window rectangle and it is updated
to the corresponding text display rectangle. On return, the rectangle is <emphasis role="italic">not</emphasis>
larger, (it is smaller,) in this case.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true if the rectangle was adjusted correctly, and returns false if an error occurred.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method is particularly useful when a ToolTip control is used to display the full text of a string that is truncated.
It is commonly used with list-view and tree-view controls. Typically send this method would be used in response to a
<xref linkend="kywToolTipSHOW"/> SHOW event notification so that the ToolTip control properly can be positioned properly.
</para>
<para>
The ToolTip's window rectangle is somewhat larger than the text display rectangle that bounds the ToolTip string. The
window origin is also offset up and to the left from the origin of the text display rectangle. To position the text
display rectangle, the programmer must calculate the corresponding window rectangle and use that rectangle to position
the ToolTip. The <emphasis role="italic">adjustRect</emphasis> method handles this calculation for the programmer.
</para>
<para>
If <emphasis role="italic">larger</emphasis> is set to true, <emphasis role="italic">adjustRect</emphasis> takes the size
and position of the desired ToolTip text display rectangle, and passes back the size and position of the ToolTip window
needed to display the text in the specified position. If <emphasis role="italic">larger</emphasis> is set to false, the
programmer can specify a ToolTip window rectangle and the <emphasis role="italic">adjustRect</emphasis> method will
return the size and position of its text rectangle.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::adjustRect() -->
<section id="mthDelTool" xreflabel="delTool"><title>delTool</title>
<indexterm><primary>delTool</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>delTool</secondary></indexterm>
<programlisting>
<![CDATA[
>>--delTool(--toolHwnd--+----------+--)----------><
+-,-toolID-+
]]>
</programlisting>
<para>
Removes the specified tool from this ToolTip.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolHwnd [required]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term>toolID [optional]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <link linkend="sctToolIdentification">Tool Identification</link> section explains exactly how the Rexx object
combination is used to specify the tool to be deleted.
</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 tool being added to a ToolTip and then at some later point in the application being deleted.
<programlisting>
<![CDATA[
pbTest = self~newPushButton(IDC_PB_TEST)
count = 0
...
ttTest = self~createToolTip(IDC_TT_TEST)
ttTest~addTool(pbTest, "Push the Test button to start the regression testing.")
...
ttTest~delTool(pbTest)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::delTool() -->
<section id="mthEnumTools" xreflabel="enumTools"><title>enumTools</title>
<indexterm><primary>enumTools</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>enumTools</secondary></indexterm>
<programlisting>
<![CDATA[
>>--enumTools(--+---------+--)-------------------><
+--index--+
]]>
</programlisting>
<para>
Retrieves a <xref linkend="clsToolInfo"/> object for the tool at the specified index.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>index</term>
<listitem>
<para>
The one-based index of the tool to retrieve. If omitted, <emphasis role="italic">index</emphasis> defaults to 1.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the tool, as a <computeroutput>ToolInfo</computeroutput> object, at the index specified, or the
<computeroutput>.nil</computeroutput> object if there is no tool at the index.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The Microsoft documentation says nothing about what, if any, order the tools contained in a ToolTip are in.
</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 <emphasis role="italic">enumerates</emphasis> the tools in a ToolTip:
<programlisting>
<![CDATA[
do i = 1 to toolTip~getToolCount
toolInfo = toolTip~enumTools(i)
say 'Tool info hwnd: ' toolInfo~rexxHwnd
say 'Tool info id: ' toolInfo~rexxID
say 'Tool info text: ' toolInfo~text
say 'Tool info flags: ' toolInfo~flags
say 'Tool info rect: ' toolInfo~rect
say 'Tool info userData:' toolInfo~userData
say 'Tool info resource:' toolInfo~resource
say
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::enumTools() -->
<section id="mthGetBubbleSize" xreflabel="getBubbleSize"><title>getBubbleSize</title>
<indexterm><primary>getBubbleSize</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getBubbleSize</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getBubbleSize(--toolHwnd--+----------+--)----><
+-,-toolID-+
]]>
</programlisting>
<para>
Returns the width and height, as a <xref linkend="clsSize"/> object, of this ToolTip control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolHwnd [required]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term>toolID [optional]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
A <computeroutput>Size</computeroutput> object specifying the width and height of this tool tip control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <link linkend="sctToolIdentification">Tool Identification</link> section explains exactly how the Rexx object
combination is used to specify the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getBubbleSize() -->
<section id="mthGetCurrentToolInfo" xreflabel="getCurrentToolInfo"><title>getCurrentToolInfo</title>
<indexterm><primary>getCurrentToolInfo</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getCurrentToolInfo</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getCurrentToolInfo---------------------------><
]]>
</programlisting>
<para>
Retrieves a <xref linkend="clsToolInfo"/> object whose attributes represent the current tool in this tool tip.
</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 the current tool as a <xref linkend="clsToolInfo"/> object, if one exists, or
the <computeroutput>.nil</computeroutput> object if there is not a current tool.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getCurrentToolInfo() -->
<section id="mthGetDelayTime" xreflabel="getDelayTime"><title>getDelayTime</title>
<indexterm><primary>getDelayTime</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getDelayTime</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getDelayTime(--+---------+--)----------------><
+--which--+
]]>
</programlisting>
<para>
Retrieves one of the 3 delay times currently set for this ToolTip.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>which [optional]</term>
<listitem>
<para>
Exactly one of the following keywords, case is not significant. This specifies which of the 3 possible delay times to
retrieve. The default if omitted is AUTOPOP:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>AUTOPOP </member>
<member>INITIAL </member>
<member>RESHOW </member>
</simplelist>
<variablelist>
<varlistentry><term>AUTOPOP</term>
<listitem>
<para>
The amount of time the ToolTip window remains visible if the pointer is stationary within a tool's bounding
rectangle.
</para>
</listitem></varlistentry>
<varlistentry><term>INITIAL</term>
<listitem>
<para>
The amount of time the pointer must remain stationary within a tool's bounding rectangle before the ToolTip
window appears.
</para>
</listitem></varlistentry>
<varlistentry><term>RESHOW</term>
<listitem>
<para>
The amount of time it takes for subsequent ToolTip windows to appear as the pointer moves from one tool to
another.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The specified delay time in milliseconds.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getDelayTime() -->
<section id="mthGetMargin" xreflabel="getMargin"><title>getMargin</title>
<indexterm><primary>getMargin</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getMargin</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getMargin------------------------------------><
]]>
</programlisting>
<para>
Returns a rectangle that describes the margins of the ToolTip
</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>
A <xref linkend="clsRect"/> object whose attributes specify the margins of the ToolTip.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attributes of the returned rectangle do not define a bounding rectangle. For the purpose of this method, the
attributes are interpreted as follows:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">top:</emphasis></term>
<listitem>
<para>
Distance between top border and top of ToolTip text, in pixels.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">left:</emphasis></term>
<listitem>
<para>
Distance between left border and left end of ToolTip text, in pixels.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">bottom:</emphasis></term>
<listitem>
<para>
Distance between bottom border and bottom of ToolTip text, in pixels.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">right:</emphasis></term>
<listitem>
<para>
Distance between right border and right end of ToolTip text, in pixels.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getMargin() -->
<section id="mthGetMaxTipWidth" xreflabel="getMaxTipWidth"><title>getMaxTipWidth</title>
<indexterm><primary>getMaxTipWidth</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getMaxTipWidth</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getMaxTipWidth-------------------------------><
]]>
</programlisting>
<para>
Retrieves the maximum width for this ToolTip window.
</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 whole number value that represents the maximum ToolTip width, in pixels. If no maximum width was set
previously, this method returns -1.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The maximum ToolTip width value does not indicate a ToolTip window's actual width. Rather, if a ToolTip string exceeds
the maximum width, the control breaks the text into multiple lines, using spaces or newline characters to determine line
breaks. If the text cannot be segmented into multiple lines, it will be displayed on a single line. The length of this
line may exceed the maximum ToolTip width.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getMaxTipWidth() -->
<section id="mthGetTextClsToolTip" xreflabel="getText"><title>getText</title>
<indexterm><primary>getText</primary><secondary>ToolTip class</secondary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getText(--toolHwnd--+----------+--)----------><
+-,-toolID-+
]]>
</programlisting>
<para>
Retrieves the text information this ToolTip control maintains about the specified tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolHwnd [required]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term>toolID [optional]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The text string for the specified tool
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <link linkend="sctToolIdentification">Tool Identification</link> section explains exactly how the Rexx object
combination is used to specify the tool to get the text for.
</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 example prints to the screen the text for a tool tip where the tool is a rectangular area in a dialog:
<programlisting>
<![CDATA[
say 'Text for the tool tip:' tt~getText(self, IDTOOL_DLG_RECT1)
/* Output might be:
Text for the tool tip: Over main dialog, top left quadrant
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getText() -->
<section id="mthGetTipBkColor" xreflabel="getTipBkColor"><title>getTipBkColor</title>
<indexterm><primary>getTipBkColor</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getTipBkColor</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getTipBkColor--------------------------------><
]]>
</programlisting>
<para>
Retrieves the background color for this ToolTip window.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments for this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a <xref linkend="defColorRef"/> value that represents the background color of this ToolTip window.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getTipBkColor() -->
<section id="mthGetTipTextColor" xreflabel="getTipTextColor"><title>getTipTextColor</title>
<indexterm><primary>getTipTextColor</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getTipTextColor</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getTipTextColor------------------------------><
]]>
</programlisting>
<para>
Retrieves the text color fot this ToolTip window.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method does not have any arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a <xref linkend="defColorRef"/> value that represents the background color of this ToolTip window.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getTipTextColor() -->
<section id="mthGetTitle" xreflabel="getTitle"><title>getTitle</title>
<indexterm><primary>getTitle</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getTitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getTitle-------------------------------------><
]]>
</programlisting>
<para>
Retrieves information concerning the title and icon of this ToolTip control.
</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 a <computeroutput>.Directory</computeroutput> object whose indexes contain the title and icon information for
this ToolTip. Indexes are:
</para>
<variablelist>
<varlistentry><term>TITLE</term>
<listitem>
<para>
The title text.
</para>
</listitem></varlistentry>
<varlistentry><term>ICON</term>
<listitem>
<para>
The ICON index will be the <xref linkend="clsImage"/> object used for the icon of this ToolTip, or one of the following
keywords if a system image is used for the icon:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>NONE </member>
<member>ERROR </member>
<member>ERRORLARGE </member>
<member>INFO </member>
<member>INFOLARGE </member>
<member>WARNING </member>
<member>WARNINGLARGE</member>
</simplelist>
<variablelist>
<varlistentry><term>NONE</term>
<listitem>
<para>
No icon.
</para>
</listitem></varlistentry>
<varlistentry><term>ERROR</term>
<listitem>
<para>
Error icon.
</para>
</listitem></varlistentry>
<varlistentry><term>ERRORLARGE</term>
<listitem>
<para>
Large warning icon.
</para>
</listitem></varlistentry>
<varlistentry><term>INFO</term>
<listitem>
<para>
Info icon.
</para>
</listitem></varlistentry>
<varlistentry><term>INFOLARGE</term>
<listitem>
<para>
Large info icon.
</para>
</listitem></varlistentry>
<varlistentry><term>WARNING</term>
<listitem>
<para>
Warning icon.
</para>
</listitem></varlistentry>
<varlistentry><term>WARNINGLARGE</term>
<listitem>
<para>
Large warning icon.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>ISKEYWORD</term>
<listitem>
<para>
True if the ICON index is a keyword, false if it is an <computeroutput>Image</computeroutput> object.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The underlying Windows API for <emphasis role="italic">getTitle</emphasis> appears to be rather idiosyncratic.
</para>
<para>
In testing, when setting the icon to an actual icon image, getting the icon always returns the INFOLARGE keyword, rather
than the icon image. In addition, when setting the icon to any of the LARGE keyword values, getting the icon always
returns the non-large keyword. This anomaly is mentioned in several places on the web. The following table shows this
behaviour:
<table id="tblGetTitleReturns" frame="all"> <title>getTitle Anomalies</title>
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="1*"/>
<thead>
<row>
<entry>Actual Icon Value</entry>
<entry>getTitle() returns</entry>
</row>
</thead>
<tbody>
<row>
<entry>hIcon</entry>
<entry>INFOLARGE</entry>
</row>
<row>
<entry>INFOLARGE</entry>
<entry>INFO</entry>
</row>
<row>
<entry>WARNINGLARGE</entry>
<entry>WARNING</entry>
</row>
<row>
<entry>ERRORLARGE</entry>
<entry>ERROR</entry>
</row>
</tbody></tgroup>
</table>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getTitle() -->
<section id="mthGetToolCount" xreflabel="getToolCount"><title>getToolCount</title>
<indexterm><primary>getToolCount</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getToolCount</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getToolCount---------------------------------><
]]>
</programlisting>
<para>
Retrieves the number of tools this ToolTip contains.
</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 the number of tools in the ToolTip.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">getToolCount</emphasis> method in conjunction with the <xref linkend="mthEnumTools"/> method
is useful in enumerating the tools of the ToolTip.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example prints out information for each tool in the ToolTip:
<programlisting>
<![CDATA[
do i = 1 to tt~getToolCount
toolInfo = tt~enumTools(i)
say 'Tool info hwnd: ' toolInfo~rexxHwnd
say 'Tool info id: ' toolInfo~rexxID
say 'Tool info text: ' toolInfo~text
say 'Tool info flags: ' toolInfo~flags
say 'Tool info rect: ' toolInfo~rect
say 'Tool info userData:' toolInfo~userData
say 'Tool info resource:' toolInfo~resource
say
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getToolCount() -->
<section id="mthGetToolInfo" xreflabel="getToolInfo"><title>getToolInfo</title>
<indexterm><primary>getToolInfo</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getToolInfo</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getToolInfo(--toolHwnd--+----------+--)------><
+-,-toolID-+
]]>
</programlisting>
<para>
Retrieves the information, as a <xref linkend="clsToolInfo"/> object, that this tool tip control maintains about the
specified tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolHwnd [required]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term>toolID [optional]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a <computeroutput>ToolInfo</computeroutput> object whose attributes reflect the information that this ToolTip
maintains about the specified tool. On error, the <computeroutput>.nil</computeroutput> object is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <link linkend="sctToolIdentification">Tool Identification</link> section explains exactly how the Rexx object
combination is used to specify the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::getToolInfo() -->
<section id="mthHasCurrentTool" xreflabel="hasCurrentTool"><title>hasCurrentTool</title>
<indexterm><primary>hasCurrentTool</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>hasCurrentTool</secondary></indexterm>
<programlisting>
<![CDATA[
>>--hasCurrentTool-------------------------------><
]]>
</programlisting>
<para>
Tests if this ToolTip has a current tool.
</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>
Retunrs true if there is a current tool, false if there is not.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
In essence, this convenience method tests if the <xref linkend="mthGetCurrentToolInfo"/> method will return a
<computeroutput>ToolInof</computeroutput> object or the <computeroutput>.nil</computeroutput> object.
</para> </listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::hasCurrentTool() -->
<section id="mthHitTestClsToolTip" xreflabel="hitTest"><title>hitTest</title>
<indexterm><primary>hitTest</primary><secondary>ToolTip class</secondary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>hitTest</secondary></indexterm>
<programlisting>
<![CDATA[
Form 1:
>>--hitTest(--toolInfo--,--point--)--------------><
Form 2:
>>--hitTest(--toolInfo--,--x,--y--)--------------><
Generic form:
>>--hitTest(--toolInfo--,--ptToTest--)-----------><
]]>
</programlisting>
<para>
Tests a point to determine whether it is within the bounding rectangle of a tool within the window specified and, if it
is, retrieves information about the tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolInfo [required in / out]</term>
<listitem>
<para>
A <xref linkend="clsToolInfo"/> object whose <xref linkend="atrRexxHwnd"/> attribute specifies which tool window to test.
</para>
<para>
If the point tested is within a tool of the tool window, the retrieved tool information is returned in this object.
The tool info object should be instantiated using the <xref linkend="mthForHitTest"/> class method.
</para>
</listitem></varlistentry>
<varlistentry><term>ptToTest [required]</term>
<listitem>
<para>
The point to test. The point is specifed in client <link linkend="defScreenCoordinates">coordinates</link> of the
window specified by the <emphasis role="italic">toolInfo</emphasis> argument.
</para>
<para>
As indicated by the syntax diagram, the point to test can be specified in two ways. Either as one argument, a <xref
linkend="clsPoint"/> object, or as two arguments, the x coordinate of the point followed by the y coordinate of the
point.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
True if the point being tested is within the window specified, otherwise false.
</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 gets the current cursor position and then hit tests that position for a push button tool:
<programlisting>
<![CDATA[
mouse = .Mouse~new(self)
pos = mouse~getCursorPos
pbTest~screen2client(pos)
hitTool = .ToolInfo~forHitTest(pbTest)
say 'Using' pos
if ttTest~hitTest(hitTool, pos) then do
say 'Got hit'
say 'Tool info hwnd: ' hitTool~rexxHwnd
say 'Tool info id: ' hitTool~rexxID
say 'Tool info text: ' hitTool~text
say 'Tool info flags: ' hitTool~flags
say 'Tool info rect: ' hitTool~rect
say 'Tool info userData:' hitTool~userData
say 'Tool info resource:' hitTool~resource
say
end
else do
say 'NO hit'
say 'Tool info hwnd: ' hitTool~rexxHwnd
end
/* Output could be for instantce:
Got hit
Tool info hwnd: a SimpleDialog
Tool info id: a Button
Tool info text: Press Test to execute the regression suite
Tool info flags: IDISHWND SUBCLASS
Tool info rect: a Rect (0, 0, 0, 0)
Tool info userData: The NIL object
Tool info resource: The NIL object
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::hitTest() -->
<section id="mthManageAtypicalTool" xreflabel="manageAtypicalTool"><title>manageAtypicalTool</title>
<indexterm><primary>manageAtypicalTool</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>manageAtypicalTool</secondary></indexterm>
<programlisting>
<![CDATA[
>>--manageAtypicalTool(--toolObj--+-----------+--+-----------+--)--------------><
+-,-events--+ +-,-methods-+
]]>
</programlisting>
<para>
Initiates the management of a ToolTip tool that is a dialog control. This is for a tool that is not the typical tool used
in ooDialog. See the remarks section for details.
</para>
<para>
The <emphasis role="italic">manageAtypicalTool</emphasis> initiates a process that monitors every window <link
linkend="ovvWindowMessages">message</link> sent to the <emphasis role="italic">toolObj</emphasis>, (which is a dialog
control.) This allows the process to relay all mouse messages to the tool and to intercept all event notifications sent by
the ToolTip to the <emphasis role="italic">toolObj</emphasis>. Why this is necessary is explained in more detail in the
remarks section.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolObj [required]</term>
<listitem>
<para>
The tool dialog control to be managed.
</para>
</listitem></varlistentry>
<varlistentry><term>events [optional]</term>
<listitem>
<para>
An array of keywords for the ToolTip events that should invoke a method in the Rexx dialog. The array can not be
sparse. Each index in the array should contain the keyword for a ToolTip event. If an event keyword is present at an
index, then that event is connected to a method in the Rexx dialog. Case is not significant in the keywords. The
valid keywords are:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>RELAY </member>
<member>NEEDTEXT </member>
<member>SHOW </member>
<member>POP </member>
<member>LINKCLICK</member>
<member>NORELAY </member>
</simplelist>
<variablelist>
<varlistentry><term>RELAY</term>
<listitem>
<para>
Causes the monitoring process to invoke the connected method in the Rexx dialog for every mouse message sent to
the dialog control. The method is invoked <emphasis role="italic">before</emphasis> the monitoring process relays
the message to the ToolTip. By default the method invoked for this keyword is <emphasis
role="italic">onRelay</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>NEEDTEXT</term>
<listitem>
<para>
Causes the monitoring process to intercept the <xref linkend="kywToolTipNEEDTEXT"/> event notification sent to
the dialog control, and invoke the connected method in the Rexx dialog. The notifcation is prevented from going
to the dialog control. By default the method invoked for this keyword is <emphasis
role="italic">onNeedText</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>SHOW</term>
<listitem>
<para>
Causes the monitoring process to intercept the <xref linkend="kywToolTipSHOW"/> event notification sent to the
dialog control, and invoke the connected method in the Rexx dialog. The notifcation is prevented from going to
the dialog control. By default the method invoked for this keyword is <emphasis role="italic">onShow</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>POP</term>
<listitem>
<para>
Causes the monitoring process to intercept the <xref linkend="kywToolTipPOP"/> event notification sent to the
dialog control and invoke the connected method in the Rexx dialog. The notifcation is prevented from going to
the dialog control. By default the method invoked for this keyword is <emphasis
role="italic">onPop</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>LINKCLICK</term>
<listitem>
<para>
Causes the monitoring process to intercept the <xref linkend="kywToolTipLINKCLICK"/> event notification sent to
the dialog control and invoke the connected method in the Rexx dialog. The notifcation is prevented from going to
the dialog control. By default the method invoked for this keyword is <emphasis
role="italic">onLinkClick</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term>NORELAY</term>
<listitem>
<para>
Prevents the monitoring process from automatically forwarding the mouse messages to the ToolTip. There is no
method connection associated with this keyword.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>methods [optional]</term>
<listitem>
<para>
An array of alternative method names for each connected event. If the default method name is not suitable, for whatever
reason, then the programmer can supply her own name in the <emphasis role="italic">methods</emphasis> array. The
alternative method name must be at the same index in the <emphasis role="italic">methods</emphasis> array as the
event keyword's index in the <emphasis role="italic">events</emphasis> array.
</para>
<para>
E.g., if the keyword SHOW is present at index 2 in the <emphasis role="italic">events</emphasis> array and the
programmer wants to over-ride the default method name of <emphasis role="italic">onShow</emphasis>, then this can be
done by putting the alternative method name at index 2 in the <emphasis role="italic">methods</emphasis> array. There
is no requirement to put any name at index 1. That is, the <emphasis role="italic">methods</emphasis> array can be
sparse.
</para>
</listitem></varlistentry>
</variablelist>
</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 ooDialog framework provides the <emphasis role="italic">manageAtypicalTool</emphasis> method to allow more advanced
usage of ToolTips. For a ToolTip to work properly, it needs two things. One, it needs to be aware of every mouse message
sent to the window that is the tool. Two, it needs to send event notifications to the owner window of the tool.
</para>
<para>
In the typical use case in ooDialog, the window that the ToolTip sends the notifications to is the dialog, (where they
are handled by the Rexx dialog through the event connections.) When the SUBCLASS flag is used for the tool, the ToolTip
sets up its own internal process to monitor all the mouse messages sent to the tool window. In this typical use case,
there is no need for the <emphasis role="italic">manageAtypicalTool</emphasis> method.
</para>
<para>
However there are two basic situations that are not the typical use case. The first is when the SUBCLASS flag can not be
used. In this situation there needs to be some way to <emphasis role="italic">relay</emphasis> the mouse messages to the
ToolTip. The problem with mouse messages is that they are sent to the window the mouse is over. If the mouse messages are
sent to the dialog window, ooDialog would have no problem. It could intercept the mouse messages through event
connections and then relay the message to the ToolTip. However, when the mouse is over a dialog control, the dialog
window has no knowledge of the mouse messages.
</para>
<para>
The other situation is when the dialog window is not sent the ToolTip event notifications. If the event notifications are
sent to a dialog control, then there is no way to handle the events through connected methods in the Rexx dialog. Both of
these situations can arise when more advanced usage of ToolTips is tried. A common reason why the SUBCLASS flag can not
be used is because the application needs to take some action <emphasis role="italic">before</emphasis> the ToolTip is
aware of the mouse message. A common reason why the ToolTip event notifications can not be sent to the dialog window is
that the ToolTip was created by and is owned by a dialog control.
</para>
<para>
There are two example programs provided with the ooDialog distribution that explore the use of the <emphasis
role="italic">manageAtypicalTool</emphasis> method in these two situations. They are in the
<computeroutput>samples\controls\ToolTip</computeroutput> subdirectories. One program is the
<computeroutput>manageControlTool.rex</computeroutput> example. The other is the
<computeroutput>customPositionToolTip.rex</computeroutput> example.
</para>
<para>
Note that when the <emphasis role="italic">manageAtypicalTool</emphasis> method starts the monitoring process, it
<emphasis role="italic">always</emphasis> forwards all mouse messages to the ToolTip, even if both optional arugments are
ommitted. This is not always desirable. To prevent this, use the NORELAY keyword.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later.
</para>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example sets up a customized ToolTip for a tree-view control. The <emphasis
role="italic">manageAtypicalTool</emphasis> method is used because the customization requires that the application takes
action before the mouse move messages are seen by the ToolTip. The RELAY keyword invokes the <emphasis
role="italic">onRelay</emphasis> method in the dialog for every mouse move message. The application examines the mouse
messages and determines what action to take. When the method returns, the mouse messages are relayed to the ToolTip.
</para>
<para>
Note that the third optional argument is an array with no values at index 1 and index 2. The <emphasis
role="italic">onShowToolTip</emphasis> value at index 3 is the altenative method name to invoke for the SHOW event:
<programlisting>
<![CDATA[
tv = self~newTreeView(IDC_TREE)
rect = tv~clientRect
tt = self~createToolTip(IDC_TT)
toolInfo = .ToolInfo~new(tv, 10, '', 'TRANSPARENT', rect)
tt~addToolEx(toolInfo)
...
tt~manageAtypicalTool(tv, .array~of('RELAY', 'NEEDTEXT', 'SHOW'), .array~of( , , 'onShowToolTp'))
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::manageAtypicalTool() -->
<section id="mthNewToolRect" xreflabel="newToolRect"><title>newToolRect</title>
<indexterm><primary>newToolRect</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>newToolRect</secondary></indexterm>
<programlisting>
<![CDATA[
>>--newToolRect(--rect-,-toolHwnd--+----------+--)--------------><
+-,-toolID-+
]]>
</programlisting>
<para>
Sets a new bounding rectangle for a tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>rect [required]</term>
<listitem>
<para>
A <xref linkend="clsRect"/> object that specifies the new bounding rectangle of the tool.
</para>
</listitem></varlistentry>
<varlistentry><term>toolHwnd [required]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term>toolID [optional]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <link linkend="sctToolIdentification">Tool Identification</link> section explains exactly how the Rexx object
combination is used to specify the tool the new bounding rectangle is assigned to.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::newToolRect() -->
<section id="mthPop" xreflabel="pop"><title>pop</title>
<indexterm><primary>pop</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>pop</secondary></indexterm>
<programlisting>
<![CDATA[
>>--pop------------------------------------------><
]]>
</programlisting>
<para>
Removes, hides, this ToolTip's display window.
</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 0, always.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::pop() -->
<section id="mthPopUp" xreflabel="popUp"><title>popUp</title>
<indexterm><primary>popUp</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>popUp</secondary></indexterm>
<programlisting>
<![CDATA[
>>--popUp----------------------------------------><
]]>
</programlisting>
<para>
Causes this ToolTip to display at the coordinates of the last mouse message.
</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 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later.
</para>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::popUp() -->
<section id="mthSetDelayTime" xreflabel="setDelayTime"><title>setDelayTime</title>
<indexterm><primary>setDelayTime</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setDelayTime</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setDelayTime(--+---------+--+---------+--)---><
+--which--+ +-,-time--+
]]>
</programlisting>
<para>
Sets the initial, pop-up, and reshow durations for this ToolTip control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>which [optional]</term>
<listitem>
<para>
Exactly one of the following keywords, case is not significant. This specifies which of the 3, or all of the 3,
possible delay times to set. The default if omitted is AUTOMATIC:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>AUTOPOP </member>
<member>INITIAL </member>
<member>RESHOW </member>
<member>AUTOMATIC</member>
</simplelist>
<variablelist>
<varlistentry><term>AUTOPOP</term>
<listitem>
<para>
The amount of time the ToolTip window remains visible if the pointer is stationary within a tool's bounding
rectangle.
</para>
</listitem></varlistentry>
<varlistentry><term>INITIAL</term>
<listitem>
<para>
The amount of time the pointer must remain stationary within a tool's bounding rectangle before the ToolTip
window appears.
</para>
</listitem></varlistentry>
<varlistentry><term>RESHOW</term>
<listitem>
<para>
The amount of time it takes for subsequent ToolTip windows to appear as the pointer moves from one tool to
another.
</para>
</listitem></varlistentry>
<varlistentry><term>AUTOMATIC</term>
<listitem>
<para>
Sets all 3 delaty times to their default propotions. The autopop time will be ten times the initial time and the
reshow time will be one fifth the initial time. When using this keyword, use a positive value for <emphasis
role="italic">time</emphasis> to specify the initial time, in milliseconds. Use a negative <emphasis
role="italic">time</emphasis> to return all three delay times to their default values. This is the default if the
<emphasis role="italic">which</emphasis> argument is omitted.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>time [optional]</term>
<listitem>
<para>
The time, in milliseconds to set the specified delay time to. A negative time sets the specified time back to its
default value. If this argument is omitted, the default is -1.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::setDelayTime() -->
<section id="mthSetMargin" xreflabel="setMargin"><title>setMargin</title>
<indexterm><primary>setMargin</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setMargin</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setMargin(--margins--)-----------------------><
]]>
</programlisting>
<para>
Sets the top, left, bottom, and right margins for a ToolTip window. A margin is the distance, in pixels, between the
ToolTip window border and the text contained within the ToolTip window.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>margins [required]</term>
<listitem>
<para>
A <xref linkend="clsRect"/> object that specifies the margins.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The attributes of the returned rectangle do not define a bounding rectangle. For the purpose of this method, the
attributes are interpreted as follows:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">top:</emphasis></term>
<listitem>
<para>
Distance between top border and top of ToolTip text, in pixels.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">left:</emphasis></term>
<listitem>
<para>
Distance between left border and left end of ToolTip text, in pixels.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">bottom:</emphasis></term>
<listitem>
<para>
Distance between bottom border and bottom of ToolTip text, in pixels.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">right:</emphasis></term>
<listitem>
<para>
Distance between right border and right end of ToolTip text, in pixels.
</para>
</listitem></varlistentry>
</variablelist>
</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 sets the margins for a ToolTip to 2 pixels on the sides and 4 pixels on the top and bottom:
<programlisting>
<![CDATA[
margins = .Rect~new(2, 4, 2, 4)
toolTip~setMargins(margins)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::setMargin() -->
<section id="mthSetMaxTipWidth" xreflabel="setMaxTipWidth"><title>setMaxTipWidth</title>
<indexterm><primary>setMaxTipWidth</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setMaxTipWidth</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setMaxTipWidth(--max--)---------------------------------------------><
]]>
</programlisting>
<para>
Sets the maximum width, in pixels, for this ToolTip window.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>max [required]</term>
<listitem>
<para>
The maximum width for the ToolTip, or -1 to allow any width.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the previous maximum width for this ToolTip.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The maximum width value does not indicate a ToolTip window's actual width. Rather, if a ToolTip string exceeds the
maximum width, the control breaks the text into multiple lines, using spaces to determine line breaks. If the text
cannot be segmented into multiple lines, it is displayed on a single line, which may exceed the maximum ToolTip width.
</para>
<para>
For instance, if the maximum width is set to 20 and there is a word within the text that is longer than 20, the word is
not broken in two. It is displayed on a single line, causing that line to be longer than 20.
</para>
<para>
The text can contain embedded new line characters and the ToolTip will break the text at the new line indicator.
</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 creates a tool for a push button with a relatively long string for the tool's text. It then gets the size
for a portion of the text in pixels and sets the max tip width to the width of the portion. This causes the ToolTip to
create a multi-line display window:
<programlisting>
<![CDATA[
tt = self~createToolTip(IDC_TT_MAIN)
text = "Push the 'Test' button to run the current regression test for ooRexx..."
tt~addTool(self~newPushButton(IDC_PB_TEST), text)
s = self~getTextSizePX("Push the 'Test' button")
tt~setMaxTipWidth(s~width)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::setMaxTipWidth() -->
<section id="mthSetTipBkColor" xreflabel="setTipBkColor"><title>setTipBkColor</title>
<indexterm><primary>setTipBkColor</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setTipBkColor</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setTipBkColor(--color--)---------------------><
]]>
</programlisting>
<para>
Sets the background color for this ToolTip window.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>color [required]</term>
<listitem>
<para>
The new color for the background of the ToolTip window. The color is expressed as a <xref linkend="defColorRef"/>
value.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method is included for completeness. As is the case for most dialog controls that have set color methods, the dialog
control ignores a color change if visual themes are in effect. Most systems on XP and later have visual themes on by
default.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::setTipBkColor() -->
<section id="mthSetTipTextColor" xreflabel="setTipTextColor"><title>setTipTextColor</title>
<indexterm><primary>setTipTextColor</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setTipTextColor</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setTipTextColor(--color--)---------------------------------------------><
]]>
</programlisting>
<para>
Sets the text color for this ToolTip window.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>color [required]</term>
<listitem>
<para>
The new color for the text of the ToolTip window. The color is expressed as a <xref linkend="defColorRef"/> value.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method is included for completeness. As is the case for most dialog controls that have set color methods, the dialog
control ignores a color change if visual themes are in effect. Most systems on XP and later have visual themes on by
default.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::setTipTextColor() -->
<section id="mthSetTitleClsToolTip" xreflabel="setTitle"><title>setTitle</title>
<indexterm><primary>setTitle</primary><secondary>ToolTip class</secondary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setTitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setTitle(--title--+---------+--)-------------><
+-,-icon--+
]]>
</programlisting>
<para>
Adds a title string and optionally an icon image to this ToolTip.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>title [required]</term>
<listitem>
<para>
The title for this ToolTip.
</para>
</listitem></varlistentry>
<varlistentry><term>icon [optional]</term>
<listitem>
<para>
Either an icon <xref linkend="clsImage"/> object, or one of the following keywords to use a system icon. Case is not
significant in the keywords. The default if the keyword is omitted is NONE:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>NONE</member>
<member>ERROR</member>
<member>ERRORLARGE</member>
<member>INFO</member>
<member>INFOLARGE</member>
<member>WARNING</member>
<member>WARNINGLARGE</member>
</simplelist>
<variablelist>
<varlistentry><term>NONE</term>
<listitem>
<para>
No icon.
</para>
</listitem></varlistentry>
<varlistentry><term>ERROR</term>
<listitem>
<para>
Error icon.
</para>
</listitem></varlistentry>
<varlistentry><term>ERRORLARGE</term>
<listitem>
<para>
Large warning icon.
</para>
</listitem></varlistentry>
<varlistentry><term>INFO</term>
<listitem>
<para>
Info icon.
</para>
</listitem></varlistentry>
<varlistentry><term>INFOLARGE</term>
<listitem>
<para>
Large info icon.
</para>
</listitem></varlistentry>
<varlistentry><term>WARNING</term>
<listitem>
<para>
Warning icon.
</para>
</listitem></varlistentry>
<varlistentry><term>WARNINGLARGE</term>
<listitem>
<para>
Large warning icon.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</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 <emphasis role="italic">title</emphasis> string can not be longer than 99 characters. If an <xref
linkend="clsImage"/> object is used, the image must actually be an icon. The operating system will not display a bitmap
when an icon is called for.
</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 creates a balloon ToolTip with a title and an icon;
<programlisting>
<![CDATA[
icon = .Image~getImage("musicNote.ico", .Image~toID(IMAGE_ICON), .size~new(16, 16))
tt = self~createToolTip(IDC_TT_BALLOON, 'BALLOON CLOSE')
tt~setTitle("Important Message", icon)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::setTitle() -->
<section id="mthSetToolInfo" xreflabel="setToolInfo"><title>setToolInfo</title>
<indexterm><primary>setToolInfo</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setToolInfo</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setToolInfo(--toolInfo--)--------------------><
]]>
</programlisting>
<para>
Sets the information that this ToolTip control maintains for a tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>toolInfo [required]</term>
<listitem>
<para>
A <xref linkend="clsToolInfo"/> object whose attributes specify the information this ToolTip should use for a tool.
See the remarks.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Some internal properties of a tool are established when the tool is created, and are not recomputed by the ToolTip when
the <emphasis role="italic">setToolInfo</emphasis> method is invoked. If a <computeroutput>ToolInfo</computeroutput>
object is simply instantiated, its attributes assigned values, and is then passed to the ToolTip control through the
<emphasis role="italic">setToolInfo</emphasis> method, these properties may be lost.
</para>
<para>
Instead, the programmer should first request the tool's current <computeroutput>ToolIno</computeroutput> object by using
the <xref linkend="mthGetToolInfo"/> method. Then, modify the attributes of this object as needed and pass it back to
the ToolTip control using the <emphasis role="italic">setToolInfo</emphasis> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example modifies the text, bounding rectangle, and flags of a tool:
<programlisting>
<![CDATA[
toolInfo = ttEsc~getToolInfo(self~newPushButton(IDCANCEL))
toolInfo~text = "Only push the cancel button if you want, or need, to end the dialog"
toolInfo~rect = .Rect~new(3, 2, 44, 11)
toolInfo~flags = toolInfo~flags 'CENTERTIP'
ttEsc~setToolInfo(toolInfo)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::setToolInfo() -->
<section id="mthSetWindowTheme" xreflabel="setWindowTheme"><title>setWindowTheme</title>
<indexterm><primary>setWindowTheme</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setWindowTheme</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setWindowTheme(--style--)--------------------><
]]>
</programlisting>
<para>
Sets the visual style of a ToolTip control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>style [required]</term>
<listitem>
<para>
A string specifying the visual style.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method is included for completeness. The Windows <xref linkend="defWindowsDoc"/> is very sparse on this topic. It
simply says a string specifying the style, but doesn't say what styles are available. Currently, the ooDialog developers
are not certain what string to use to get this method to work.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later.
</para>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::setWindowTheme() -->
<section id="mthTrackActivate" xreflabel="trackActivate"><title>trackActivate</title>
<indexterm><primary>trackActivate</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>trackActivate</secondary></indexterm>
<programlisting>
<![CDATA[
>>--trackActivate(--toolHwnd--+----------+--+-------------+--)--><
+-,-toolID-+ +-,-activate--+
]]>
</programlisting>
<para>
Activates or deactivates a tracking ToolTip.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolHwnd [required]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term>toolID [optional]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted.
</para>
</listitem></varlistentry>
<varlistentry><term>activate</term>
<listitem>
<para>
Must be true or false, use true to activate the ToolTip, false to deactivate it. If omitted, the default is true.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <link linkend="sctToolIdentification">Tool Identification</link> section explains exactly how the Rexx object
combination is used to specify the tool to be deleted.
</para>
<para>
Tracking ToolTips must be manually activated and deactivated by using the <emphasis
role="italic">trackActivate</emphasis> method. Activation or deactivation also shows or hides the ToolTip, respectively.
</para>
<para>
While a tracking ToolTip is active, the application must specify the location of the ToolTip by invoking the
<xref linkend="mthTrackPosition"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::trackActivate() -->
<section id="mthTrackPosition" xreflabel="trackPosition"><title>trackPosition</title>
<indexterm><primary>trackPosition</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>trackPosition</secondary></indexterm>
<programlisting>
<![CDATA[
Form 1:
>>--trackPosition(--point--)---------------------><
Form 2:
>>--trackPosition(--x,--y--)---------------------><
Generic form:
>>--trackPosition(--pt--)------------------------><
]]>
</programlisting>
<para>
Sets the position of a tracking ToolTip.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>pt [required]</term>
<listitem>
<para>
The (x, y) coordinates of the position to set. As the syntax diagram indicates, the coordinates can be specified
either as a single <xref linkend="clsPoint"/> object, or as two arguments, a separate x and a y coordinate.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Tracking ToolTips change position on the screen dynamically. While a tracking ToolTip is active, the application must
specify the location of the ToolTip by invoking the <emphasis role="italic">trackPosition</emphasis> method.
</para>
<para>
The ToolTip control chooses where to display the ToolTip window based on the coordinates provided through the <emphasis
role="italic">trackPosition</emphasis> method. This causes the ToolTip window to appear beside the tool to which it
corresponds. To have ToolTip windows displayed at specific coordinates, include the ABSOLUTE keyword in the <emphasis
role="italic">flags</emphasis> argument when adding the tool through the <xref linkend="mthAddTool"/>, <xref
linkend="mthAddToolEx"/>, or <xref linkend="mthAddToolRect"/> methods.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::trackPosition() -->
<section id="mthUpdateClsToolTip" xreflabel="update"><title>update</title>
<indexterm><primary>update</primary><secondary>ToolTip class</secondary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>update</secondary></indexterm>
<programlisting>
<![CDATA[
>>--update---------------------------------------><
]]>
</programlisting>
<para>
Forces the current tool to be redrawn.
</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 0, always.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::update() -->
<section id="mthUpdateTipText" xreflabel="updateTipText"><title>updateTipText</title>
<indexterm><primary>updateTipText</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>updateTipText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--updateTipText(--toolInfo--)------------------><
]]>
</programlisting>
<para>
Sets the ToolTip text for a tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolInfo [required]</term>
<listitem>
<para>
A <xref linkend="clsToolInfo"/> object that specifies the tool and the text for the update.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The best way to use this method is to instantiate a new <computeroutput>ToolInfo</computeroutput> object through the
<xref linkend="mthForID"/> method and then set the <emphasis role="italic">text</emphasis> attribute of the object
to the new text desired.
</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 updates the text for a tool:
<programlisting>
<![CDATA[
toolInfo = .ToolInfo~forID(self~newPushButton(IDCANCEL))
toolInfo~text = "Only push the cancel button if you want, or need, to end the dialog"
toolTip~updateTipText(toolInfo)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolTip::updateTipText() -->
<section id="clsToolInfo" xreflabel="ToolInfo"><title>ToolInfo Class</title>
<indexterm><primary>ToolInfo class</primary></indexterm>
<para>
A <emphasis role="italic">ToolInfo</emphasis> object contains information about a tool in a <xref linkend="clsToolTip"/>
control. The attributes of the <computeroutput>ToolInfo</computeroutput> object reflect the information that defines a
specific tool in the ToolTip control.
</para>
<para>
<emphasis role="italic">ToolInfo</emphasis> objects are used in some of the methods of the
<computeroutput>ToolTip</computeroutput> class to provide information to the ToolTip control, and / or, to receive
information from the ToolTip control.
</para>
<section id="sctMethodsToolInfo"><title>Method Table</title>
<para>
The following table lists the class and instance methods of the <computeroutput>ToolInfo</computeroutput> class:
<table id="tblMethodsToolInfo" frame="all"> <title>ToolInfo Class Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
</row>
<row>
<entry><link linkend="mthForHitTest">forHitTest</link></entry>
<entry>Returns a new <computeroutput>ToolInfo</computeroutput> object to be used in the <xref linkend="mthHitTestClsToolTip"/> method.</entry>
</row>
<row>
<entry><link linkend="mthForID">forID</link></entry>
<entry>Returns a new <computeroutput>ToolInfo</computeroutput> object to be used for tool <link linkend="sctToolIdentification">indentification.</link></entry>
</row>
<row>
<entry><link linkend="mthNewClsToolInfo">new</link></entry>
<entry>Instantiates a new <computeroutput>ToolInfo</computeroutput> object.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
<entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry>
</row>
<row>
<entry><link linkend="atrFlags">flags</link></entry>
<entry>Reflects the flags that define the style and options of the tool.</entry>
</row>
<row>
<entry><link linkend="atrRect">rect</link></entry>
<entry>Reflects the bounding rectangle coordinates of the tool when the tool is an application-defined rectangular area within a window's client area.</entry>
</row>
<row>
<entry><link linkend="atrResource">resource</link></entry>
<entry>Reserved for future enhancement.</entry>
</row>
<row>
<entry><link linkend="atrRexxHwnd">rexxHwnd</link></entry>
<entry>Reflects the Rexx object from which the first part of the 2-part system <link linkend="sctToolIdentification">identification</link> for a tool is derived.</entry>
</row>
<row>
<entry><link linkend="atrRexxID">rexxID</link></entry>
<entry>Reflects the Rexx object from which the second part of the 2-part system <link linkend="sctToolIdentification">identification</link> for a tool is derived.</entry>
</row>
<row>
<entry><link linkend="atrText">text</link></entry>
<entry>Reflects the text set for the tool.</entry>
</row>
<row>
<entry><link linkend="atrUserDataClsToolTip">userData</link></entry>
<entry>Reflects the application-defined user data value for the tool.</entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="mthForHitTest" xreflabel="forHitTest"><title>forHitTest (Class Method)</title>
<indexterm><primary>forHitTest</primary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>forHitTest</secondary></indexterm>
<programlisting>
<![CDATA[
>>--forHitTest(--hwndObj--)----------------------><
]]>
</programlisting>
<para>
Returns a new <computeroutput>ToolInfo</computeroutput> object to be used in the <xref linkend="mthHitTestClsToolTip"/>
method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>hwndObj [required]</term>
<listitem>
<para>
The Rexx tool or Rexx object that contains a tool that is going to be hit tested. For example, if the tool to be
tested is a rectangular area, <emphasis role="italic">hwndObj</emphasis> should be the Rexx object that represents
the window containing the rectangle. If the tool is a dialog control, then <emphasis role="italic">hwndObj</emphasis>
should be the Rexx object that represents the dialog control.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a newly instantiated <computeroutput>ToolInfo</computeroutput> object designed to be used as the argument to the
<emphasis role="italic">hitTest</emphasis> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The new <computeroutput>ToolInfo</computeroutput> object is especially constructed to be of use in the <xref
linkend="mthHitTestClsToolTip"/> method. To be explicit, the <computeroutput>ToolInfo</computeroutput> object returned is
initialized to an empty state and the normal tool indentifiers are not set. The returned
<computeroutput>ToolInfo</computeroutput> object is not suitable to be used in any other methods that required a
<computeroutput>ToolInfo</computeroutput> object, except the <emphasis role="italic">hitTest</emphasis> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from an application that has a number of rectangular tools in a dialog. An arbitrary point is hit
tested and if the hit succeeds, the filled in tool information is printed to the screen:
<programlisting>
<![CDATA[
hitTool = .ToolInfo~forHitTest(self)
say 'Using' pos
if tt~hitTest(hitTool, pos) then do
say 'Got hit'
say 'Tool info hwnd: ' hitTool~rexxHwnd
say 'Tool info id: ' hitTool~rexxID
say 'Tool info text: ' hitTool~text
say 'Tool info flags: ' hitTool~flags
say 'Tool info rect: ' hitTool~rect
say 'Tool info userData:' hitTool~userData
say 'Tool info resource:' hitTool~resource
say
end
else do
say 'NO hit'
end
/* Output might be for instance:
Using a Point (220, 101)
Got hit
Tool info hwnd: a SimpleDialog
Tool info id: 777
Tool info text: Over main dialog, bottom right quadrant
Tool info flags: SUBCLASS TRANSPARENT
Tool info rect: a Rect (194, 101, 386, 200)
Tool info userData: The NIL object
Tool info resource: The NIL object
*/
/* Output from a miss:
Using a Point (220, 301)
NO hit
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::forHitTest() -->
<section id="mthForID" xreflabel="forID"><title>forID (Class Method)</title>
<indexterm><primary>forID</primary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>forID</secondary></indexterm>
<programlisting>
<![CDATA[
>>--forID(--toolHwnd--+----------+--)------------><
+-,-toolID-+
]]>
</programlisting>
<para>
Returns a new <computeroutput>ToolInfo</computeroutput> object to be used for tool <link
linkend="sctToolIdentification">indentification.</link>
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>toolHwnd [required]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> a tool to the operating system.
</para>
</listitem></varlistentry>
<varlistentry><term>toolID [optional]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to the operaring system.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a newly instantiated <computeroutput>ToolInfo</computeroutput> object that can be used to identify a specific
tool contained within a ToolTip.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Many of the <computeroutput>ToolTip</computeroutput> methods require that the tool the method pertains to be identified.
The <computeroutput>ToolInfo</computeroutput> object returned from <emphasis role="italic">forID</emphasis> is useful for
those method. In addition, some methods return information by filling in the attributes of a
<computeroutput>ToolInfo</computeroutput> object that specifies a tool. This is another good use of the <emphasis
role="italic">forID</emphasis> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example instantiates a new <computeroutput>ToolInfo</computeroutput> object using the <emphasis
role="italic">forID</emphasis> method and then uses the object to change the ToolTip text for a push button tool:
<programlisting>
<![CDATA[
toolInfo = .ToolInfo~forID(self~newPushButton(IDC_PB_TEST))
toolInfo~text = "Push the 'Test' button when you are ready to begin the test suite for the final release."
toolTip~setMaxTipWidth(140)
toolTip~updateTipText(toolInfo)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::forID() -->
<section id="mthNewClsToolInfo"><title>new (Class Method)</title>
<indexterm><primary>new</primary><secondary>ToolInfo class</secondary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>new</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(-toolHwnd-+----------+-+-------+-+--------+-+-----+-+---------+-+-------+-)--><
+-,-toolID-+ +-,-txt-+ +-,-flgs-+ +-,-r-+ +-,-uData-+ +-,-rsv-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>ToolInfo</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>toolHwnd [required]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> a tool to the operating system.
</para>
</listitem></varlistentry>
<varlistentry><term>toolID [optional]</term>
<listitem>
<para>
The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx
object combination that <link linkend="sctToolIdentification">identify</link> the tool to the operaring system.
</para>
</listitem></varlistentry>
<varlistentry><term>txt [optional]</term>
<listitem>
<para>
Text for the tool. If omitted, or the empty string, or the string: TEXTCALLBACK, then the ToolTip sends the <xref
linkend="kywToolTipNEEDTEXT"/> notification and the program supplies the text.
</para>
<para>
The length of the text must be less than 1024 characters, which includes any possible end of line (0x0D0A) sequences.
</para>
</listitem></varlistentry>
<varlistentry><term>flags [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>ABSOLUTE </member>
<member>CENTERTIP </member>
<member>IDISHWND </member>
<member>PARSELINKS </member>
<member>RTLREADING </member>
<member>SUBCLASS </member>
<member>TRACK </member>
<member>TRANSPARENT</member>
</simplelist>
<variablelist>
<varlistentry><term>ABSOLUTE</term>
<listitem>
<para>
Positions the ToolTip window at the exact same coordinates specified by the <xref linkend="mthTrackPosition"/>
method. Without this flag the ToolTip control chooses where to display the ToolTip window based on the
coordinates specified, which places the ToolTip close to the tool. This flag must be used with the TRACK flag.
</para>
</listitem></varlistentry>
<varlistentry><term>CENTERTIP</term>
<listitem>
<para>
Centers the ToolTip window below the tool.
</para>
</listitem></varlistentry>
<varlistentry><term>IDISHWND</term>
<listitem>
<para>
Indicates that the ID part of the tool <link linkend="sctToolIdentification">identification</link> is the window
handle to the tool. In general, the ooDialog framework will set this flag correctly by using knowledge it gains
from parsing the <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis>
arguments. If the flag is required, the framework will set it, if the flag should not be used, the framework will
remove it if it is set.
</para>
</listitem></varlistentry>
<varlistentry><term>PARSELINKS</term>
<listitem>
<para>
Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later.
</para>
<para>
Indicates that links in the ToolTip text should be parsed.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Indicates that the ToolTip text will be displayed in the opposite direction to the text in the parent window.
</para>
</listitem></varlistentry>
<varlistentry><term>SUBCLASS</term>
<listitem>
<para>
Indicates that the ToolTip control should subclass the tool's window to intercept messages, such as WM_MOUSEMOVE.
If this flag is not set, some means must be used so that the mouse messages are forwarded to the ToolTip control,
for instance by using the <xref linkend="mthManageAtypicalTool"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term>TRACK</term>
<listitem>
<para>
Positions the ToolTip window next to the tool to which it corresponds and moves the window according to
coordinates supplied by the <xref linkend="mthTrackPosition"/> method. The programmer must activate this
type of tool using the <xref linkend="mthTrackActivate"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term>TRANSPARENT</term>
<listitem>
<para>
Causes the ToolTip control to forward mouse event messages to the parent window. This is limited to mouse events
that occur within the bounds of the ToolTip window.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>r [optional]</term>
<listitem>
<para>
A <xref linkend="clsRect"/> object that specifies the bounding rectangle coordinates of the tool. The coordinates are
in client <link linkend="defScreenCoordinates">coordinates</link> of the tool.
</para>
</listitem></varlistentry>
<varlistentry><term>uData [optional]</term>
<listitem>
<para>
A user data value to be associated with the tool. This can be any Rexx object the programmer wants. Note that the
value is associated with the tool, not the tool tip.
</para>
</listitem></varlistentry>
<varlistentry><term>rsv [optional]</term>
<listitem>
<para>
Reserved for future enhancement. This argument is completely ignrored in the current implmentation of ooDialog. Future
versions may be enhance to use this argument to specify a <xref linkend="clsResourceImage"/> object containing binary
resources for the tool.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a newly instantiated <computeroutput>ToolInfo</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Except for the IDISHWND flag, the returned <computeroutput>ToolInfo</computeroutput> object is constructed exactly as the
programmer specifies. This makes the object ideal for use in the <xref linkend="mthAddToolEx"/> method for those cases
where the convenience <xref linkend="mthAddTool"/> and <xref linkend="mthAddToolRect"/> methods are not suitable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example uses the <emphasis role="italic">new</emphasis> method to instantiate a
<computeroutput>ToolInfo</computeroutput> object for an implementation of custom ToolTips for a <xref
linkend="clsTreeView"/>:
<programlisting>
<![CDATA[
tv = self~newTreeView(IDC_TREE)
ret = tv~setItemHeight(20)
tt = self~createToolTip(IDC_TT)
rect = tv~clientRect
toolInfo = .ToolInfo~new(tv, ID_TOOL_TV, '', 'TRANSPARENT', rect, helperObj)
tt~addToolEx(toolInfo)
tt~setMaxTipWidth(250)
self~populateTree(tv)
tt~manageAtypicalTool(tv, .array~of('RELAY', 'NEEDTEXT', 'SHOW'))
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::new() -->
<section id="atrFlags" xreflabel="flags"><title>flags (Attribute)</title>
<indexterm><primary>flags</primary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>flags</secondary></indexterm>
<programlisting>
<![CDATA[
>>--flags-----------------------------------------------------><
>>--flags = varName-------------------------------------------><
]]>
</programlisting>
<para>
Reflects the flags that define the style and options of the tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">flags get:</emphasis></term>
<listitem>
<para>
Returns a string of 0 or more keywords separated by a single space that specify the flags set for this tool. If no flags
are set, the empty string is returned. See the remarks for the keyword values and meanings.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">flags set:</emphasis></term>
<listitem>
<para>
Sets the flags for this tool to those specified by a string of 0 or more space separated keywords. Case is not
significant. See the remarks for the possible keywords and their meaning.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The following keywords specify the individual flags that define the style and options for a ToolTip tool. The keywords
are case insensitive.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>ABSOLUTE </member>
<member>CENTERTIP </member>
<member>IDISHWND </member>
<member>PARSELINKS </member>
<member>RTLREADING </member>
<member>SUBCLASS </member>
<member>TRACK </member>
<member>TRANSPARENT</member>
</simplelist>
<variablelist>
<varlistentry><term>ABSOLUTE</term>
<listitem>
<para>
Indicates that the ToolTip should position its window at the exact same coordinates specified by the <xref
linkend="mthTrackPosition"/> method. Without this flag the ToolTip control chooses where to display the ToolTip
window based on the coordinates specified, which places the ToolTip close to the tool. This flag must be used with
the TRACK flag.
</para>
</listitem></varlistentry>
<varlistentry><term>CENTERTIP</term>
<listitem>
<para>
Indicates that the ToolTip should centers its window below the tool.
</para>
</listitem></varlistentry>
<varlistentry><term>IDISHWND</term>
<listitem>
<para>
Indicates that the ID part of the tool <link linkend="sctToolIdentification">identification</link> is the window
handle if the tool. If the programmer sets the <emphasis role="italic">flags</emphasis> attribute, it becomes the
programmer's responsibility to set this flag correctly. Failure to do so will result in unpredictable behaviour.
</para>
</listitem></varlistentry>
<varlistentry><term>PARSELINKS</term>
<listitem>
<para>
Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later.
</para>
<para>
Indicates that links in the ToolTip text should be parsed.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Indicates that the ToolTip text will be displayed in the opposite direction to the text in the parent window.
</para>
</listitem></varlistentry>
<varlistentry><term>SUBCLASS</term>
<listitem>
<para>
Indicates that the ToolTip control should subclass the tool's window to intercept messages, such as WM_MOUSEMOVE.
If this flag is not set, some means must be used so that the mouse messages are forwarded to the ToolTip control.
</para>
</listitem></varlistentry>
<varlistentry><term>TRACK</term>
<listitem>
<para>
Indicates that the ToolTip should position its window next to the tool to which it corresponds and move the window
according to coordinates supplied by the <xref linkend="mthTrackPosition"/> method. The programmer must activate this
type of tool using the <xref linkend="mthTrackActivate"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term>TRANSPARENT</term>
<listitem>
<para>
Causes the ToolTip control to forward mouse event messages to the parent window. This is limited to mouse events
that occur within the bounds of the ToolTip window.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::flags() [attribute] -->
<section id="atrRect" xreflabel="rect"><title>rect (Attribute)</title>
<indexterm><primary>rect</primary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>rect</secondary></indexterm>
<programlisting>
<![CDATA[
>>--rect-----------------------------------------------------><
>>--rect = varName-------------------------------------------><
]]>
</programlisting>
<para>
Reflects the bounding rectangle coordinates of the tool when the tool is an application-defined rectangular area within a
window's client area.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">rect get:</emphasis></term>
<listitem>
<para>
Returns the bounding rectangle as a <xref linkend="clsRect"/> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">rect set:</emphasis></term>
<listitem>
<para>
Assign a <computeroutput>Rect</computeroutput> object to the <emphasis role="italic">rect</emphasis> attribute to define
the tool as a rectangular area within a window.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When the tool is not an application-defined rectangular area, the value of the <emphasis role="italic">rect</emphasis>
attribute is a <computeroutput>rect</computeroutput> object whose coordinates are all 0. When the <emphasis
role="italic">flags</emphasis> attribute includes the IDIHWND keyword, the <emphasis role="italic">rect</emphasis>
attriubte is ignored by the ToolTip.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::rect() [attribute] -->
<section id="atrResource" xreflabel="resource"><title>resource (Attribute)</title>
<indexterm><primary>resource</primary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>resource</secondary></indexterm>
<programlisting>
<![CDATA[
>>--resource-----------------------------------------------------><
>>--resource = varName-------------------------------------------><
]]>
</programlisting>
<para>
Reserved for future enhancement.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">resource get:</emphasis></term>
<listitem>
<para>
Returns the <computeroutput>.nil</computeroutput> object, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">resource set:</emphasis></term>
<listitem>
<para>
This attribute can not be set.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
If the <xref linkend="clsResourceImage"/> class is enhanced to work with string resources (a good possibility) then this
attribute will be the <computeroutput>ResourceImage</computeroutput> that contains the string resource to use for the
text of the tool.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::resource() [attribute] -->
<section id="atrRexxHwnd" xreflabel="rexxHwnd"><title>rexxHwnd (Attribute)</title>
<indexterm><primary>rexxHwnd</primary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>rexxHwnd</secondary></indexterm>
<programlisting>
<![CDATA[
>>--rexxHwnd-----------------------------------------------------><
>>--rexxHwnd = varName-------------------------------------------><
]]>
</programlisting>
<para>
Reflects the Rexx object from which the first part of the 2-part system <link
linkend="sctToolIdentification">identification</link> for a tool is derived.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">rexxHwnd get:</emphasis></term>
<listitem>
<para>
Returns the Rexx object that is used as part of the basis for the tool identification. This will always be either a
dialog object or a dialog control object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">rexxHwnd set:</emphasis></term>
<listitem>
<para>
The Rexx programmer can not set this attribute. It is set by the ooDialog framework when the
<computeroutput>ToolInfo</computeroutput> object is instantiated and can not be changed after that.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::rexxHwnd() [attribute] -->
<section id="atrRexxID" xreflabel="rexxID"><title>rexxID (Attribute)</title>
<indexterm><primary>rexxID</primary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>rexxID</secondary></indexterm>
<programlisting>
<![CDATA[
>>--rexxID-----------------------------------------------------><
>>--rexxID = varName-------------------------------------------><
]]>
</programlisting>
<para>
Reflects the Rexx object from which the second part of the 2-part system <link
linkend="sctToolIdentification">identification</link> for a tool is derived.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">rexxID get:</emphasis></term>
<listitem>
<para>
Returns the Rexx object used as the ID portion of the tool identifier. This will always be either a dialog control object
or a non-negative whole number. (Recall that in ooRexx all numbers are objects.)
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">rexxID set:</emphasis></term>
<listitem>
<para>
The Rexx programmer can not set this attribute. It is set by the ooDialog framework when the
<computeroutput>ToolInfo</computeroutput> object is instantiated and can not be changed after that
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::rexxID() [attribute] -->
<section id="atrText" xreflabel="text"><title>text (Attribute)</title>
<indexterm><primary>text</primary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>text</secondary></indexterm>
<programlisting>
<![CDATA[
>>--text-----------------------------------------------------><
>>--text = varName-------------------------------------------><
]]>
</programlisting>
<para>
Reflects the text set for the tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">text get:</emphasis></term>
<listitem>
<para>
Returns the text for the tool, the empty string if the text is not set, or the string <emphasis
role="italic">TextCallBack</emphasis> if the tool is set to use the call back feature. See the remarks for details on the
call back feature.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">text set:</emphasis></term>
<listitem>
<para>
Assign this attribute the text string the ToolTip should display in its window for this tool. To set the ToolTip to use
its call back feature, either assign the string <emphasis role="italic">TEXTCALLBACK</emphasis>, case is not significant,
or assign the empty string.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The ToolTip provides a call back feature that can be used rather than setting a static text string for the tool. With this
feature, the ToolTip sends the <xref linkend="kywToolTipNEEDTEXT"/> notification and the program supplies the text
supplies the text for the tool by responding to the notification. To use this feature, the programmer should set the
<emphasis role="italic">text</emphasis> attribute to either the string, <emphasis role="italic">TextCallBack</emphasis> ro
the empty string.
</para>
<para>
The length of the text must be less than 1024 characters, which includes any possible end of line (0x0D0A) sequences. Do
not set the <emphasis role="italic">text</emphasis> attriubte to a string longer than 1023 characters.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::text() [attribute] -->
<section id="atrUserDataClsToolTip" xreflabel="userData"><title>userData (Attribute)</title>
<indexterm><primary>userData</primary><secondary>ToolInfo class</secondary></indexterm>
<indexterm><primary>ToolInfo class</primary><secondary>userData</secondary></indexterm>
<programlisting>
<![CDATA[
>>--userData-----------------------------------------------------><
>>--userData = varName-------------------------------------------><
]]>
</programlisting>
<para>
Reflects the application-defined user data value for the tool.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">userData get:</emphasis></term>
<listitem>
<para>
Returns the user data set for the tool, or the <computeroutput>.nil</computeroutput> object is no user data has been
assiged.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">userData set:</emphasis></term>
<listitem>
<para>
The programmer can assign a user data value to the tool. This can be any Rexx object desired.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ToolInfo::userData() [attribute] -->
</section> <!-- End ToolInfo Class -->
</chapter> <!-- End ToolTip class -->