/usr/share/doc/libxmu-headers/Xmu.html is in libxmu-headers 2:1.1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Xmu and Xmuu Library API Reference</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><meta name="description" content="“Don't ask.”" /><style xmlns="" type="text/css">/*
* Copyright (c) 2011 Gaetan Nadon
* Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
/*
* Shared stylesheet for X.Org documentation translated to HTML format
* http://www.sagehill.net/docbookxsl/UsingCSS.html
* http://www.w3schools.com/css/default.asp
* https://addons.mozilla.org/en-US/firefox/addon/web-developer/developers
* https://addons.mozilla.org/en-US/firefox/addon/font-finder/
*/
/*
* The sans-serif fonts are considered more legible on a computer screen
* http://dry.sailingissues.com/linux-equivalents-verdana-arial.html
*
*/
body {
font-family: "Bitstream Vera Sans", "DejaVu Sans", Tahoma, Geneva, Arial, Sans-serif;
/* In support of using "em" font size unit, the w3c recommended method */
font-size: 100%;
}
/*
* Selection: all elements requiring mono spaced fonts.
*
* The family names attempt to match the proportionally spaced font
* family names such that the same font name is used for both.
* We'd like to use Bitstream, for example, in both proportionally and
* mono spaced font text.
*/
.command,
.errorcode,
.errorname,
.errortype,
.filename,
.funcsynopsis,
.function,
.parameter,
.programlisting,
.property,
.screen,
.structname,
.symbol,
.synopsis,
.type
{
font-family: "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Courier, "Liberation Mono", Monospace;
}
/*
* Books have a title page, a preface, some chapters and appendices,
* a glossary, an index and a bibliography, in that order.
*
* An Article has no preface and no chapters. It has sections, appendices,
* a glossary, an index and a bibliography.
*/
/*
* Selection: book main title and subtitle
*/
div.book>div.titlepage h1.title,
div.book>div.titlepage h2.subtitle {
text-align: center;
}
/*
* Selection: article main title and subtitle
*/
div.article>div.titlepage h2.title,
div.article>div.titlepage h3.subtitle,
div.article>div.sect1>div.titlepage h2.title,
div.article>div.section>div.titlepage h2.title {
text-align: center;
}
/*
* Selection: various types of authors and collaborators, individuals or corporate
*
* These authors are not always contained inside an authorgroup.
* They can be contained inside a lot of different parent types where they might
* not be centered.
* Reducing the margin at the bottom makes a visual separation between authors
* We specify here the ones on the title page, others may be added based on merit.
*/
div.titlepage .authorgroup,
div.titlepage .author,
div.titlepage .collab,
div.titlepage .corpauthor,
div.titlepage .corpcredit,
div.titlepage .editor,
div.titlepage .othercredit {
text-align: center;
margin-bottom: 0.25em;
}
/*
* Selection: the affiliation of various types of authors and collaborators,
* individuals or corporate.
*/
div.titlepage .affiliation {
text-align: center;
}
/*
* Selection: product release information (X Version 11, Release 7)
*
* The releaseinfo element can be contained inside a lot of different parent
* types where it might not be centered.
* We specify here the one on the title page, others may be added based on merit.
*/
div.titlepage p.releaseinfo {
font-weight: bold;
text-align: center;
}
/*
* Selection: publishing date
*/
div.titlepage .pubdate {
text-align: center;
}
/*
* The legal notices are displayed in smaller sized fonts
* Justification is only supported in IE and therefore not requested.
*
*/
.legalnotice {
font-size: small;
font-style: italic;
}
/*
* For documentation having multiple licenses, the copyright and legalnotice
* elements sequence cannot instantiated multiple times.
* The copyright notice and license text are therefore coded inside a legalnotice
* element. The role attribute on the paragraph is used to allow styling of the
* copyright notice text which should not be italicized.
*/
p.multiLicensing {
font-style: normal;
font-size: medium;
}
/*
* Selection: book or article main ToC title
* A paragraph is generated for the title rather than a level 2 heading.
* We do not want to select chapters sub table of contents, only the main one
*/
div.book>div.toc>p,
div.article>div.toc>p {
font-size: 1.5em;
text-align: center;
}
/*
* Selection: major sections of a book or an article
*
* Unlike books, articles do not have a titlepage element for appendix.
* Using the selector "div.titlepage h2.title" would be too general.
*/
div.book>div.preface>div.titlepage h2.title,
div.book>div.chapter>div.titlepage h2.title,
div.article>div.sect1>div.titlepage h2.title,
div.article>div.section>div.titlepage h2.title,
div.book>div.appendix>div.titlepage h2.title,
div.article>div.appendix h2.title,
div.glossary>div.titlepage h2.title,
div.index>div.titlepage h2.title,
div.bibliography>div.titlepage h2.title {
/* Add a border top over the major parts, just like printed books */
/* The Gray color is already used for the ruler over the main ToC. */
border-top-style: solid;
border-top-width: 2px;
border-top-color: Gray;
/* Put some space between the border and the title */
padding-top: 0.2em;
text-align: center;
}
/*
* A Screen is a verbatim environment for displaying text that the user might
* see on a computer terminal. It is often used to display the results of a command.
*
* http://www.css3.info/preview/rounded-border/
*/
.screen {
background: #e0ffff;
border-width: 1px;
border-style: solid;
border-color: #B0C4DE;
border-radius: 1.0em;
/* Browser's vendor properties prior to CSS 3 */
-moz-border-radius: 1.0em;
-webkit-border-radius: 1.0em;
-khtml-border-radius: 1.0em;
margin-left: 1.0em;
margin-right: 1.0em;
padding: 0.5em;
}
/*
* Emphasis program listings with a light shade of gray similar to what
* DocBook XSL guide does: http://www.sagehill.net/docbookxsl/ProgramListings.html
* Found many C API docs on the web using like shades of gray.
*/
.programlisting {
background: #F4F4F4;
border-width: 1px;
border-style: solid;
border-color: Gray;
padding: 0.5em;
}
/*
* Emphasis functions synopsis using a darker shade of gray.
* Add a border such that it stands out more.
* Set the padding so the text does not touch the border.
*/
.funcsynopsis, .synopsis {
background: #e6e6fa;
border-width: 1px;
border-style: solid;
border-color: Gray;
clear: both;
margin: 0.5em;
padding: 0.25em;
}
/*
* Selection: paragraphs inside synopsis
*
* Removes the default browser margin, let the container set the padding.
* Paragraphs are not always used in synopsis
*/
.funcsynopsis p,
.synopsis p {
margin: 0;
padding: 0;
}
/*
* Selection: variable lists, informal tables and tables
*
* Note the parameter name "variablelist.as.table" in xorg-xhtml.xsl
* A table with rows and columns is constructed inside div.variablelist
*
* Set the left margin so it is indented to the right
* Display informal tables with single line borders
*/
table {
margin-left: 0.5em;
border-collapse: collapse;
}
/*
* Selection: paragraphs inside tables
*
* Removes the default browser margin, let the container set the padding.
* Paragraphs are not always used in tables
*/
td p {
margin: 0;
padding: 0;
}
/*
* Add some space between the left and right column.
* The vertical alignment helps the reader associate a term
* with a multi-line definition.
*/
td, th {
padding-left: 1.0em;
padding-right: 1.0em;
vertical-align: top;
}
.warning {
border: 1px solid red;
background: #FFFF66;
padding-left: 0.5em;
}
</style></head><body><div class="article"><div class="titlepage"><div><div><h2 class="title"><a id="xmu"></a>Xmu and Xmuu Library API Reference</h2></div><div><p class="releaseinfo">X Version 11, Release 7.7</p></div><div><p class="copyright">Copyright © 1989 X Consortium</p></div><div><div class="legalnotice"><a id="idp34754128"></a><p>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
</p><p>
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
</p><p>
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
</p><p>
Except as contained in this notice, the name of the X Consortium shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from the X Consortium.
</p><p>
<span class="trademark"><span class="emphasis"><em>X Window System</em></span></span>™
is a trademark of The Open Group.
</p></div></div><div><div class="abstract"><p>“Don't ask.”</p></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="sect1"><a href="#Introduction">Introduction</a></span></dt><dt><span class="sect1"><a href="#Atom_Functions">Atom Functions</a></span></dt><dt><span class="sect1"><a href="#Error_Handler_Functions">Error Handler Functions</a></span></dt><dt><span class="sect1"><a href="#System_Utility_Functions">System Utility Functions</a></span></dt><dt><span class="sect1"><a href="#Window_Utility_Functions">Window Utility Functions</a></span></dt><dt><span class="sect1"><a href="#Cursor_Utility_Functions">Cursor Utility Functions</a></span></dt><dt><span class="sect1"><a href="#Graphics_Functions">Graphics Functions</a></span></dt><dt><span class="sect1"><a href="#Selection_Functions">Selection Functions</a></span></dt><dt><span class="sect1"><a href="#Type_Converter_Functions">Type Converter Functions</a></span></dt><dt><span class="sect1"><a href="#Character_Set_Functions">Character Set Functions</a></span></dt><dt><span class="sect1"><a href="#Keyboard_Event_Translation_Functions">Keyboard Event Translation Functions</a></span></dt><dt><span class="sect1"><a href="#Compound_Text_Functions">Compound Text Functions</a></span></dt><dt><span class="sect1"><a href="#CloseDisplay_Hook_Functions">CloseDisplay Hook Functions</a></span></dt><dt><span class="sect1"><a href="#Display_Queue_Functions">Display Queue Functions</a></span></dt><dt><span class="sect1"><a href="#Toolkit_Convenience_Functions">Toolkit Convenience Functions</a></span></dt><dt><span class="sect1"><a href="#Standard_Colormap_Functions">Standard Colormap Functions</a></span></dt><dt><span class="sect1"><a href="#Widget_Description_Functions">Widget Description Functions</a></span></dt><dt><span class="sect1"><a href="#Participation_in_the_Editres_Protocol">Participation in the Editres Protocol</a></span></dt><dt><span class="index"><a href="#idp38827104">Index</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Introduction"></a>Introduction</h2></div></div></div><p>
The Xmu Library is a collection of miscellaneous (some might say random)
utility functions that have been useful in building various applications
and widgets. This library is required by the Athena Widgets.
</p><p>
Starting in XFree86 4.1.0, and incorporated into X11R6.7 and later releases,
a subset of the functions that do not rely on the Athena Widgets (libXaw)
or X Toolkit Instrinsics (libXt) are provided in a second library, libXmuu.
</p><p>
Programs using either of these libraries are encouraged to determine the
correct compiler and linker options via the <strong class="userinput"><code>xmu</code></strong> or
<strong class="userinput"><code>xmuu</code></strong> module names for <span class="command"><strong>pkg-config</strong></span>,
<a id="idp35705280" class="indexterm"></a>
such as:
</p><pre class="screen">
cc -c xapplication.c `pkg-config --cflags xmu`
cc -o xapplication xapplication.o `pkg-config --libs xmu`
</pre><p>
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Atom_Functions"></a>Atom Functions</h2></div></div></div><p>
To use the functions and macros defined in this section, you should include
the header file
<<code class="filename">X11/Xmu/Atoms.h</code>>
<a id="idp32264544" class="indexterm"></a>
and link against the libXmu library.
</p><div class="funcsynopsis"><p><code class="funcdef"><strong class="fsfunc">XA_ATOM_PAIR</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_CHARACTER_POSITION</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_CLASS</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_CLIENT_WINDOW</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_CLIPBOARD</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_COMPOUND_TEXT</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_DECNET_ADDRESS</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_DELETE</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_FILENAME</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_HOSTNAME</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_IP_ADDRESS</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_LENGTH</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_LIST_LENGTH</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_NAME</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_NET_ADDRESS</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_NULL</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_OWNER_OS</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_SPAN</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_TARGETS</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_TEXT</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_TIMESTAMP</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_USER</strong>(</code><var class="pdparam">d</var><code>)</code>;</p><p><code class="funcdef"><strong class="fsfunc">XA_UTF8_STRING</strong>(</code><var class="pdparam">d</var><code>)</code>;</p></div><p>
<a id="idp32216240" class="indexterm"></a>
These macros take a display as argument and return an
<span class="type">Atom</span>.
The name of the
atom is obtained from the macro name by removing the leading characters
“<code class="code">XA_</code>”. The
<span class="type">Atom</span>
value is cached, such that subsequent requests do not cause
another round-trip to the server.
</p><p>
<a id="idp32219344" class="indexterm"></a>
</p><div class="funcsynopsis"><a id="XmuMakeAtom"></a><p><code class="funcdef">AtomPtr <strong class="fsfunc">XmuMakeAtom</strong>(</code>const char *<var class="pdparam">name</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>name</code></em></span></p></td><td><p>
specifies the atom name
</p></td></tr></tbody></table></div><p>
This function creates and initializes an opaque object, an
<span class="type">AtomPtr</span>,
for an
<span class="type">Atom</span>
with the
given name.
<a class="xref" href="#XmuInternAtom"><code class="function">XmuInternAtom</code></a>
can be used to cache the Atom value for one or more displays.
</p><p>
<a id="idp37444320" class="indexterm"></a>
</p><div class="funcsynopsis"><a id="XmuNameOfAtom"></a><p><code class="funcdef">char *<strong class="fsfunc">XmuNameOfAtom</strong>(</code>AtomPtr <var class="pdparam">atom_ptr</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>atom_ptr</code></em></span></p></td><td><p>
specifies the AtomPtr
</p></td></tr></tbody></table></div><p>
The function returns the name of an AtomPtr.
</p><p>
<a id="idp37451232" class="indexterm"></a>
</p><div class="funcsynopsis"><a id="XmuInternAtom"></a><p><code class="funcdef">Atom <strong class="fsfunc">XmuInternAtom</strong>(</code>Display *<var class="pdparam">dpy</var>, AtomPtr <var class="pdparam">atom_ptr</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>atom_ptr</code></em></span></p></td><td><p>
specifies the AtomPtr
</p></td></tr></tbody></table></div><p>
This function returns the
<span class="type">Atom</span>
for an
<span class="type">AtomPtr</span>.
The
<span class="type">Atom</span>
is cached,
such that subsequent requests do not cause another round-trip to the server.
</p><p>
<a id="idp37461936" class="indexterm"></a>
</p><div class="funcsynopsis"><a id="XmuGetAtomName"></a><p><code class="funcdef">char *<strong class="fsfunc">XmuGetAtomName</strong>(</code>Display *<var class="pdparam">dpy</var>, Atom <var class="pdparam">atom</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>atom</code></em></span></p></td><td><p>
specifies the atom whose name is desired
</p></td></tr></tbody></table></div><p>
This function returns the name of an
<span class="type">Atom</span>.
The result is cached, such that subsequent
requests do not cause another round-trip to the server.
</p><p>
<a id="idp37471888" class="indexterm"></a>
</p><div class="funcsynopsis"><a id="XmuInternStrings"></a><p><code class="funcdef">void <strong class="fsfunc">XmuInternStrings</strong>(</code>Display *<var class="pdparam">dpy</var>, String *<var class="pdparam">names</var>, Cardinal <var class="pdparam">count</var>, Atom *<var class="pdparam">atoms</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>names</code></em></span></p></td><td><p>
specifies the strings to intern
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>count</code></em></span></p></td><td><p>
specifies the number of strings
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>atoms</code></em></span></p></td><td><p>
returns the list of Atom values
</p></td></tr></tbody></table></div><p>
This function converts a list of atom names into
<span class="type">Atom</span>
values. The results are cached, such
that subsequent requests do not cause further round-trips to the server.
The caller is responsible for preallocating the array pointed at by atoms.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Error_Handler_Functions"></a>Error Handler Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/Error.h</code>>
<a id="idp37489024" class="indexterm"></a>
and link against the libXmu or libXmuu library.
</p><p>
<a id="idp37491024" class="indexterm"></a>
</p><div class="funcsynopsis"><a id="XmuPrintDefaultErrorMessage"></a><p><code class="funcdef">int <strong class="fsfunc">XmuPrintDefaultErrorMessage</strong>(</code>Display *<var class="pdparam">dpy</var>, XErrorEvent *<var class="pdparam">event</var>, FILE *<var class="pdparam">fp</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the error
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fp</code></em></span></p></td><td><p>
specifies where to print the error message
</p></td></tr></tbody></table></div><p>
This function prints an error message, equivalent to Xlib's default error
message for protocol errors. It returns a non-zero value
if the caller should consider exiting, otherwise it returns 0.
This function can be used when you need to
write your own error handler, but need to print out an error from within
that handler.
</p><p><a id="XmuSimpleErrorHandler"></a>
<a id="idp37503584" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuSimpleErrorHandler</strong>(</code>Display *<var class="pdparam">dpy</var>, XErrorEvent *<var class="pdparam">errorp</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>errorp</code></em></span></p></td><td><p>
specifies the error
</p></td></tr></tbody></table></div><p>
This function ignores errors for
<span class="errorname">BadWindow</span>
errors for
<span class="olink"><code class="function">XQueryTree</code></span>
and
<span class="olink"><code class="function">XGetWindowAttributes</code></span>,
and ignores
<span class="errorname">BadDrawable</span>
errors for
<span class="olink"><code class="function">XGetGeometry</code></span>;
it returns 0 in those cases. Otherwise, it prints the default error message,
and returns a non-zero value if the caller should consider exiting,
and 0 if the caller should not exit.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="System_Utility_Functions"></a>System Utility Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/SysUtil.h</code>>
<a id="idp37519392" class="indexterm"></a>
and link against the libXmu or libXmuu library.
</p><p><a id="XmuGetHostname"></a>
<a id="idp37521632" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuGetHostname</strong>(</code>char *<var class="pdparam">buf</var>, int <var class="pdparam">maxlen</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>buf</code></em></span></p></td><td><p>
returns the host name
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>maxlen</code></em></span></p></td><td><p>
specifies the length of <em class="parameter"><code>buf</code></em>
</p></td></tr></tbody></table></div><p>
This function stores the null terminated name of the local host in
<em class="parameter"><code>buf</code></em>, and
returns length of the name. This function hides operating system differences,
such as whether to call <code class="function">gethostname</code> or
<code class="function">uname</code>.
</p><p><a id="XmuSnprintf"></a>
<a id="idp37533584" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuSnprintf</strong>(</code>char *<var class="pdparam">str</var>, int <var class="pdparam">size</var>, <var class="pdparam">...</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>str</code></em></span></p></td><td><p>
string to write output to
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>size</code></em></span></p></td><td><p>
specifies the size of <em class="parameter"><code>str</code></em>
</p></td></tr></tbody></table></div><p>
This function was provided as a portable implementation of
<code class="function">snprintf</code> before all platforms could be
relied on to provide their own. It is now deprecated in favor of
calling <code class="function">snprintf</code> directly and should only be used
in software that needs to continue to support non-Unix98 compliant platforms.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Window_Utility_Functions"></a>Window Utility Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/WinUtil.h</code>>
<a id="idp37547600" class="indexterm"></a>.
To use <code class="function">XmuClientWindow</code>, you may link against either the
libXmu or libXmuu libraries. The other functions in this section require
linking against the libXmu library.
</p><p><a id="XmuScreenOfWindow"></a>
<a id="idp37550624" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Screen *<strong class="fsfunc">XmuScreenOfWindow</strong>(</code>Display *<var class="pdparam">dpy</var>, Window <var class="pdparam">w</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>w</code></em></span></p></td><td><p>
specifies the window
</p></td></tr></tbody></table></div><p>
This function returns the
<span class="type">Screen</span>
on which the specified window was created.
</p><p><a id="XmuClientWindow"></a>
<a id="idp37560336" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Window <strong class="fsfunc">XmuClientWindow</strong>(</code>Display *<var class="pdparam">dpy</var>, Window <var class="pdparam">win</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>win</code></em></span></p></td><td><p>
specifies the window
</p></td></tr></tbody></table></div><p>
<a id="idp37569040" class="indexterm"></a>
This function finds a window, at or below the specified window, which has a
<span class="property">WM_STATE</span> property. If such a window is found, it is
returned, otherwise the
argument window is returned.
</p><p><a id="XmuUpdateMapHints"></a>
<a id="idp37572016" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Bool <strong class="fsfunc">XmuUpdateMapHints</strong>(</code>Display *<var class="pdparam">dpy</var>, Window <var class="pdparam">w</var>, XSizeHints *<var class="pdparam">hints</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>win</code></em></span></p></td><td><p>
specifies the window
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>hints</code></em></span></p></td><td><p>
specifies the new hints, or <span class="symbol">NULL</span>
</p></td></tr></tbody></table></div><p>
This function clears the
<span class="symbol">PPosition</span>
and
<span class="symbol">PSize</span>
flags and sets the
<span class="symbol">USPosition</span>
and
<span class="symbol">USSize</span>
flags in the hints structure, and then stores the hints for the
window using
<a id="idp37585168" class="indexterm"></a>
<span class="olink"><code class="function">XSetWMNormalHints</code></span>
and returns
<span class="symbol">True</span>.
If <span class="symbol">NULL</span> is passed for the
hints structure, then the current hints are read back from the window using
<a id="idp37589504" class="indexterm"></a>
<span class="olink"><code class="function">XGetWMNormalHints</code></span>
and are used instead, and
<span class="symbol">True</span>
is returned; otherwise
<span class="symbol">False</span>
is returned.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Cursor_Utility_Functions"></a>Cursor Utility Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/CurUtil.h</code>>
<a id="idp37596160" class="indexterm"></a>
and link against the libXmu or libXmuu library.
</p><p><a id="XmuCursorNameToIndex"></a>
<a id="idp37598400" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuCursorNameToIndex</strong>(</code>const char *<var class="pdparam">name</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>name</code></em></span></p></td><td><p>
specifies the name of the cursor
</p></td></tr></tbody></table></div><p>
This function takes the name of a standard cursor and returns its index
in the standard cursor font. The cursor names are formed by removing the
“<code class="code">XC_</code>” prefix from the cursor defines listed in
Appendix B of the Xlib
manual.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Graphics_Functions"></a>Graphics Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/Drawing.h</code>>
<a id="idp37607552" class="indexterm"></a>
and link against the libXmu library.
</p><p><a id="XmuDrawRoundedRectangle"></a>
<a id="idp37609792" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuDrawRoundedRectangle</strong>(</code>Display *<var class="pdparam">dpy</var>, Drawable <var class="pdparam">draw</var>, GC <var class="pdparam">gc</var>, int <var class="pdparam">x</var>, int <var class="pdparam">y</var>, int <var class="pdparam">w</var>, int <var class="pdparam">h</var>, int <var class="pdparam">ew</var>, int <var class="pdparam">eh</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>draw</code></em></span></p></td><td><p>
specifies the drawable
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>gc</code></em></span></p></td><td><p>
specifies the GC
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>x</code></em></span></p></td><td><p>
specifies the upper left x coordinate
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>y</code></em></span></p></td><td><p>
specifies the upper left y coordinate
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>w</code></em></span></p></td><td><p>
specifies the rectangle width
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>h</code></em></span></p></td><td><p>
specifies the rectangle height
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>ew</code></em></span></p></td><td><p>
specifies the corner width
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>eh</code></em></span></p></td><td><p>
specifies the corner height
</p></td></tr></tbody></table></div><p>
This function draws a rounded rectangle, where x, y, w, h are the dimensions
of the overall rectangle, and ew and eh are the sizes of a bounding box that
the corners are drawn inside of; ew should be no more than half of w, and eh
should be no more than half of h. The current GC line attributes control
all attributes of the line.
</p><p><a id="XmuFillRoundedRectangle"></a>
<a id="idp37637168" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuFillRoundedRectangle</strong>(</code>Display *<var class="pdparam">dpy</var>, Drawable <var class="pdparam">draw</var>, GC <var class="pdparam">gc</var>, int <var class="pdparam">x</var>, int <var class="pdparam">y</var>, int <var class="pdparam">w</var>, int <var class="pdparam">h</var>, int <var class="pdparam">ew</var>, int <var class="pdparam">eh</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>draw</code></em></span></p></td><td><p>
specifies the drawable
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>gc</code></em></span></p></td><td><p>
specifies the GC
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>x</code></em></span></p></td><td><p>
specifies the upper left x coordinate
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>y</code></em></span></p></td><td><p>
specifies the upper left y coordinate
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>w</code></em></span></p></td><td><p>
specifies the rectangle width
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>h</code></em></span></p></td><td><p>
specifies the rectangle height
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>ew</code></em></span></p></td><td><p>
specifies the corner width
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>eh</code></em></span></p></td><td><p>
specifies the corner height
</p></td></tr></tbody></table></div><p>
This function draws a filled rounded rectangle, where x, y, w, h are the
dimensions of the overall rectangle, and ew and eh are the sizes of a
bounding box that the corners are drawn inside of; ew should be no more than
half of w, and eh should be no more than half of h. The current GC fill
settings control all attributes of the fill contents.
</p><p><a id="XmuDrawLogo"></a>
<a id="idp37664560" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef"><strong class="fsfunc">XmuDrawLogo</strong>(</code>Display *<var class="pdparam">dpy</var>, Drawable <var class="pdparam">drawable</var>, GC <var class="pdparam">gcFore</var>, GC <var class="pdparam">gcBack</var>, int <var class="pdparam">x</var>, int <var class="pdparam">y</var>, unsigned int <var class="pdparam">width</var>, unsigned int <var class="pdparam">height</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>drawable</code></em></span></p></td><td><p>
specifies the drawable
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>gcFore</code></em></span></p></td><td><p>
specifies the foreground GC
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>gcBack</code></em></span></p></td><td><p>
specifies the background GC
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>x</code></em></span></p></td><td><p>
specifies the upper left x coordinate
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>y</code></em></span></p></td><td><p>
specifies the upper left y coordinate
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>width</code></em></span></p></td><td><p>
specifies the logo width
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>height</code></em></span></p></td><td><p>
specifies the logo height
</p></td></tr></tbody></table></div><p>
This function draws the “official” X Window System logo
(<a class="xref" href="#xlogo" title="Figure 1. The X Logo">Figure 1, “The X Logo”</a>). The bounding box
of the logo in the drawable is given by x, y, width, and height. The logo
itself is filled using gcFore, and the rest of the rectangle is filled using
gcBack.
</p><div class="figure"><a id="xlogo"></a><p class="title"><strong>Figure 1. The X Logo</strong></p><div class="figure-contents"><div class="mediaobject"><object type="image/svg+xml" data="xlogo.svg"></object></div></div></div><br class="figure-break" /><p><a id="XmuCreateStippledPixmap"></a>
<a id="idp37692864" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Pixmap <strong class="fsfunc">XmuCreateStippledPixmap</strong>(</code>Screen *<var class="pdparam">screen</var>, Pixel <var class="pdparam">fore</var>, Pixel <var class="pdparam">back</var>, unsigned int <var class="pdparam">depth</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>screen</code></em></span></p></td><td><p>
specifies the screen the pixmap is created on
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fore</code></em></span></p></td><td><p>
specifies the foreground pixel value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>back</code></em></span></p></td><td><p>
specifies the background pixel value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>depth</code></em></span></p></td><td><p>
specifies the depth of the pixmap
</p></td></tr></tbody></table></div><p>
This function creates a two pixel by one pixel stippled pixmap of specified
depth on the specified screen. The pixmap is cached so that multiple
requests share the same pixmap. The pixmap should be freed with
<code class="function">XmuReleaseStippledPixmap</code>
to maintain correct reference counts.
</p><p><a id="XmuReleaseStippledPixmap"></a>
<a id="idp37708096" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuReleaseStippledPixmap</strong>(</code>Screen *<var class="pdparam">screen</var>, Pixmap <var class="pdparam">pixmap</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>screen</code></em></span></p></td><td><p>
specifies the screen the pixmap was created on
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>pixmap</code></em></span></p></td><td><p>
specifies the pixmap to free
</p></td></tr></tbody></table></div><p>
This function frees a pixmap created with
<code class="function">XmuCreateStippledPixmap</code>.
</p><p><a id="XmuReadBitmapData"></a>
<a id="idp37718048" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuReadBitmapData</strong>(</code>FILE *<var class="pdparam">fstream</var>, unsigned int *<var class="pdparam">width</var>, unsigned int *<var class="pdparam">height</var>, unsigned char **<var class="pdparam">datap</var>, int *<var class="pdparam">x_hot</var>, int *<var class="pdparam">y_hot</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>fstream</code></em></span></p></td><td><p>
specifies the stream to read from
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>width</code></em></span></p></td><td><p>
returns the width of the bitmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>height</code></em></span></p></td><td><p>
returns the height of the bitmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>datap</code></em></span></p></td><td><p>
returns the parsed bitmap data
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>x_hot</code></em></span></p></td><td><p>
returns the x coordinate of the hotspot
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>y_hot</code></em></span></p></td><td><p>
returns the y coordinate of the hotspot
</p></td></tr></tbody></table></div><p>
This function reads a standard bitmap file description from the specified
stream, and returns the parsed data in a format suitable for passing to
<span class="olink"><code class="function">XCreateBitmapFromData</code></span>.
The return value of the function has the same
interpretation as the return value for
<span class="olink"><code class="function">XReadBitmapFile</code></span>.
</p><p><a id="XmuReadBitmapDataFromFile"></a>
<a id="idp37740112" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuReadBitmapDataFromFile</strong>(</code>const char *<var class="pdparam">filename</var>, unsigned int *<var class="pdparam">width</var>, unsigned int *<var class="pdparam">height</var>, unsigned char **<var class="pdparam">datap</var>, int *<var class="pdparam">x_hot</var>, int *<var class="pdparam">y_hot</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>fstream</code></em></span></p></td><td><p>
specifies the file to read from
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>width</code></em></span></p></td><td><p>
returns the width of the bitmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>height</code></em></span></p></td><td><p>
returns the height of the bitmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>datap</code></em></span></p></td><td><p>
returns the parsed bitmap data
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>x_hot</code></em></span></p></td><td><p>
returns the x coordinate of the hotspot
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>y_hot</code></em></span></p></td><td><p>
returns the y coordinate of the hotspot
</p></td></tr></tbody></table></div><p>
This function reads a standard bitmap file description from the specified
file, and returns the parsed data in a format suitable for passing to
<span class="olink"><code class="function">XCreateBitmapFromData</code></span>.
The return value of the function has the same
interpretation as the return value for
<span class="olink"><code class="function">XReadBitmapFile</code></span>.
</p><p><a id="XmuLocateBitmapFile"></a>
<a id="idp37762176" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Pixmap <strong class="fsfunc">XmuLocateBitmapFile</strong>(</code>Screen *<var class="pdparam">screen</var>, const char *<var class="pdparam">name</var>, char *<var class="pdparam">srcname</var>, int <var class="pdparam">srcnamelen</var>, int *<var class="pdparam">widthp</var>, int *<var class="pdparam">heightp</var>, int *<var class="pdparam">xhotp</var>, int *<var class="pdparam">yhotp</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>screen</code></em></span></p></td><td><p>
specifies the screen the pixmap is created on
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>name</code></em></span></p></td><td><p>
specifies the file to read from
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>srcname</code></em></span></p></td><td><p>
returns the full filename of the bitmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>srcnamelen</code></em></span></p></td><td><p>
specifies the length of the srcname buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>width</code></em></span></p></td><td><p>
returns the width of the bitmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>height</code></em></span></p></td><td><p>
returns the height of the bitmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>xhotp</code></em></span></p></td><td><p>
returns the x coordinate of the hotspot
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>yhotp</code></em></span></p></td><td><p>
returns the y coordinate of the hotspot
</p></td></tr></tbody></table></div><p>
This function reads a file in standard bitmap file format, using
<span class="olink"><code class="function">XReadBitmapFile</code></span>,
and returns the created bitmap. The filename may be
absolute, or relative to the global resource named
<a id="idp37787408" class="indexterm"></a>
<code class="systemitem">bitmapFilePath</code> with class
BitmapFilePath. If the resource is not defined, the default value is the
build symbol BITMAPDIR, which is typically
"<code class="filename">/usr/include/X11/bitmaps</code>".
If <em class="parameter"><code>srcnamelen</code></em> is greater than zero and
<em class="parameter"><code>srcname</code></em> is not <span class="symbol">NULL</span>,
the null terminated filename will be copied into
<em class="parameter"><code>srcname</code></em>. The size and hotspot of the bitmap are
also returned.
</p><p><a id="XmuCreatePixmapFromBitmap"></a>
<a id="idp37794016" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Pixmap <strong class="fsfunc">XmuCreatePixmapFromBitmap</strong>(</code>Display *<var class="pdparam">dpy</var>, Drawable <var class="pdparam">d</var>, Pixmap <var class="pdparam">bitmap</var>, unsigned int <var class="pdparam">width</var>, unsigned int <var class="pdparam">height</var>, unsigned int <var class="pdparam">depth</var>, unsigned long <var class="pdparam">fore</var>, unsigned long <var class="pdparam">back</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>screen</code></em></span></p></td><td><p>
specifies the screen the pixmap is created on
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>bitmap</code></em></span></p></td><td><p>
specifies the bitmap source
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>width</code></em></span></p></td><td><p>
specifies the width of the pixmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>height</code></em></span></p></td><td><p>
specifies the height of the pixmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>depth</code></em></span></p></td><td><p>
specifies the depth of the pixmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fore</code></em></span></p></td><td><p>
specifies the foreground pixel value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>back</code></em></span></p></td><td><p>
specifies the background pixel value
</p></td></tr></tbody></table></div><p>
This function creates a pixmap of the specified width, height, and depth, on
the same screen as the specified drawable, and then performs an
<span class="olink"><code class="function">XCopyPlane</code></span>
from the specified bitmap to the pixmap,
using the specified foreground and background pixel values.
The created pixmap is returned.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Selection_Functions"></a>Selection Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/StdSel.h</code>>
<a id="idp37821872" class="indexterm"></a>
and link against the libXmu library.
</p><p><a id="XmuConvertStandardSelection"></a>
<a id="idp37824112" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Boolean <strong class="fsfunc">XmuConvertStandardSelection</strong>(</code>Widget <var class="pdparam">w</var>, Time <var class="pdparam">time</var>, Atom *<var class="pdparam">selection</var>, Atom *<var class="pdparam">target</var>, Atom *<var class="pdparam">type</var>, XPointer <var class="pdparam">value</var>, unsigned long *<var class="pdparam">length</var>, int *<var class="pdparam">format</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>w</code></em></span></p></td><td><p>
specifies the widget which currently owns the selection
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>time</code></em></span></p></td><td><p>
specifies the time at which the selection was established
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>selection</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>target</code></em></span></p></td><td><p>
specifies the target type of the selection
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>type</code></em></span></p></td><td><p>
returns the property type of the converted value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>value</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>length</code></em></span></p></td><td><p>
returns the number of elements in the converted value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>format</code></em></span></p></td><td><p>
returns the size in bits of the elements</p></td></tr></tbody></table></div><p>
This function converts the following standard selections: CLASS,
CLIENT_WINDOW, DECNET_ADDRESS, HOSTNAME, IP_ADDRESS, NAME, OWNER_OS,
TARGETS, TIMESTAMP, and USER. It returns
<span class="symbol">True</span>
if the conversion was successful, else it returns
<span class="symbol">False</span>.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Type_Converter_Functions"></a>Type Converter Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/Converters.h</code>>
<a id="idp37851504" class="indexterm"></a>
and link against the libXmu library.
</p><p><a id="XmuCvtFunctionToCallback"></a>
<a id="idp37853744" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtFunctionToCallback</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
the function to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
the place to store the converted value
</p></td></tr></tbody></table></div><p>
This function converts a callback procedure to a callback list containing
that procedure, with <span class="symbol">NULL</span> closure data. To use this converter, include the
following in your widget's ClassInitialize procedure:
</p><pre class="programlisting">
XtAddConverter(XtRCallProc, XtRCallback, XmuCvtFunctionToCallback, NULL, 0);
</pre><p>
</p><p><a id="XmuCvtStringToBackingStore"></a>
<a id="idp37869472" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtStringToBackingStore</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument must be a pointer to a Cardinal containing the value 0
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr></tbody></table></div><p>
<a id="idp37883328" class="indexterm"></a>
This function converts a string to a backing-store integer as defined in
<<code class="filename">X11/X.h</code>>.
The string "notUseful" converts to
<span class="symbol">NotUseful</span>,
"whenMapped" converts to
<span class="symbol">WhenMapped</span>,
and "always" converts to
<span class="symbol">Always</span>.
The string "default" converts to the value
<span class="symbol">Always</span> +
<span class="symbol">WhenMapped</span> +
<span class="symbol">NotUseful</span>.
The case of the string does not matter.
To use this converter, include the following
in your widget's ClassInitialize procedure:
</p><pre class="programlisting">
XtAddConverter(XtRString, XtRBackingStore, XmuCvtStringToBackingStore, NULL, 0);
</pre><p>
</p><p><a id="XmuCvtStringToBitmap"></a>
<a id="idp37889520" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtStringToBitmap</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
the sole argument specifies the Screen on which to create the bitmap
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
must be the value 1
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr></tbody></table></div><p>
<a id="idp37903376" class="indexterm"></a>
This function creates a bitmap (a Pixmap of depth one) suitable for window
manager icons. The string argument is the name of a file in standard bitmap
file format. For the possible filename specifications, see
<a class="link" href="#XmuLocateBitmapFile"><code class="function">XmuLocateBitmapFile</code></a>.
To use this converter, include the following in your widget's
ClassInitialize procedure:
</p><pre class="programlisting">
static XtConvertArgRec screenConvertArg[] = {
{XtBaseOffset, (XtPointer)XtOffset(Widget, core.screen), sizeof(Screen *)}
};
XtAddConverter(XtRString, XtRBitmap, XmuCvtStringToBitmap,
screenConvertArg, XtNumber(screenConvertArg));
</pre><p>
</p><p><a id="XmuCvtStringToColorCursor"></a>
<a id="idp37907456" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Boolean <strong class="fsfunc">XmuCvtStringToColorCursor</strong>(</code>Display *<var class="pdparam">dpy</var>, XrmValuePtr <var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var>, XtPointer *<var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the display to use for conversion warnings
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
specifies the required conversion arguments
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
specifies the number of required conversion arguments, which is 4
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr></tbody></table></div><p>
<a id="idp37926448" class="indexterm"></a>
This function converts a string to a
<span class="type">Cursor</span>
with the foreground and background pixels specified by the conversion
arguments. The string can either be a
standard cursor name formed by removing the <code class="code">“XC_”</code>
prefix from any of the
cursor defines listed in Appendix B of the Xlib Manual, a font name and
glyph index in decimal of the form "FONT fontname index [[font] index]",
or a bitmap filename acceptable to
<a class="link" href="#XmuLocateBitmapFile"><code class="function">XmuLocateBitmapFile</code></a>.
To use this converter, include
the following in the widget ClassInitialize procedure:
</p><pre class="programlisting">
static XtConvertArgRec colorCursorConvertArgs[] = {
{XtWidgetBaseOffset, (XtPointer) XtOffsetOf(WidgetRec, core.screen),
sizeof(Screen *)},
{XtResourceString, (XtPointer) XtNpointerColor, sizeof(Pixel)},
{XtResourceString, (XtPointer) XtNpointerColorBackground, sizeof(Pixel)},
{XtWidgetBaseOffset, (XtPointer) XtOffsetOf(WidgetRec, core.colormap),
sizeof(Colormap)}
};
XtSetTypeConverter(XtRString, XtRColorCursor, XmuCvtStringToColorCursor,
colorCursorConvertArgs, XtNumber(colorCursorConvertArgs),
XtCacheByDisplay, NULL);
</pre><p>
The widget must recognize XtNpointerColor and XtNpointerColorBackground as
resources, or specify other appropriate foreground and background resources.
The widget's Realize and SetValues methods must cause the converter to be
invoked with the appropriate arguments when one of the foreground,
background, or cursor resources has changed, or when the window is created,
and must assign the cursor to the window of the widget.
</p><p><a id="XmuCvtStringToCursor"></a>
<a id="idp37932944" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtStringToCursor</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
specifies the required conversion argument, the screen
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
specifies the number of required conversion arguments, which is 1
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr></tbody></table></div><p>
<a id="idp37946880" class="indexterm"></a>
This function converts a string to a
<span class="type">Cursor</span>.
The string can either be a
standard cursor name formed by removing the <code class="code">“XC_”</code>
prefix from any of the
cursor defines listed in Appendix B of the Xlib Manual, a font name and
glyph index in decimal of the form "FONT fontname index [[font] index]", or
a bitmap filename acceptable to
<a class="link" href="#XmuLocateBitmapFile"><code class="function">XmuLocateBitmapFile</code></a>.
To use this converter, include
the following in your widget's ClassInitialize procedure:
</p><pre class="programlisting">
static XtConvertArgRec screenConvertArg[] = {
{XtBaseOffset, (XtPointer)XtOffsetOf(WidgetRec, core.screen), sizeof(Screen *)}
};
XtAddConverter(XtRString, XtRCursor, XmuCvtStringToCursor,
screenConvertArg, XtNumber(screenConvertArg));
</pre><p>
</p><p><a id="XmuCvtStringToGravity"></a>
<a id="idp37951968" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtStringToGravity</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument must be a pointer to a Cardinal containing the value 0
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr></tbody></table></div><p>
<a id="idp37965824" class="indexterm"></a>
This function converts a string to an
<span class="type">XtGravity</span>
enumeration value. The string "forget" and a <span class="symbol">NULL</span> value convert to
<span class="symbol">ForgetGravity</span>,
"NorthWestGravity" converts to
<span class="symbol">NorthWestGravity</span>,
the strings "NorthGravity" and "top" convert to
<span class="symbol">NorthGravity</span>,
"NorthEastGravity" converts to
<span class="symbol">NorthEastGravity</span>,
the strings "West" and "left" convert to
<span class="symbol">WestGravity</span>,
"CenterGravity" converts to
<span class="symbol">CenterGravity</span>,
"EastGravity" and "right" convert to
<span class="symbol">EastGravity</span>,
"SouthWestGravity" converts to
<span class="symbol">SouthWestGravity</span>,
"SouthGravity" and "bottom" convert to
<span class="symbol">SouthGravity</span>,
"SouthEastGravity" converts to
<span class="symbol">SouthEastGravity</span>,
"StaticGravity" converts to
<span class="symbol">StaticGravity</span>,
and "UnmapGravity" converts to
<span class="symbol">UnmapGravity</span>.
The case of the string does not matter. To use this converter, include
the following in your widget's class initialize procedure:
</p><pre class="programlisting">
XtAddConverter(XtRString, XtRGravity, XmuCvtStringToGravity, NULL, 0);
</pre><p>
</p><p><a id="XmuCvtStringToJustify"></a>
<a id="idp37974080" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtStringToJustify</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr></tbody></table></div><p>
<a id="idp37987840" class="indexterm"></a>
This function converts a string to an
<span class="type">XtJustify</span>
enumeration value. The string "left" converts to
<span class="symbol">XtJustifyLeft</span>,
"center" converts to
<span class="symbol">XtJustifyCenter</span>,
and "right" converts to
<span class="symbol">XtJustifyRight</span>.
The case of the string does not matter. To use this converter,
include the following in your widget's ClassInitialize procedure:
</p><pre class="programlisting">
XtAddConverter(XtRString, XtRJustify, XmuCvtStringToJustify, NULL, 0);
</pre><p>
</p><p><a id="XmuCvtStringToLong"></a>
<a id="idp37992256" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtStringToLong</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument must be a pointer to a Cardinal containing 0
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr></tbody></table></div><p>
This function converts a string to an integer of type long. It parses the
string using
<code class="function">sscanf</code>
with a format of "%ld". To use this converter, include
the following in your widget's ClassInitialize procedure:
</p><pre class="programlisting">
XtAddConverter(XtRString, XtRLong, XmuCvtStringToLong, NULL, 0);
</pre><p>
</p><p><a id="XmuCvtStringToOrientation"></a>
<a id="idp38008320" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtStringToOrientation</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr></tbody></table></div><p>
<a id="idp38022080" class="indexterm"></a>
This function converts a string to an
<span class="type">XtOrientation</span>
enumeration value. The string "horizontal" converts to
<span class="symbol">XtorientHorizontal</span>
and "vertical" converts to
<span class="symbol">XtorientVertical</span>.
The case of the string does not matter. To use this converter,
include the following in your widget's ClassInitialize procedure:
</p><pre class="programlisting">
XtAddConverter(XtRString, XtROrientation, XmuCvtStringToOrientation, NULL, 0);
</pre><p>
</p><p><a id="XmuCvtStringToShapeStyle"></a>
<a id="idp38026192" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Boolean <strong class="fsfunc">XmuCvtStringToShapeStyle</strong>(</code>Display *<var class="pdparam">dpy</var>, XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var>, XtPointer *<var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
the display to use for conversion warnings
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
the value to convert from
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
the place to store the converted value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr></tbody></table></div><p>
This function converts a string to an integer shape style. The string
"rectangle" converts to
<span class="symbol">XmuShapeRectangle</span>,
"oval" converts to
<span class="symbol">XmuShapeOval</span>,
"ellipse" converts to
<span class="symbol">XmuShapeEllipse</span>,
and "roundedRectangle" converts to
<span class="symbol">XmuShapeRoundedRectangle</span>.
The case of the string does not matter. To use this converter,
include the following in your widget's ClassInitialize procedure:
</p><pre class="programlisting">
XtSetTypeConverter(XtRString, XtRShapeStyle, XmuCvtStringToShapeStyle,
NULL, 0, XtCacheNone, NULL);
</pre><p>
</p><p><a id="XmuReshapeWidget"></a>
<a id="idp38048192" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Boolean <strong class="fsfunc">XmuReshapeWidget</strong>(</code>Widget <var class="pdparam">w</var>, int <var class="pdparam">shape_style</var>, int <var class="pdparam">corner_width</var>, int <var class="pdparam">corner_height</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>w</code></em></span></p></td><td><p>
specifies the widget to reshape
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>shape_style</code></em></span></p></td><td><p>
specifies the new shape
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>corner_width</code></em></span></p></td><td><p>
specifies the width of the rounded rectangle corner
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>corner_height</code></em></span></p></td><td><p>
specified the height of the rounded rectangle corner
</p></td></tr></tbody></table></div><p>
<a id="idp38062112" class="indexterm"></a>
This function reshapes the specified widget, using the Shape extension, to a
rectangle, oval, ellipse, or rounded rectangle, as specified by shape_style
(
<span class="symbol">XmuShapeRectangle</span>,
<span class="symbol">XmuShapeOval</span>,
<span class="symbol">XmuShapeEllipse</span>,
and
<span class="symbol">XmuShapeRoundedRectangle</span>,
respectively).
The shape is bounded by the outside edges of the rectangular extents of the
widget. If the shape is a rounded rectangle, corner_width and corner_height
specify the size of the bounding box that the corners are drawn inside of
(see
<a class="link" href="#XmuFillRoundedRectangle"><code class="function">XmuFillRoundedRectangle</code></a>);
otherwise, corner_width and corner_height are ignored.
The origin of the widget within its parent remains unchanged.
</p><p><a id="XmuCvtStringToWidget"></a>
<a id="idp38067104" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCvtStringToWidget</strong>(</code>XrmValue *<var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
the sole argument is the parent Widget
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument must be 1
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr></tbody></table></div><p>
This function converts a string to an immediate child widget of the parent
widget passed as an argument. Note that this converter only works for
child widgets that have already been created; there is no lazy evaluation.
The string is first compared against the
names of the normal and popup children, and if a match is found the
corresponding child is returned. If no match is found, the string is
compared against the classes of the normal and popup children, and if a
match is found the corresponding child is returned. The case of the string
is significant. To use this converter, include the following in your
widget's ClassInitialize procedure:
</p><pre class="programlisting">
static XtConvertArgRec parentCvtArg[] = {
{XtBaseOffset, (XtPointer)XtOffset(Widget, core.parent), sizeof(Widget)},
};
XtAddConverter(XtRString, XtRWidget, XmuCvtStringToWidget,
parentCvtArg, XtNumber(parentCvtArg));
</pre><p>
</p><p><a id="XmuNewCvtStringToWidget"></a>
<a id="idp38083024" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Boolean <strong class="fsfunc">XmuNewCvtStringToWidget</strong>(</code>Display *<var class="pdparam">dpy</var>, XrmValuePtr <var class="pdparam">args</var>, Cardinal *<var class="pdparam">num_args</var>, XrmValuePtr <var class="pdparam">fromVal</var>, XrmValuePtr <var class="pdparam">toVal</var>, XtPointer *<var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
the display to use for conversion warnings
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>args</code></em></span></p></td><td><p>
the sole argument is the parent Widget
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_args</code></em></span></p></td><td><p>
this argument must be a pointer to a Cardinal containing the value 1
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>fromVal</code></em></span></p></td><td><p>
specifies the string to convert
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toVal</code></em></span></p></td><td><p>
returns the converted value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
this argument is ignored
</p></td></tr></tbody></table></div><p>
This converter is identical in functionality to
<a class="link" href="#XmuCvtStringToWidget"><code class="function">XmuCvtStringToWidget</code></a>, except
that it is a new-style converter, allowing the specification of a cache type
at the time of registration.
Most widgets will not cache the conversion results, as the application may
dynamically create and destroy widgets, which would cause cached values to
become illegal. To use this converter, include the following in the widget's
class initialize procedure:
</p><pre class="programlisting">
static XtConvertArgRec parentCvtArg[] = {
{XtWidgetBaseOffset, (XtPointer)XtOffsetOf(WidgetRec, core.parent),
sizeof(Widget)}
};
XtSetTypeConverter(XtRString, XtRWidget, XmuNewCvtStringToWidget,
parentCvtArg, XtNumber(parentCvtArg), XtCacheNone, NULL);
</pre><p>
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Character_Set_Functions"></a>Character Set Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/CharSet.h</code>>
<a id="idp38106672" class="indexterm"></a>
and link against the libXmu or libXmuu library.
</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>
The functions in this section are <span class="emphasis"><em>deprecated</em></span>
because they don't work in most locales now supported by X11; most platforms
provide alternatives in their system libraries.
</p></div><p><a id="XmuCopyISOLatin1Lowered"></a>
<a id="idp38110192" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCopyISOLatin1Lowered</strong>(</code>char *<var class="pdparam">dst</var>, const char *<var class="pdparam">src</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dst</code></em></span></p></td><td><p>
returns the string copy
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>src</code></em></span></p></td><td><p>
specifies the string to copy
</p></td></tr></tbody></table></div><p>
This function copies a null terminated string from src to dst (including the
null), changing all Latin-1 uppercase letters to lowercase. The string is
assumed to be encoded using ISO 8859-1.
</p><p>
Note that like <code class="function">strcpy</code> the caller is responsible for
ensuring the size of <em class="parameter"><code>dst</code></em> is at least as large as the
size of <em class="parameter"><code>src</code></em>.
</p><p><a id="XmuNCopyISOLatin1Lowered"></a>
<a id="idp38121984" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuNCopyISOLatin1Lowered</strong>(</code>char *<var class="pdparam">dst</var>, const char *<var class="pdparam">src</var>, int <var class="pdparam">size</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dst</code></em></span></p></td><td><p>
returns the string copy
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>src</code></em></span></p></td><td><p>
specifies the string to copy
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>size</code></em></span></p></td><td><p>
maximum number of characters (including the null terminator) to write to dst
</p></td></tr></tbody></table></div><p>
This function copies up to <code class="code"><em class="parameter"><code>size</code></em> - 1</code>
characters of a null terminated string from <em class="parameter"><code>src</code></em>
to <em class="parameter"><code>dst</code></em>, and terminates it with a null,
changing all Latin-1 uppercase letters to lowercase. The string is
assumed to be encoded using ISO 8859-1.
</p><p><a id="XmuCopyISOLatin1Uppered"></a>
<a id="idp38136224" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCopyISOLatin1Uppered</strong>(</code>char *<var class="pdparam">dst</var>, const char *<var class="pdparam">src</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dst</code></em></span></p></td><td><p>
returns the string copy
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>src</code></em></span></p></td><td><p>
specifies the string to copy
</p></td></tr></tbody></table></div><p>
This function copies a null terminated string from src to dst (including the
null), changing all Latin-1 lowercase letters to uppercase. The string is
assumed to be encoded using ISO 8859-1.
</p><p>
Note that like <code class="function">strcpy</code> the caller is responsible for
ensuring the size of <em class="parameter"><code>dst</code></em> is at least as large as the
size of <em class="parameter"><code>src</code></em>.
</p><p><a id="XmuNCopyISOLatin1Uppered"></a>
<a id="idp38148016" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuNCopyISOLatin1Uppered</strong>(</code>char *<var class="pdparam">dst</var>, const char *<var class="pdparam">src</var>, int <var class="pdparam">size</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dst</code></em></span></p></td><td><p>
returns the string copy
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>src</code></em></span></p></td><td><p>
specifies the string to copy
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>size</code></em></span></p></td><td><p>
maximum number of characters (including the null terminator) to write to dst
</p></td></tr></tbody></table></div><p>
This function copies up to <code class="code"><em class="parameter"><code>size</code></em> - 1</code>
characters of a null terminated string from <em class="parameter"><code>src</code></em>
to <em class="parameter"><code>dst</code></em>, and terminates it with a null,
changing all Latin-1 lowercase letters to uppercase. The string is
assumed to be encoded using ISO 8859-1.
</p><p><a id="XmuCompareISOLatin1"></a>
<a id="idp38162256" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuCompareISOLatin1</strong>(</code>const char *<var class="pdparam">first</var>, const char *<var class="pdparam">second</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>first</code></em></span></p></td><td><p>
specifies a string to compare
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>second</code></em></span></p></td><td><p>
specifies a string to compare
</p></td></tr></tbody></table></div><p>
This function compares two null terminated Latin-1 strings, ignoring case
differences, and returns an integer greater than, equal to, or less than 0,
according to whether first is lexicographically greater than, equal to, or
less than second. The two strings are assumed to be encoded using ISO
8859-1.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Keyboard_Event_Translation_Functions"></a>Keyboard Event Translation Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/Lookup.h</code>>
<a id="idp38173712" class="indexterm"></a>.
and link against the libXmu library.
</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>
The functions in this section are <span class="emphasis"><em>deprecated</em></span> because they don't work
in most locales now supported by X11; the function
<span class="olink"><code class="function">XmbLookupString</code></span>
provides a better alternative.
</p></div><p><a id="XmuLookupLatin1"></a>
<a id="idp38178416" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupLatin1</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is identical to
<span class="olink"><code class="function">XLookupString</code></span>,
and exists only for naming symmetry with other functions.
</p><p><a id="XmuLookupLatin2"></a>
<a id="idp38196640" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupLatin2</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to an Latin-2 (ISO 8859-2) string, or to an ASCII control string.
</p><p><a id="XmuLookupLatin3"></a>
<a id="idp38214912" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupLatin3</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to an Latin-3 (ISO 8859-3) string, or to an ASCII control string.
</p><p><a id="XmuLookupLatin4"></a>
<a id="idp38233184" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupLatin4</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to an Latin-4 (ISO 8859-4) string, or to an ASCII control string.
</p><p><a id="XmuLookupKana"></a>
<a id="idp38251456" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupKana</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to a string in an encoding consisting of Latin-1 (ISO 8859-1) and ASCII
control in the Graphics Left half (values 0 to 127), and Katakana in the
Graphics Right half (values 128 to 255), using the values from JIS
X201-1976.
</p><p><a id="XmuLookupJISX0201"></a>
<a id="idp38270144" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupJISX0201</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to a string in the JIS X0201-1976 encoding, including ASCII control.
</p><p><a id="XmuLookupArabic"></a>
<a id="idp38288416" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupArabic</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to a Latin/Arabic (ISO 8859-6) string, or to an ASCII control string.
</p><p><a id="XmuLookupCyrillic"></a>
<a id="idp38306688" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupCyrillic</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to a Latin/Cyrillic (ISO 8859-5) string, or to an ASCII control string.
</p><p><a id="XmuLookupGreek"></a>
<a id="idp38324960" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupGreek</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to a Latin/Greek (ISO 8859-7) string, or to an ASCII control string.
</p><p><a id="XmuLookupHebrew"></a>
<a id="idp38343232" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupHebrew</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event
to a Latin/Hebrew (ISO 8859-8) string, or to an ASCII control string.
</p><p><a id="XmuLookupAPL"></a>
<a id="idp38361504" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuLookupAPL</strong>(</code>XKeyEvent *<var class="pdparam">event</var>, unsigned char *<var class="pdparam">buffer</var>, int <var class="pdparam">nbytes</var>, KeySym *<var class="pdparam">keysym</var>, XComposeStatus *<var class="pdparam">status</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em></span></p></td><td><p>
specifies the key event
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em></span></p></td><td><p>
returns the translated characters
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>nbytes</code></em></span></p></td><td><p>
specifies the length of the buffer
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>keysym</code></em></span></p></td><td><p>
returns the computed KeySym, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>status</code></em></span></p></td><td><p>
specifies or returns the compose state
</p></td></tr></tbody></table></div><p>
This function is similar to
<span class="olink"><code class="function">XLookupString</code></span>,
except that it maps a key event to an APL string.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Compound_Text_Functions"></a>Compound Text Functions</h2></div></div></div><p>
The functions defined in this section are for parsing Compound Text strings,
decomposing them into individual segments. Definitions needed to use these
routines are in the include file
<<code class="filename">X11/Xmu/Xct.h</code>>
<a id="idp38381744" class="indexterm"></a>
and link against the libXmu library.
</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>
The functions in this section are <span class="emphasis"><em>deprecated</em></span> because they shift the
burden for recently introduced locale encodings to the application. The
use of the
<span class="symbol">UTF8_STRING</span>
text encoding provides a better alternative.
</p></div><p>
A Compound Text string is represented as the following type:
</p><pre class="synopsis">
typedef unsigned char *XctString;
</pre><p>
</p><p><a id="XctCreate"></a>
<a id="idp38386720" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">XctData <strong class="fsfunc">XctCreate</strong>(</code>const XctString <var class="pdparam">string</var>, int <var class="pdparam">length</var>, XctFlags <var class="pdparam">flags</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>string</code></em></span></p></td><td><p>
the Compound Text string
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>length</code></em></span></p></td><td><p>
the number of bytes in string
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>flags</code></em></span></p></td><td><p>
parsing control flags
</p></td></tr></tbody></table></div><p>
This function creates an
<span class="type">XctData</span>
structure for parsing a Compound Text
string. The string need not be null terminated. The following flags are
defined to control parsing of the string:
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><span class="symbol">XctSingleSetSegments</span></span></p></td><td><p>
This means that returned segments should contain
characters from only one set (C0, C1, GL, GR). When this is requested,
<span class="symbol">XctSegment</span>
is never returned by
<code class="function">XctNextItem</code>,
instead
<span class="symbol">XctC0Segment</span>,
<span class="symbol">XctC1Segment</span>,
<span class="symbol">XctGlSegment</span>,
and
<span class="symbol">XctGRSegment</span>
are returned. C0 and C1
segments are always returned as singleton characters.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctProvideExtensions</span></span></p></td><td><p>
This means that if the Compound Text string is from a
higher version than this code is implemented to, then syntactically correct
but unknown control sequences should be returned as
<span class="symbol">XctExtension</span>
items by
<code class="function">XctNextItem</code>.
If this flag is not set, and the Compound Text string version
indicates that extensions cannot be ignored, then each unknown control
sequence will be reported as an
<span class="symbol">XctError</span>.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctAcceptC0Extensions</span></span></p></td><td><p>
This means that if the Compound Text string is from
a higher version than this code is implemented to, then unknown C0
characters should be treated as if they were legal, and returned as C0
characters (regardless of how
<span class="symbol">XctProvideExtensions</span>
is set) by
<code class="function">XctNextItem</code>.
If this flag is not set, then all unknown C0 characters are treated
according to
<span class="symbol">XctProvideExtensions</span>.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctAcceptC1Extensions</span></span></p></td><td><p>
This means that if the Compound Text string is from
a higher version than this code is implemented to, then unknown C1
characters should be treated as if they were legal, and returned as C1
characters (regardless of how
<span class="symbol">XctProvideExtensions</span>
is set) by
<code class="function">XctNextItem</code>.
If this flag is not set, then all unknown C1 characters are treated
according to
<span class="symbol">XctProvideExtensions</span>.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctHideDirection</span></span></p></td><td><p>
This means that horizontal direction changes should be
reported as
<span class="symbol">XctHorizontal</span>
items by
<code class="function">XctNextItem</code>. If this flag is not set,
then direction changes are not returned as items, but the current direction
is still maintained and reported for other items. The current direction is
given as an enumeration, with the values
<span class="symbol">XctUnspecified</span>,
<span class="symbol">XctLeftToRight</span>,
and
<span class="symbol">XctRightToLeft</span>.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctFreeString</span></span></p></td><td><p>
This means that
<code class="function">XctFree</code>
should free the Compound Text string that is passed to
<code class="function">XctCreate</code>.
If this flag is not set, the string is not freed.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctShiftMultiGRToGL</span></span></p></td><td><p>
This means that
<code class="function">XctNextItem</code>
should translate GR
segments on-the-fly into GL segments for the GR sets: GB2312.1980-1,
JISX0208.1983-1, and KSC5601.1987-1.
</p></td></tr></tbody></table></div><p>
</p><p><a id="XctReset"></a>
<a id="idp38421952" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XctReset</strong>(</code>XctData <var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
specifies the Compound Text structure
</p></td></tr></tbody></table></div><p>
This function resets the
<span class="type">XctData</span>
structure to reparse the Compound Text string from the beginning.
</p><p><a id="XctNextItem"></a>
<a id="idp38429232" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">XctResult <strong class="fsfunc">XctNextItem</strong>(</code>XctData <var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
specifies the Compound Text structure
</p></td></tr></tbody></table></div><p>
This function parses the next “item” from the Compound Text string. The
return value indicates what kind of item is returned. The item itself, its
length, and the current contextual state, are reported as components of the
<span class="type">XctData</span>
structure.
<span class="type">XctResult</span>
is an enumeration, with the following values:
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><span class="symbol">XctSegment</span></span></p></td><td><p>
the item contains some mixture of C0, GL, GR, and C1 characters.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctC0Segment</span></span></p></td><td><p>
the item contains only C0 characters.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctGLSegment</span></span></p></td><td><p>
the item contains only GL characters.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctC1Segment</span></span></p></td><td><p>
the item contains only C1 characters.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctGRSegment</span></span></p></td><td><p>
the item contains only GR characters.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctExtendedSegment</span></span></p></td><td><p>
the item contains an extended segment.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctExtension</span></span></p></td><td><p>
the item is an unknown extension control sequence.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctHorizontal</span></span></p></td><td><p>
the item indicates a change in horizontal direction or
depth. The new direction and depth are recorded in the
<span class="type">XctData</span>
structure.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctEndOfText</span></span></p></td><td><p>
The end of the Compound Text string has been reached.
</p></td></tr><tr><td><p><span class="term"><span class="symbol">XctError</span></span></p></td><td><p>
the string contains a syntactic or semantic error; no further
parsing should be performed.
</p></td></tr></tbody></table></div><p>
</p><p><a id="XctData"></a>
<a id="idp38452384" class="indexterm"></a>
The following state values are stored in the
<span class="type">XctData</span>
structure:
</p><pre class="synopsis">
XctString item; /* the action item */
unsigned item_length; /* length of item in bytes */
int char_size; /* the number of bytes per character in
* item, with zero meaning variable */
char *encoding; /* the XLFD encoding name for item */
XctHDirection horizontal; /* the direction of item */
unsigned horz_depth; /* the current direction nesting depth */
char *GL; /* the "{I} F" string for the current GL */
char *GL_encoding; /* the XLFD encoding name for the current GL */
int GL_set_size; /* 94 or 96 */
int GL_char_size; /* the number of bytes per GL character */
char *GR; /* the "{I} F" string for the current GR */
char *GR_encoding; /* the XLFD encoding name for the current GR */
int GR_set_size; /* 94 or 96 */
int GR_char_size; /* number of bytes per GR character */
char *GLGR_encoding; /* the XLFD encoding name for the current
* GL+GR, if known */
</pre><p>
</p><p>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XctFree</strong>(</code>XctData <var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
specifies the Compound Text structure
</p></td></tr></tbody></table></div><p>
This function frees all data associated with the
<span class="type">XctData</span>
structure.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="CloseDisplay_Hook_Functions"></a>CloseDisplay Hook Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/CloseHook.h</code>>
<a id="idp38464464" class="indexterm"></a>
and link against the libXmu library.
</p><p><a id="XmuAddCloseDisplayHook"></a>
<a id="idp38466704" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">CloseHook <strong class="fsfunc">XmuAddCloseDisplayHook</strong>(</code>Display *<var class="pdparam">dpy</var>, int <var class="pdparam">( *func )</var>
<code>(</code>Display *, XPointer<code>)</code>, XPointer <var class="pdparam">arg</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>func</code></em></span></p></td><td><p>
specifies the function to call at display close
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>arg</code></em></span></p></td><td><p>
specifies arbitrary data to pass to <em class="parameter"><code>func</code></em>
</p></td></tr></tbody></table></div><p>
This function adds a callback for the given display. When the display is
closed, the given function will be called with the given display and
argument as:
</p><pre class="programlisting">
(*func)(dpy, arg)
</pre><p>
</p><p>
The function is declared to return an int even though the value is ignored,
because some compilers used to have problems with functions returning void.
</p><p>
This routine returns <span class="symbol">NULL</span> if it was unable to add the
callback, otherwise it
returns an opaque handle that can be used to remove or lookup the callback.
</p><p><a id="XmuRemoveCloseDisplayHook"></a>
<a id="idp38481840" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Bool <strong class="fsfunc">XmuRemoveCloseDisplayHook</strong>(</code>Display *<var class="pdparam">dpy</var>, CloseHook <var class="pdparam">handle</var>, int <var class="pdparam">( *func )</var>
<code>(</code>Display *, XPointer<code>)</code>, XPointer <var class="pdparam">arg</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>handle</code></em></span></p></td><td><p>
specifies the callback by id, or <span class="symbol">NULL</span>
</p></td></tr><tr><td><p><span class="term"><code class="function">func</code></span></p></td><td><p>
specifies the callback by function
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>arg</code></em></span></p></td><td><p>
specifies the function data to match
</p></td></tr></tbody></table></div><p>
This function deletes a callback that has been added with
<code class="function">XmuAddCloseDisplayHook</code>.
If handle is not <span class="symbol">NULL</span>, it specifies the callback to
remove, and the func and arg parameters are ignored. If handle is <span class="symbol">NULL</span>, the
first callback found to match the specified func and arg will be removed.
Returns
<span class="symbol">True</span>
if a callback was removed, else returns
<span class="symbol">False</span>.
</p><p><a id="XmuLookupCloseDisplayHook"></a>
<a id="idp38499456" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Bool <strong class="fsfunc">XmuLookupCloseDisplayHook</strong>(</code>Display *<var class="pdparam">dpy</var>, CloseHook <var class="pdparam">handle</var>, int <var class="pdparam">( *func )</var>
<code>(</code>Display *, XPointer<code>)</code>, XPointer <var class="pdparam">arg</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>handle</code></em></span></p></td><td><p>
specifies the callback by id, or <span class="symbol">NULL</span>
</p></td></tr><tr><td><p><span class="term"><code class="function">func</code></span></p></td><td><p>
specifies the callback by function
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>arg</code></em></span></p></td><td><p>
specifies the function data to match
</p></td></tr></tbody></table></div><p>
This function determines if a callback is installed. If handle is not
<span class="symbol">NULL</span>,
it specifies the callback to look for, and the func and arg parameters are
ignored. If handle is <span class="symbol">NULL</span>, the function will look for
any callback for the
specified func and arg. Returns
<span class="symbol">True</span>
if a matching callback exists, else returns
<span class="symbol">False</span>.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Display_Queue_Functions"></a>Display Queue Functions</h2></div></div></div><p>
To use the functions and types defined in this section, you should include the
header file
<<code class="filename">X11/Xmu/DisplayQue.h</code>>
<a id="idp38518288" class="indexterm"></a>
and link against the libXmu library.
<code class="filename">DisplayQue.h</code> defines the following
types:
<a id="idp38520768" class="indexterm"></a>
<a id="XmuDisplayQueue"></a></p><pre class="synopsis">
typedef int (*XmuCloseDisplayQueueProc)(XmuDisplayQueue *queue,
XmuDisplayQueueEntry *entry);
typedef int (*XmuFreeDisplayQueueProc)(XmuDisplayQueue *queue);
typedef struct _XmuDisplayQueueEntry {
struct _XmuDisplayQueueEntry *prev, *next;
Display *display;
CloseHook closehook;
XPointer data;
} XmuDisplayQueueEntry;
typedef struct _XmuDisplayQueue {
int nentries;
XmuDisplayQueueEntry *head, *tail;
XmuCloseDisplayQueueProc closefunc;
XmuFreeDisplayQueueProc freefunc;
XPointer data;
} XmuDisplayQueue;
</pre><p>
</p><p><a id="XmuDQCreate"></a>
<a id="idp38524208" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">XmuDisplayQueue *<strong class="fsfunc">XmuDQCreate</strong>(</code>XmuCloseDisplayQueueProc <var class="pdparam">closefunc</var>, XmuFreeDisplayQueueProc <var class="pdparam">freefunc</var>, XPointer <var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>closefunc</code></em></span></p></td><td><p>
specifies the close function
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>freefunc</code></em></span></p></td><td><p>
specifies the free function
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
specifies private data for the functions
</p></td></tr></tbody></table></div><p>
This function creates and returns an empty
<span class="type">XmuDisplayQueue</span>
(which is really just a set of displays, but is called a queue for
historical reasons). The queue is initially empty, but displays
can be added using
<code class="function">XmuAddDisplay</code>.
The data value is simply stored in the queue for use by the closefunc
and freefunc callbacks.
Whenever a display in the queue is closed using
<code class="function">XCloseDisplay</code>,
the <em class="parameter"><code>closefunc</code></em> (if non-<span class="symbol">NULL</span>) is called with the queue and the display's
<code class="function">XmuDisplayQueueEntry</code>
as follows:
</p><pre class="programlisting">
(*closefunc)(queue, entry)
</pre><p>
</p><p>
The <em class="parameter"><code>freefunc</code></em> (if non-<span class="symbol">NULL</span>) is called whenever the last
display in the
queue is closed, as follows:
</p><pre class="programlisting">
(*freefunc)(queue)
</pre><p>
</p><p>
The application is responsible for actually freeing the queue, by calling
<code class="function">XmuDQDestroy</code>.
</p><p><a id="XmuDQAddDisplay"></a>
<a id="idp38543504" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">XmuDisplayQueueEntry *<strong class="fsfunc">XmuDQAddDisplay</strong>(</code>XmuDisplayQueue *<var class="pdparam">q</var>, Display *<var class="pdparam">dpy</var>, XPointer <var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>q</code></em></span></p></td><td><p>
specifies the queue
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the display to add
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
specifies private data for the free function
</p></td></tr></tbody></table></div><p>
This function adds the specified display to the queue. If successful,
the queue entry is returned, otherwise <span class="symbol">NULL</span> is returned.
The data value is simply stored in the queue entry for use by the
queue's freefunc callback. This function does not attempt to prevent
duplicate entries in the queue; the caller should use
<code class="function">XmuDQLookupDisplay</code>
to determine if a display has already been added to a queue.
</p><p><a id="XmuDQLookupDisplay"></a>
<a id="idp38556800" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">XmuDisplayQueueEntry *<strong class="fsfunc">XmuDQLookupDisplay</strong>(</code>XmuDisplayQueue *<var class="pdparam">q</var>, Display *<var class="pdparam">dpy</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>q</code></em></span></p></td><td><p>
specifies the queue
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the display to lookup
</p></td></tr></tbody></table></div><p>
This function returns the queue entry for the specified display, or
<span class="symbol">NULL</span> if
the display is not in the queue.
</p><p><a id="XmuDQNDisplays"></a>
<a id="idp38566592" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef"><strong class="fsfunc">XmuDQNDisplays</strong>(</code><var class="pdparam">q</var><code>)</code>;</p></div><p>
This macro returns the number of displays in the specified queue.
</p><p><a id="XmuDQRemoveDisplay"></a>
<a id="idp38571184" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Bool <strong class="fsfunc">XmuDQRemoveDisplay</strong>(</code>XmuDisplayQueue *<var class="pdparam">q</var>, Display *<var class="pdparam">dpy</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>q</code></em></span></p></td><td><p>
specifies the queue
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the display to remove
</p></td></tr></tbody></table></div><p>
This function removes the specified display from the specified queue.
No callbacks are performed.
If the display is not found in the queue,
<span class="symbol">False</span>
is returned, otherwise
<span class="symbol">True</span>
is returned.
</p><p><a id="XmuDQDestroy"></a>
<a id="idp38581440" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Bool <strong class="fsfunc">XmuDQDestroy</strong>(</code>XmuDisplayQueue *<var class="pdparam">q</var>, Bool <var class="pdparam">docallbacks</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>q</code></em></span></p></td><td><p>
specifies the queue to destroy
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>docallbacks</code></em></span></p></td><td><p>
specifies whether close functions should be called
</p></td></tr></tbody></table></div><p>
This function releases all memory associated with the specified queue.
If docallbacks is
<span class="symbol">True</span>,
then the queue's closefunc callback (if non-<span class="symbol">NULL</span>) is first called
for each display in the queue, even though
<code class="function">XCloseDisplay</code>
is not called on the display.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Toolkit_Convenience_Functions"></a>Toolkit Convenience Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/Initer.h</code>>
<a id="idp38594240" class="indexterm"></a>
and link against the libXmu library.
</p><p><a id="XmuAddInitializer"></a>
<a id="idp38596480" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuAddInitializer</strong>(</code>void <var class="pdparam">( *func )</var>
<code>(</code>XtAppContext, XPointer<code>)</code>, XPointer <var class="pdparam">data</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>func</code></em></span></p></td><td><p>
specifies the procedure to register
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>data</code></em></span></p></td><td><p>
specifies private data for the procedure
</p></td></tr></tbody></table></div><p>
This function registers a procedure, to be invoked the first time
<code class="function">XmuCallInitializers</code>
is called on a given application context. The procedure
is called with the application context and the specified data:
</p><pre class="programlisting">
(*func)(app_con, data)
</pre><p>
</p><p><a id="XmuCallInitializers"></a>
<a id="idp38607664" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuCallInitializers</strong>(</code>XtAppContext <var class="pdparam">app_con</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>app_con</code></em></span></p></td><td><p>
specifies the application context to initialize
</p></td></tr></tbody></table></div><p>
This function calls each of the procedures that have been registered with
<code class="function">XmuAddInitializer</code>,
if this is the first time the application context has been passed to
<code class="function">XmuCallInitializers</code>.
Otherwise, this function does nothing.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Standard_Colormap_Functions"></a>Standard Colormap Functions</h2></div></div></div><p>
To use the functions defined in this section, you should include the header
file
<<code class="filename">X11/Xmu/StdCmap.h</code>>
<a id="idp38617696" class="indexterm"></a>
and link against the libXmu library.
</p><p><a id="XmuAllStandardColormaps"></a>
<a id="idp38619936" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Status <strong class="fsfunc">XmuAllStandardColormaps</strong>(</code>Display *<var class="pdparam">dpy</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr></tbody></table></div><p>
<a id="idp38626112" class="indexterm"></a>
To create all of the appropriate standard colormaps for every visual of
every screen on a given display, use
<code class="function">XmuAllStandardColormaps</code>.
</p><p>
This function defines and retains as permanent resources all standard
colormaps which are meaningful for the visuals of each screen of the
display. It returns 0 on failure, non-zero on success. If the property of
any standard colormap is already defined, this function will redefine it.
</p><p>
This function is intended to be used by window managers or a special client
at the start of a session.
</p><p>
The standard colormaps of a screen are defined by properties associated with
the screen's root window. The property names of standard colormaps are
predefined, and each property name except
<span class="property">RGB_DEFAULT_MAP</span> may describe at
most one colormap.
</p><p>
The standard colormaps are: <span class="property">RGB_BEST_MAP</span>,
<span class="property">RGB_RED_MAP</span>, <span class="property">RGB_GREEN_MAP</span>,
<span class="property">RGB_BLUE_MAP</span>, <span class="property">RGB_DEFAULT_MAP</span>,
and <span class="property">RGB_GRAY_MAP</span>. Therefore a screen may
have at most 6 standard colormap properties defined.
</p><p>
A standard colormap is associated with a particular visual of the screen. A
screen may have multiple visuals defined, including visuals of the same
class at different depths. Note that a visual id might be repeated for more
than one depth, so the visual id and the depth of a visual identify the
visual. The characteristics of the visual will determine which standard
colormaps are meaningful under that visual, and will determine how the
standard colormap is defined. Because a standard colormap is associated
with a specific visual, there must be a method of determining which visuals
take precedence in defining standard colormaps.
</p><p>
The method used here is: for the visual of greatest depth, define all
standard colormaps meaningful to that visual class, according to this order
of (descending) precedence:
<span class="symbol">DirectColor</span>;
<span class="symbol">PseudoColor</span>;
<span class="symbol">TrueColor</span>
and
<span class="symbol">GrayScale</span>;
and finally
<span class="symbol">StaticColor</span>
and
<span class="symbol">StaticGray</span>.
</p><p>This function allows success, on a per screen basis. For example, if a map
on screen 1 fails, the maps on screen 0, created earlier, will remain.
However, none on screen 1 will remain. If a map on screen 0 fails, none
will remain.
</p><p>
See
<a class="link" href="#XmuVisualStandardColormaps"><code class="function">XmuVisualStandardColormaps</code></a>
for which standard colormaps are meaningful under these classes of visuals.
</p><p><a id="XmuVisualStandardColormaps"></a>
<a id="idp38642080" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Status <strong class="fsfunc">XmuVisualStandardColormaps</strong>(</code>Display *<var class="pdparam">dpy</var>, int <var class="pdparam">screen</var>, VisualID <var class="pdparam">visualid</var>, unsigned int <var class="pdparam">depth</var>, Bool <var class="pdparam">replace</var>, Bool <var class="pdparam">retain</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>screen</code></em></span></p></td><td><p>
specifies the screen of the display
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>visualid</code></em></span></p></td><td><p>
specifies the visual type
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>depth</code></em></span></p></td><td><p>
specifies the visual depth
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>replace</code></em></span></p></td><td><p>
specifies whether or not to replace
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>retain</code></em></span></p></td><td><p>
specifies whether or not to retain
</p></td></tr></tbody></table></div><p>
To create all of the appropriate standard colormaps for a given visual on a
given screen, use
<code class="function">XmuVisualStandardColormaps</code>.
</p><p>
This function defines all appropriate standard colormap properties for the
given visual. If replace is
<span class="symbol">True</span>,
any previous definition will be removed.
If retain is
<span class="symbol">True</span>,
new properties will be retained for the duration of the
server session. This function returns 0 on failure, non-zero on success.
On failure, no new properties will be defined, but old ones may have been
removed if replace was <span class="symbol">True</span>.
</p><p>
Not all standard colormaps are meaningful to all visual classes. This
routine will check and define the following properties for the following
classes, provided that the size of the colormap is not too small. For
<span class="symbol">DirectColor</span>
and
<span class="symbol">PseudoColor</span>:
<span class="property">RGB_DEFAULT_MAP</span>, <span class="property">RGB_BEST_MAP</span>,
<span class="property">RGB_RED_MAP</span>, <span class="property">RGB_GREEN_MAP</span>,
<span class="property">RGB_BLUE_MAP</span>, and <span class="property">RGB_GRAY_MAP</span>.
For
<span class="symbol">TrueColor</span>
and
<span class="symbol">StaticColor</span>:
<span class="property">RGB_BEST_MAP</span>. For
<span class="symbol">GrayScale</span>
and
<span class="symbol">StaticGray</span>:
<span class="property">RGB_GRAY_MAP</span>.
</p><p><a id="XmuLookupStandardColormap"></a>
<a id="idp38672160" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Status <strong class="fsfunc">XmuLookupStandardColormap</strong>(</code>Display *<var class="pdparam">dpy</var>, int <var class="pdparam">screen</var>, VisualID <var class="pdparam">visualid</var>, unsigned int <var class="pdparam">depth</var>, Atom <var class="pdparam">property</var>, Bool <var class="pdparam">replace</var>, Bool <var class="pdparam">retain</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>screen</code></em></span></p></td><td><p>
specifies the screen of the display
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>visualid</code></em></span></p></td><td><p>
specifies the visual type
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>depth</code></em></span></p></td><td><p>
specifies the visual depth
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>property</code></em></span></p></td><td><p>
specifies the standard colormap property
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>replace</code></em></span></p></td><td><p>
specifies whether or not to replace
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>retain</code></em></span></p></td><td><p>
specifies whether or not to retain
</p></td></tr></tbody></table></div><p>
To create a standard colormap if one does not currently exist, or replace
the currently existing standard colormap, use
<code class="function">XmuLookupStandardColormap</code>.
</p><p>
Given a screen, a visual, and a property, this function will determine the
best allocation for the property under the specified visual, and determine
the whether to create a new colormap or to use the default colormap of the
screen.
</p><p>
If replace is True, any previous definition of the property will be
replaced. If retain is True, the property and the colormap will be made
permanent for the duration of the server session. However, pre-existing
property definitions which are not replaced cannot be made permanent by a
call to this function; a request to retain resources pertains to newly
created resources.
</p><p>
This function returns 0 on failure, non-zero on success. A request to
create a standard colormap upon a visual which cannot support such a map is
considered a failure. An example of this would be requesting any standard
colormap property on a monochrome visual, or, requesting an
<span class="property">RGB_BEST_MAP</span> on
a display whose colormap size is 16.
</p><p><a id="XmuGetColormapAllocation"></a>
<a id="idp38697632" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Status <strong class="fsfunc">XmuGetColormapAllocation</strong>(</code>XVisualInfo *<var class="pdparam">vinfo</var>, Atom <var class="pdparam">property</var>, unsigned long *<var class="pdparam">red_max</var>, unsigned long *<var class="pdparam">green_max</var>, unsigned long *<var class="pdparam">blue_max</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>vinfo</code></em></span></p></td><td><p>
specifies visual information for a chosen visual
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>property</code></em></span></p></td><td><p>
specifies one of the standard colormap property names
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>red_max</code></em></span></p></td><td><p>
returns maximum red value</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>green_max</code></em></span></p></td><td><p>
returns maximum green value
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>blue_max</code></em></span></p></td><td><p>
returns maximum blue value
</p></td></tr></tbody></table></div><p>
To determine the best allocation of reds, greens, and blues in a standard
colormap, use
<code class="function">XmuGetColormapAllocation</code>.
</p><p>
<code class="function">XmuGetColormapAllocation</code>
returns 0 on failure, non-zero on success. It is
assumed that the visual is appropriate for the colormap property.
</p><p><a id="XmuStandardColormap"></a>
<a id="idp38716640" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">XStandardColormap *<strong class="fsfunc">XmuStandardColormap</strong>(</code>Display *<var class="pdparam">dpy</var>, int <var class="pdparam">screen</var>, VisualID <var class="pdparam">visualid</var>, unsigned int <var class="pdparam">depth</var>, Atom <var class="pdparam">property</var>, Colormap <var class="pdparam">cmap</var>, unsigned long <var class="pdparam">red_max</var>, unsigned long <var class="pdparam">green_max</var>, unsigned long <var class="pdparam">blue_max</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>screen</code></em></span></p></td><td><p>
specifies the screen of the display
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>visualid</code></em></span></p></td><td><p>
specifies the visual type
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>depth</code></em></span></p></td><td><p>
specifies the visual depth
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>property</code></em></span></p></td><td><p>
specifies the standard colormap property
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>cmap</code></em></span></p></td><td><p>
specifies the colormap ID, or None
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>red_max</code></em></span></p></td><td><p>
specifies the red allocation
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>green_max</code></em></span></p></td><td><p>
specifies the green allocation
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>blue_max</code></em></span></p></td><td><p>
specifies the blue allocation
</p></td></tr></tbody></table></div><p>
To create any one standard colormap, use
<code class="function">XmuStandardColormap</code>.
</p><p>
This function creates a standard colormap for the given screen, visualid,
and visual depth, with the given red, green, and blue maximum values, with
the given standard property name. Upon success, it returns a pointer to an
<code class="function">XStandardColormap</code>
structure which describes the newly created colormap.
Upon failure, it returns <span class="symbol">NULL</span>.
If cmap is the default colormap of the screen, the standard colormap
will be defined on the default colormap; otherwise a new colormap is created.
</p><p>
Resources created by this function are not made permanent; that is the
caller's responsibility.
</p><p><a id="XmuCreateColormap"></a>
<a id="idp38746688" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">Status <strong class="fsfunc">XmuCreateColormap</strong>(</code>Display *<var class="pdparam">dpy</var>, XStandardColormap *<var class="pdparam">colormap</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection under which the map is created
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>colormap</code></em></span></p></td><td><p>
specifies the map to be created</p></td></tr></tbody></table></div><p>
To create any one colormap which is described by an
<span class="structname">XStandardColormap</span>
structure, use
<code class="function">XmuCreateColormap</code>.
</p><p>
This function returns 0 on failure, and non-zero on success. The base_pixel
of the colormap is set on success. Resources created by this function are
not made permanent. No argument error checking is provided; use at your own
risk.
</p><p>
All colormaps are created with read-only allocations, with the exception of
read-only allocations of colors which fail
to return the expected pixel value, and these are individually defined as
read/write allocations. This is done so that all the cells defined in the
colormap are contiguous, for use in image processing. This typically
happens with White and Black in the default map.
</p><p>
Colormaps of static visuals are considered to be successfully created if the
map of the static visual matches the definition given in the standard
colormap structure.
</p><p><a id="XmuDeleteStandardColormap"></a>
<a id="idp38759120" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuDeleteStandardColormap</strong>(</code>Display *<var class="pdparam">dpy</var>, Screen *<var class="pdparam">screen</var>, Atom <var class="pdparam">property</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>dpy</code></em></span></p></td><td><p>
specifies the connection to the X server
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>screen</code></em></span></p></td><td><p>
specifies the screen of the display
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>property</code></em></span></p></td><td><p>
specifies the standard colormap property
</p></td></tr></tbody></table></div><p>
To remove any standard colormap property, use
<code class="function">XmuDeleteStandardColormap</code>.
This function will remove the specified property from the specified screen,
releasing any resources used by the colormap(s) of the property, if
possible.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Widget_Description_Functions"></a>Widget Description Functions</h2></div></div></div><p>
The functions defined in this section are for building a description of
the structure of and resources associated with a hierarchy of widget classes.
This package is typically used by applications that wish to manipulate the
widget set itself.
</p><p>
The definitions needed to use these interfaces are in the header file
<<code class="filename">X11/Xmu/WidgetNode.h</code>>
<a id="idp38774224" class="indexterm"></a>.
To call these functions, you need to link against the libXmu library.
The following function must be called before any of the others described
below:
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuWnInitializeNodes</strong>(</code>XmuWidgetNode *<var class="pdparam">node_array</var>, int <var class="pdparam">num_nodes</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>node_array</code></em></span></p></td><td><p>
specifies a list of widget classes, in alphabetical order
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_nodes</code></em></span></p></td><td><p>
specifies the number of widget classes in the node array
</p></td></tr></tbody></table></div><p>
</p><p>
To determine the resources provided by a widget class or classes, use
</p><div class="funcsynopsis"><p><code class="funcdef">void <strong class="fsfunc">XmuWnFetchResources</strong>(</code>XmuWidgetNode *<var class="pdparam">node</var>, Widget <var class="pdparam">toplevel</var>, XmuWidgetNode *<var class="pdparam">top_node</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>node</code></em></span></p></td><td><p>
specifies the widget class for which resources should be obtained.
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>toplevel</code></em></span></p></td><td><p>
specifies the widget that should be used for creating an instance of
<em class="parameter"><code>node</code></em>
from which resources are extracted. This is typically the value returned
by <span class="olink"><code class="function">XtAppInitialize</code></span>.
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>top_node</code></em></span></p></td><td><p>
specifies the ancestor of <em class="parameter"><code>node</code></em> that should be
treated as the root
of the widget inheritance tree (used in determining which ancestor contributed
which resources).
</p></td></tr></tbody></table></div><p>
</p><p>
Each widget class inherits the resources of its parent. To count the number
of resources contributed by a particular widget class, use:
</p><div class="funcsynopsis"><p><code class="funcdef">int <strong class="fsfunc">XmuWnCountOwnedResources</strong>(</code>XmuWidgetNode *<var class="pdparam">node</var>, XmuWidgetNode *<var class="pdparam">owner_node</var>, Bool <var class="pdparam">constraints</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>node</code></em></span></p></td><td><p>
specifies the widget class whose resources are being examined.
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>owner_node</code></em></span></p></td><td><p>
specifies the widget class of the ancestor of <em class="parameter"><code>node</code></em>
whose contributions
are being counted.
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>constraints</code></em></span></p></td><td><p>
specifies whether or not to count constraint resources or normal resources.
</p></td></tr></tbody></table></div><p>
This routine returns the number of resources contributed (or
“owned”) by
the specified widget class.
</p><p><a id="XmuWnNameToNode"></a>
<a id="idp38808064" class="indexterm"></a>
</p><div class="funcsynopsis"><p><code class="funcdef">XmuWidgetNode *<strong class="fsfunc">XmuWnNameToNode</strong>(</code>XmuWidgetNode *<var class="pdparam">node_list</var>, int <var class="pdparam">num_nodes</var>, char *<var class="pdparam">name</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term"><em class="parameter"><code>node_list</code></em></span></p></td><td><p>
specifies a list of widget nodes
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>num_nodes</code></em></span></p></td><td><p>
specifies the number of nodes in the list
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>name</code></em></span></p></td><td><p>
specifies the name of the widget class in the node list to search for
</p></td></tr></tbody></table></div><p>
This function returns the WidgetNode in the list that matches the given
widget name or widget class name. If no match is found, it returns
<span class="symbol">NULL</span>.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Participation_in_the_Editres_Protocol"></a>Participation in the Editres Protocol</h2></div></div></div><p>
<a id="idp38821328" class="indexterm"></a>
To participate in the editres protocol, applications which are not based
on the Athena widget set should include the header file
<<code class="filename">X11/Xmu/Editres.h</code>>
<a id="idp38823472" class="indexterm"></a>
and link against the libXmu library.
</p><p>
To participate in the editres protocol, Xt applications which do not rely
on the Athena widget set should register the editres protocol handler on
each shell widget in the application, specifying an event mask of 0,
nonmaskable events, and client data as <span class="symbol">NULL</span>:
</p><pre class="programlisting">
XtAddEventHandler(shell, (EventMask) 0, True, _XEditResCheckMessages, NULL);
</pre><p>
</p></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a id="idp38827104"></a>Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3></h3><dl><dt>, <a class="indexterm" href="#XmuMakeAtom">Atom Functions</a>, <a class="indexterm" href="#XmuNameOfAtom">Atom Functions</a>, <a class="indexterm" href="#XmuInternAtom">Atom Functions</a>, <a class="indexterm" href="#XmuGetAtomName">Atom Functions</a>, <a class="indexterm" href="#XmuInternStrings">Atom Functions</a>, <a class="indexterm" href="#XmuPrintDefaultErrorMessage">Error Handler Functions</a></dt></dl></div><div class="indexdiv"><h3>A</h3><dl><dt>Atom, <a class="indexterm" href="#idp32216240">Atom Functions</a></dt></dl></div><div class="indexdiv"><h3>B</h3><dl><dt>backing-store, <a class="indexterm" href="#XmuCvtStringToBackingStore">Type Converter Functions</a></dt><dt>bitmapFilePath, <a class="indexterm" href="#XmuLocateBitmapFile">Graphics Functions</a></dt></dl></div><div class="indexdiv"><h3>C</h3><dl><dt>colormaps</dt><dd><dl><dt>standard, <a class="indexterm" href="#idp38626112">Standard Colormap Functions</a></dt></dl></dd><dt>Cursor, <a class="indexterm" href="#XmuCvtStringToColorCursor">Type Converter Functions</a>, <a class="indexterm" href="#XmuCvtStringToCursor">Type Converter Functions</a></dt></dl></div><div class="indexdiv"><h3>E</h3><dl><dt>editres, <a class="indexterm" href="#idp38821328">Participation in the Editres Protocol</a></dt></dl></div><div class="indexdiv"><h3>P</h3><dl><dt>pkg-config, <a class="indexterm" href="#idp35705280">Introduction</a></dt></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>Shape extension, <a class="indexterm" href="#XmuReshapeWidget">Type Converter Functions</a></dt></dl></div><div class="indexdiv"><h3>W</h3><dl><dt>window manager icons, <a class="indexterm" href="#XmuCvtStringToBitmap">Type Converter Functions</a></dt><dt>WM_STATE, <a class="indexterm" href="#XmuClientWindow">Window Utility Functions</a></dt></dl></div><div class="indexdiv"><h3>X</h3><dl><dt>X11/Xmu/Atoms.h, <a class="indexterm" href="#idp32264544">Atom Functions</a></dt><dt>X11/Xmu/CharSet.h, <a class="indexterm" href="#idp38106672">Character Set Functions</a></dt><dt>X11/Xmu/CloseHook.h, <a class="indexterm" href="#idp38464464">CloseDisplay Hook Functions</a></dt><dt>X11/Xmu/Converters.h, <a class="indexterm" href="#idp37851504">Type Converter Functions</a></dt><dt>X11/Xmu/CurUtil.h, <a class="indexterm" href="#idp37596160">Cursor Utility Functions</a></dt><dt>X11/Xmu/DisplayQue.h, <a class="indexterm" href="#idp38518288">Display Queue Functions</a></dt><dt>X11/Xmu/Drawing.h, <a class="indexterm" href="#idp37607552">Graphics Functions</a></dt><dt>X11/Xmu/Editres.h, <a class="indexterm" href="#idp38823472">Participation in the Editres Protocol</a></dt><dt>X11/Xmu/Error.h, <a class="indexterm" href="#idp37489024">Error Handler Functions</a></dt><dt>X11/Xmu/Initer.h, <a class="indexterm" href="#idp38594240">Toolkit Convenience Functions</a></dt><dt>X11/Xmu/Lookup.h, <a class="indexterm" href="#idp38173712">Keyboard Event Translation Functions</a></dt><dt>X11/Xmu/StdCmap.h, <a class="indexterm" href="#idp38617696">Standard Colormap Functions</a></dt><dt>X11/Xmu/StdSel.h, <a class="indexterm" href="#idp37821872">Selection Functions</a></dt><dt>X11/Xmu/SysUtil.h, <a class="indexterm" href="#idp37519392">System Utility Functions</a></dt><dt>X11/Xmu/WidgetNode.h, <a class="indexterm" href="#idp38774224">Widget Description Functions</a></dt><dt>X11/Xmu/WinUtil.h, <a class="indexterm" href="#idp37547600">Window Utility Functions</a></dt><dt>X11/Xmu/Xct.h, <a class="indexterm" href="#idp38381744">Compound Text Functions</a></dt><dt>XctCreate, <a class="indexterm" href="#XctCreate">Compound Text Functions</a></dt><dt>XctData, <a class="indexterm" href="#XctData">Compound Text Functions</a></dt><dt>XctNextItem, <a class="indexterm" href="#XctNextItem">Compound Text Functions</a></dt><dt>XctReset, <a class="indexterm" href="#XctReset">Compound Text Functions</a></dt><dt>XGetWMNormalHints, <a class="indexterm" href="#XmuUpdateMapHints">Window Utility Functions</a></dt><dt>XmuAddCloseDisplayHook, <a class="indexterm" href="#XmuAddCloseDisplayHook">CloseDisplay Hook Functions</a></dt><dt>XmuAddInitializer, <a class="indexterm" href="#XmuAddInitializer">Toolkit Convenience Functions</a></dt><dt>XmuAllStandardColormaps, <a class="indexterm" href="#XmuAllStandardColormaps">Standard Colormap Functions</a></dt><dt>XmuCallInitializers, <a class="indexterm" href="#XmuCallInitializers">Toolkit Convenience Functions</a></dt><dt>XmuClientWindow, <a class="indexterm" href="#XmuClientWindow">Window Utility Functions</a></dt><dt>XmuCompareISOLatin1, <a class="indexterm" href="#XmuCompareISOLatin1">Character Set Functions</a></dt><dt>XmuConvertStandardSelection, <a class="indexterm" href="#XmuConvertStandardSelection">Selection Functions</a></dt><dt>XmuCopyISOLatin1Lowered, <a class="indexterm" href="#XmuCopyISOLatin1Lowered">Character Set Functions</a></dt><dt>XmuCopyISOLatin1Uppered, <a class="indexterm" href="#XmuCopyISOLatin1Uppered">Character Set Functions</a></dt><dt>XmuCreateColormap, <a class="indexterm" href="#XmuCreateColormap">Standard Colormap Functions</a></dt><dt>XmuCreatePixmapFromBitmap, <a class="indexterm" href="#XmuCreatePixmapFromBitmap">Graphics Functions</a></dt><dt>XmuCreateStippledPixmap, <a class="indexterm" href="#XmuCreateStippledPixmap">Graphics Functions</a></dt><dt>XmuCursorNameToIndex, <a class="indexterm" href="#XmuCursorNameToIndex">Cursor Utility Functions</a></dt><dt>XmuCvtFunctionToCallback, <a class="indexterm" href="#XmuCvtFunctionToCallback">Type Converter Functions</a></dt><dt>XmuCvtStringToBackingStore, <a class="indexterm" href="#XmuCvtStringToBackingStore">Type Converter Functions</a></dt><dt>XmuCvtStringToBitmap, <a class="indexterm" href="#XmuCvtStringToBitmap">Type Converter Functions</a></dt><dt>XmuCvtStringToColorCursor, <a class="indexterm" href="#XmuCvtStringToColorCursor">Type Converter Functions</a></dt><dt>XmuCvtStringToCursor, <a class="indexterm" href="#XmuCvtStringToCursor">Type Converter Functions</a></dt><dt>XmuCvtStringToGravity, <a class="indexterm" href="#XmuCvtStringToGravity">Type Converter Functions</a></dt><dt>XmuCvtStringToJustify, <a class="indexterm" href="#XmuCvtStringToJustify">Type Converter Functions</a></dt><dt>XmuCvtStringToLong, <a class="indexterm" href="#XmuCvtStringToLong">Type Converter Functions</a></dt><dt>XmuCvtStringToOrientation, <a class="indexterm" href="#XmuCvtStringToOrientation">Type Converter Functions</a></dt><dt>XmuCvtStringToShapeStyle, <a class="indexterm" href="#XmuCvtStringToShapeStyle">Type Converter Functions</a></dt><dt>XmuCvtStringToWidget, <a class="indexterm" href="#XmuCvtStringToWidget">Type Converter Functions</a></dt><dt>XmuDeleteStandardColormap, <a class="indexterm" href="#XmuDeleteStandardColormap">Standard Colormap Functions</a></dt><dt>XmuDisplayQueue, <a class="indexterm" href="#XmuDisplayQueue">Display Queue Functions</a></dt><dt>XmuDQAddDisplay, <a class="indexterm" href="#XmuDQAddDisplay">Display Queue Functions</a></dt><dt>XmuDQCreate, <a class="indexterm" href="#XmuDQCreate">Display Queue Functions</a></dt><dt>XmuDQDestroy, <a class="indexterm" href="#XmuDQDestroy">Display Queue Functions</a></dt><dt>XmuDQLookupDisplay, <a class="indexterm" href="#XmuDQLookupDisplay">Display Queue Functions</a></dt><dt>XmuDQNDisplays, <a class="indexterm" href="#XmuDQNDisplays">Display Queue Functions</a></dt><dt>XmuDQRemoveDisplay, <a class="indexterm" href="#XmuDQRemoveDisplay">Display Queue Functions</a></dt><dt>XmuDrawLogo, <a class="indexterm" href="#XmuDrawLogo">Graphics Functions</a></dt><dt>XmuDrawRoundedRectangle, <a class="indexterm" href="#XmuDrawRoundedRectangle">Graphics Functions</a></dt><dt>XmuFillRoundedRectangle, <a class="indexterm" href="#XmuFillRoundedRectangle">Graphics Functions</a></dt><dt>XmuGetColormapAllocation, <a class="indexterm" href="#XmuGetColormapAllocation">Standard Colormap Functions</a></dt><dt>XmuGetHostname, <a class="indexterm" href="#XmuGetHostname">System Utility Functions</a></dt><dt>XmuLocateBitmapFile, <a class="indexterm" href="#XmuLocateBitmapFile">Graphics Functions</a></dt><dt>XmuLookupAPL, <a class="indexterm" href="#XmuLookupAPL">Keyboard Event Translation Functions</a></dt><dt>XmuLookupArabic, <a class="indexterm" href="#XmuLookupArabic">Keyboard Event Translation Functions</a></dt><dt>XmuLookupCloseDisplayHook, <a class="indexterm" href="#XmuLookupCloseDisplayHook">CloseDisplay Hook Functions</a></dt><dt>XmuLookupCyrillic, <a class="indexterm" href="#XmuLookupCyrillic">Keyboard Event Translation Functions</a></dt><dt>XmuLookupGreek, <a class="indexterm" href="#XmuLookupGreek">Keyboard Event Translation Functions</a></dt><dt>XmuLookupHebrew, <a class="indexterm" href="#XmuLookupHebrew">Keyboard Event Translation Functions</a></dt><dt>XmuLookupJISX0201, <a class="indexterm" href="#XmuLookupJISX0201">Keyboard Event Translation Functions</a></dt><dt>XmuLookupKana, <a class="indexterm" href="#XmuLookupKana">Keyboard Event Translation Functions</a></dt><dt>XmuLookupLatin1, <a class="indexterm" href="#XmuLookupLatin1">Keyboard Event Translation Functions</a></dt><dt>XmuLookupLatin2, <a class="indexterm" href="#XmuLookupLatin2">Keyboard Event Translation Functions</a></dt><dt>XmuLookupLatin3, <a class="indexterm" href="#XmuLookupLatin3">Keyboard Event Translation Functions</a></dt><dt>XmuLookupLatin4, <a class="indexterm" href="#XmuLookupLatin4">Keyboard Event Translation Functions</a></dt><dt>XmuLookupStandardColormap, <a class="indexterm" href="#XmuLookupStandardColormap">Standard Colormap Functions</a></dt><dt>XmuNCopyISOLatin1Lowered, <a class="indexterm" href="#XmuNCopyISOLatin1Lowered">Character Set Functions</a></dt><dt>XmuNCopyISOLatin1Uppered, <a class="indexterm" href="#XmuNCopyISOLatin1Uppered">Character Set Functions</a></dt><dt>XmuNewCvtStringToWidget, <a class="indexterm" href="#XmuNewCvtStringToWidget">Type Converter Functions</a></dt><dt>XmuReadBitmapData, <a class="indexterm" href="#XmuReadBitmapData">Graphics Functions</a></dt><dt>XmuReadBitmapDataFromFile, <a class="indexterm" href="#XmuReadBitmapDataFromFile">Graphics Functions</a></dt><dt>XmuReleaseStippledPixmap, <a class="indexterm" href="#XmuReleaseStippledPixmap">Graphics Functions</a></dt><dt>XmuRemoveCloseDisplayHook, <a class="indexterm" href="#XmuRemoveCloseDisplayHook">CloseDisplay Hook Functions</a></dt><dt>XmuReshapeWidget, <a class="indexterm" href="#XmuReshapeWidget">Type Converter Functions</a></dt><dt>XmuScreenOfWindow, <a class="indexterm" href="#XmuScreenOfWindow">Window Utility Functions</a></dt><dt>XmuSimpleErrorHandler, <a class="indexterm" href="#XmuSimpleErrorHandler">Error Handler Functions</a></dt><dt>XmuSnprintf, <a class="indexterm" href="#XmuSnprintf">System Utility Functions</a></dt><dt>XmuStandardColormap, <a class="indexterm" href="#XmuStandardColormap">Standard Colormap Functions</a></dt><dt>XmuUpdateMapHints, <a class="indexterm" href="#XmuUpdateMapHints">Window Utility Functions</a></dt><dt>XmuVisualStandardColormaps, <a class="indexterm" href="#XmuVisualStandardColormaps">Standard Colormap Functions</a></dt><dt>XmuWnNameToNode, <a class="indexterm" href="#XmuWnNameToNode">Widget Description Functions</a></dt><dt>XSetWMNormalHints, <a class="indexterm" href="#XmuUpdateMapHints">Window Utility Functions</a></dt><dt>XtGravity, <a class="indexterm" href="#XmuCvtStringToGravity">Type Converter Functions</a></dt><dt>XtJustify, <a class="indexterm" href="#XmuCvtStringToJustify">Type Converter Functions</a></dt><dt>XtOrientation, <a class="indexterm" href="#XmuCvtStringToOrientation">Type Converter Functions</a></dt></dl></div></div></div></div></body></html>
|