/usr/include/xcb/xcb_ewmh.h is in libxcb-ewmh1-dev 0.3.8-1build1.
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 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 | #ifndef __XCB_EWMH_H__
#define __XCB_EWMH_H__
/*
* Copyright (C) 2009-2011 Arnaud Fontaine <arnau@debian.org>
*
* 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 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 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.
*
* Except as contained in this notice, the names of the authors or
* their institutions 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 authors.
*/
/**
* @defgroup xcb__ewmh_t XCB EWMH Functions
*
* These functions allow easy handling of the protocol described in
* the Extended Window Manager Hints specification. The list of Atoms
* is stored as an M4 file (atomlist.m4) where each Atom is stored as
* a variable defined in the header.
*
* Replies of requests generating a list of pointers (such as list of
* windows, atoms and UTF-8 strings) are simply stored as a structure
* holding the XCB reply which should (usually) never be accessed
* directly and has to be wipe afterwards. This structure provides a
* convenient access to the list given in the reply itself.
*
* @{
*/
#include <xcb/xcb.h>
#include <stdlib.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Hold EWMH information specific to a screen
*/
typedef struct {
/** The X connection */
xcb_connection_t *connection;
/** The screens on this connection */
xcb_screen_t **screens;
int nb_screens;
/** _NET_WM_CM_Sn atoms depending on the number of screens */
xcb_atom_t *_NET_WM_CM_Sn;
/** The EWMH atoms of this connection */
xcb_atom_t _NET_SUPPORTED;
xcb_atom_t _NET_CLIENT_LIST;
xcb_atom_t _NET_CLIENT_LIST_STACKING;
xcb_atom_t _NET_NUMBER_OF_DESKTOPS;
xcb_atom_t _NET_DESKTOP_GEOMETRY;
xcb_atom_t _NET_DESKTOP_VIEWPORT;
xcb_atom_t _NET_CURRENT_DESKTOP;
xcb_atom_t _NET_DESKTOP_NAMES;
xcb_atom_t _NET_ACTIVE_WINDOW;
xcb_atom_t _NET_WORKAREA;
xcb_atom_t _NET_SUPPORTING_WM_CHECK;
xcb_atom_t _NET_VIRTUAL_ROOTS;
xcb_atom_t _NET_DESKTOP_LAYOUT;
xcb_atom_t _NET_SHOWING_DESKTOP;
xcb_atom_t _NET_CLOSE_WINDOW;
xcb_atom_t _NET_MOVERESIZE_WINDOW;
xcb_atom_t _NET_WM_MOVERESIZE;
xcb_atom_t _NET_RESTACK_WINDOW;
xcb_atom_t _NET_REQUEST_FRAME_EXTENTS;
xcb_atom_t _NET_WM_NAME;
xcb_atom_t _NET_WM_VISIBLE_NAME;
xcb_atom_t _NET_WM_ICON_NAME;
xcb_atom_t _NET_WM_VISIBLE_ICON_NAME;
xcb_atom_t _NET_WM_DESKTOP;
xcb_atom_t _NET_WM_WINDOW_TYPE;
xcb_atom_t _NET_WM_STATE;
xcb_atom_t _NET_WM_ALLOWED_ACTIONS;
xcb_atom_t _NET_WM_STRUT;
xcb_atom_t _NET_WM_STRUT_PARTIAL;
xcb_atom_t _NET_WM_ICON_GEOMETRY;
xcb_atom_t _NET_WM_ICON;
xcb_atom_t _NET_WM_PID;
xcb_atom_t _NET_WM_HANDLED_ICONS;
xcb_atom_t _NET_WM_USER_TIME;
xcb_atom_t _NET_WM_USER_TIME_WINDOW;
xcb_atom_t _NET_FRAME_EXTENTS;
xcb_atom_t _NET_WM_PING;
xcb_atom_t _NET_WM_SYNC_REQUEST;
xcb_atom_t _NET_WM_SYNC_REQUEST_COUNTER;
xcb_atom_t _NET_WM_FULLSCREEN_MONITORS;
xcb_atom_t _NET_WM_FULL_PLACEMENT;
xcb_atom_t UTF8_STRING;
xcb_atom_t WM_PROTOCOLS;
xcb_atom_t MANAGER;
xcb_atom_t _NET_WM_WINDOW_TYPE_DESKTOP;
xcb_atom_t _NET_WM_WINDOW_TYPE_DOCK;
xcb_atom_t _NET_WM_WINDOW_TYPE_TOOLBAR;
xcb_atom_t _NET_WM_WINDOW_TYPE_MENU;
xcb_atom_t _NET_WM_WINDOW_TYPE_UTILITY;
xcb_atom_t _NET_WM_WINDOW_TYPE_SPLASH;
xcb_atom_t _NET_WM_WINDOW_TYPE_DIALOG;
xcb_atom_t _NET_WM_WINDOW_TYPE_DROPDOWN_MENU;
xcb_atom_t _NET_WM_WINDOW_TYPE_POPUP_MENU;
xcb_atom_t _NET_WM_WINDOW_TYPE_TOOLTIP;
xcb_atom_t _NET_WM_WINDOW_TYPE_NOTIFICATION;
xcb_atom_t _NET_WM_WINDOW_TYPE_COMBO;
xcb_atom_t _NET_WM_WINDOW_TYPE_DND;
xcb_atom_t _NET_WM_WINDOW_TYPE_NORMAL;
xcb_atom_t _NET_WM_STATE_MODAL;
xcb_atom_t _NET_WM_STATE_STICKY;
xcb_atom_t _NET_WM_STATE_MAXIMIZED_VERT;
xcb_atom_t _NET_WM_STATE_MAXIMIZED_HORZ;
xcb_atom_t _NET_WM_STATE_SHADED;
xcb_atom_t _NET_WM_STATE_SKIP_TASKBAR;
xcb_atom_t _NET_WM_STATE_SKIP_PAGER;
xcb_atom_t _NET_WM_STATE_HIDDEN;
xcb_atom_t _NET_WM_STATE_FULLSCREEN;
xcb_atom_t _NET_WM_STATE_ABOVE;
xcb_atom_t _NET_WM_STATE_BELOW;
xcb_atom_t _NET_WM_STATE_DEMANDS_ATTENTION;
xcb_atom_t _NET_WM_ACTION_MOVE;
xcb_atom_t _NET_WM_ACTION_RESIZE;
xcb_atom_t _NET_WM_ACTION_MINIMIZE;
xcb_atom_t _NET_WM_ACTION_SHADE;
xcb_atom_t _NET_WM_ACTION_STICK;
xcb_atom_t _NET_WM_ACTION_MAXIMIZE_HORZ;
xcb_atom_t _NET_WM_ACTION_MAXIMIZE_VERT;
xcb_atom_t _NET_WM_ACTION_FULLSCREEN;
xcb_atom_t _NET_WM_ACTION_CHANGE_DESKTOP;
xcb_atom_t _NET_WM_ACTION_CLOSE;
xcb_atom_t _NET_WM_ACTION_ABOVE;
xcb_atom_t _NET_WM_ACTION_BELOW;
} xcb_ewmh_connection_t;
/**
* @brief Hold a GetProperty reply containing a list of Atoms
*/
typedef struct {
/** The number of Atoms */
uint32_t atoms_len;
/** The list of Atoms */
xcb_atom_t *atoms;
/** The actual GetProperty reply */
xcb_get_property_reply_t *_reply;
} xcb_ewmh_get_atoms_reply_t;
/**
* @brief Hold a GetProperty reply containing a list of Windows
*/
typedef struct {
/** The number of Windows */
uint32_t windows_len;
/** The list of Windows */
xcb_window_t *windows;
/** The actual GetProperty reply */
xcb_get_property_reply_t *_reply;
} xcb_ewmh_get_windows_reply_t;
/**
* @brief Hold a GetProperty reply containg a list of UTF-8 strings
*/
typedef struct {
/** The number of UTF-8 strings */
uint32_t strings_len;
/** The list of UTF-8 strings */
char *strings;
/** The actual GetProperty reply */
xcb_get_property_reply_t *_reply;
} xcb_ewmh_get_utf8_strings_reply_t;
/**
* @brief Coordinates Property values
*/
typedef struct {
/** The x coordinate */
uint32_t x;
/** The y coordinate */
uint32_t y;
} xcb_ewmh_coordinates_t;
/**
* @brief Hold reply of _NET_DESKTOP_VIEWPORT GetProperty
*/
typedef struct {
/** The number of desktop viewports */
uint32_t desktop_viewport_len;
/** The desktop viewports */
xcb_ewmh_coordinates_t *desktop_viewport;
/** The actual GetProperty reply */
xcb_get_property_reply_t *_reply;
} xcb_ewmh_get_desktop_viewport_reply_t;
/**
* @brief Geometry Property values
*/
typedef struct {
/** The x coordinate */
uint32_t x;
/** The y coordinate */
uint32_t y;
/** The width */
uint32_t width;
/** The height */
uint32_t height;
} xcb_ewmh_geometry_t;
/**
* @brief Hold reply of a _NET_WORKAREA GetProperty
*/
typedef struct {
/** The number of desktop workarea */
uint32_t workarea_len;
/** The list of desktop workarea */
xcb_ewmh_geometry_t *workarea;
/** The actual GetProperty reply */
xcb_get_property_reply_t *_reply;
} xcb_ewmh_get_workarea_reply_t;
/**
* @brief Source indication in requests
*/
typedef enum {
/** No source at all (for clients supporting an older version of
EWMH specification) */
XCB_EWMH_CLIENT_SOURCE_TYPE_NONE = 0,
/** Normal application */
XCB_EWMH_CLIENT_SOURCE_TYPE_NORMAL = 1,
/** Pagers and other clients that represent direct user actions */
XCB_EWMH_CLIENT_SOURCE_TYPE_OTHER = 2
} xcb_ewmh_client_source_type_t;
/**
* @brief _NET_DESKTOP_LAYOUT orientation
*/
typedef enum {
/** Horizontal orientation (desktops laid out in rows) */
XCB_EWMH_WM_ORIENTATION_HORZ = 0,
/** Vertical orientation (desktops laid out in columns) */
XCB_EWMH_WM_ORIENTATION_VERT = 1
} xcb_ewmh_desktop_layout_orientation_t;
/**
* @brief _NET_DESKTOP_LAYOUT starting corner
*/
typedef enum {
/** Starting corner on the top left */
XCB_EWMH_WM_TOPLEFT = 0,
/** Starting corner on the top right */
XCB_EWMH_WM_TOPRIGHT = 1,
/** Starting corner on the bottom right */
XCB_EWMH_WM_BOTTOMRIGHT = 2,
/** Starting corner on the bottom left */
XCB_EWMH_WM_BOTTOMLEFT = 3
} xcb_ewmh_desktop_layout_starting_corner_t;
/**
* @brief Hold reply of a _NET_DESKTOP_LAYOUT GetProperty
* @see xcb_ewmh_desktop_layout_orientation_t
* @see xcb_ewmh_desktop_layout_starting_corner_t
*/
typedef struct {
/** The desktops orientation */
uint32_t orientation;
/** The number of columns */
uint32_t columns;
/** The number of rows */
uint32_t rows;
/** The desktops starting corner */
uint32_t starting_corner;
} xcb_ewmh_get_desktop_layout_reply_t;
/**
* @brief _NET_WM_MOVERESIZE value when moving via keyboard
* @see xcb_ewmh_moveresize_direction_t
*/
typedef enum {
/** The window x coordinate */
XCB_EWMH_MOVERESIZE_WINDOW_X = (1 << 8),
/** The window y coordinate */
XCB_EWMH_MOVERESIZE_WINDOW_Y = (1 << 9),
/** The window width */
XCB_EWMH_MOVERESIZE_WINDOW_WIDTH = (1 << 10),
/** The window height */
XCB_EWMH_MOVERESIZE_WINDOW_HEIGHT = (1 << 11)
} xcb_ewmh_moveresize_window_opt_flags_t;
/**
* @brief _NET_WM_MOVERESIZE window movement or resizing
*/
typedef enum {
/** Resizing applied on the top left edge */
XCB_EWMH_WM_MOVERESIZE_SIZE_TOPLEFT = 0,
/** Resizing applied on the top edge */
XCB_EWMH_WM_MOVERESIZE_SIZE_TOP = 1,
/** Resizing applied on the top right edge */
XCB_EWMH_WM_MOVERESIZE_SIZE_TOPRIGHT = 2,
/** Resizing applied on the right edge */
XCB_EWMH_WM_MOVERESIZE_SIZE_RIGHT = 3,
/** Resizing applied on the bottom right edge */
XCB_EWMH_WM_MOVERESIZE_SIZE_BOTTOMRIGHT = 4,
/** Resizing applied on the bottom edge */
XCB_EWMH_WM_MOVERESIZE_SIZE_BOTTOM = 5,
/** Resizing applied on the bottom left edge */
XCB_EWMH_WM_MOVERESIZE_SIZE_BOTTOMLEFT = 6,
/** Resizing applied on the left edge */
XCB_EWMH_WM_MOVERESIZE_SIZE_LEFT = 7,
/* Movement only */
XCB_EWMH_WM_MOVERESIZE_MOVE = 8,
/* Size via keyboard */
XCB_EWMH_WM_MOVERESIZE_SIZE_KEYBOARD = 9,
/* Move via keyboard */
XCB_EWMH_WM_MOVERESIZE_MOVE_KEYBOARD = 10,
/* Cancel operation */
XCB_EWMH_WM_MOVERESIZE_CANCEL = 11
} xcb_ewmh_moveresize_direction_t;
/**
* @brief Action on the _NET_WM_STATE property
*/
typedef enum {
/* Remove/unset property */
XCB_EWMH_WM_STATE_REMOVE = 0,
/* Add/set property */
XCB_EWMH_WM_STATE_ADD = 1,
/* Toggle property */
XCB_EWMH_WM_STATE_TOGGLE = 2
} xcb_ewmh_wm_state_action_t;
/**
* @brief Hold reply of _NET_WM_STRUT_PARTIAL GetProperty
*/
typedef struct {
/** Reserved space on the left border of the screen */
uint32_t left;
/** Reserved space on the right border of the screen */
uint32_t right;
/** Reserved space on the top border of the screen */
uint32_t top;
/** Reserved space on the bottom border of the screen */
uint32_t bottom;
/** Beginning y coordinate of the left strut */
uint32_t left_start_y;
/** Ending y coordinate of the left strut */
uint32_t left_end_y;
/** Beginning y coordinate of the right strut */
uint32_t right_start_y;
/** Ending y coordinate of the right strut */
uint32_t right_end_y;
/** Beginning x coordinate of the top strut */
uint32_t top_start_x;
/** Ending x coordinate of the top strut */
uint32_t top_end_x;
/** Beginning x coordinate of the bottom strut */
uint32_t bottom_start_x;
/** Ending x coordinate of the bottom strut */
uint32_t bottom_end_x;
} xcb_ewmh_wm_strut_partial_t;
/**
* @brief Hold a single icon from reply of _NET_WM_ICON GetProperty
*/
typedef struct {
/** Icon width */
uint32_t width;
/** Icon height */
uint32_t height;
/** Rows, left to right and top to bottom of the CARDINAL ARGB */
uint32_t *data;
/** Number of icons remaining */
unsigned int rem;
/** Index of the current icon in the array of icons */
unsigned int index;
} xcb_ewmh_wm_icon_iterator_t;
/**
* @brief Hold reply of _NET_WM_ICON GetProperty
*/
typedef struct {
/** Number of icons */
unsigned int num_icons;
/** The actual GetProperty reply */
xcb_get_property_reply_t *_reply;
} xcb_ewmh_get_wm_icon_reply_t;
/**
* @brief Hold reply of _NET_REQUEST_FRAME_EXTENTS GetProperty
*/
typedef struct {
/** Width of the left border */
uint32_t left;
/** Width of the right border */
uint32_t right;
/** Width of the top border */
uint32_t top;
/** Width of the bottom border */
uint32_t bottom;
} xcb_ewmh_get_extents_reply_t;
/**
* @brief Hold reply of _NET_WM_FULLSCREEN_MONITORS GetProperty
*/
typedef struct {
/** Monitor whose top edge defines the top edge of the fullscreen
window */
uint32_t top;
/** Monitor whose bottom edge defines the bottom edge of the
fullscreen window */
uint32_t bottom;
/** Monitor whose left edge defines the left edge of the fullscreen
window */
uint32_t left;
/** Monitor whose right edge defines the right edge of the
fullscreen window */
uint32_t right;
} xcb_ewmh_get_wm_fullscreen_monitors_reply_t;
/**
* @brief Send InternAtom requests for the EWMH atoms and its required atoms
*
* @param c The connection to the X server
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The cookies corresponding to EWMH atoms
*/
xcb_intern_atom_cookie_t *xcb_ewmh_init_atoms(xcb_connection_t *c,
xcb_ewmh_connection_t *ewmh);
/**
* @brief Process the replies to the screen initialisation requests
* previously sent
*
* @param emwh The information relative to EWMH
* @param ewmh_cookies The cookies corresponding to EWMH atoms
* @param e Error if any
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_init_atoms_replies(xcb_ewmh_connection_t *ewmh,
xcb_intern_atom_cookie_t *ewmh_cookies,
xcb_generic_error_t **e);
static inline void
xcb_ewmh_connection_wipe(xcb_ewmh_connection_t *ewmh)
{
free(ewmh->screens);
free(ewmh->_NET_WM_CM_Sn);
}
/**
* @brief Send a SendEvent request containing a ClientMessage event
*
* This function is called by all the xcb_ewmh_request* functions
* whose should be used instead of calling directly this function
*
* @param c The X connection
* @param window The window where the action will be applied
* @param dest The destination window (usually the root window)
* @param atom The type of the message
* @param data_len The length of data to be sent
* @param data The data to be sent
* @return The cookie associated with the SendEvent request
*/
xcb_void_cookie_t xcb_ewmh_send_client_message(xcb_connection_t *c,
xcb_window_t window,
xcb_window_t dest,
xcb_atom_t atom,
uint32_t data_len,
const uint32_t *data);
uint8_t xcb_ewmh_get_window_from_reply(xcb_window_t *window,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_window_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_window_t *window,
xcb_generic_error_t **e);
uint8_t xcb_ewmh_get_cardinal_from_reply(uint32_t *cardinal,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_cardinal_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *cardinal,
xcb_generic_error_t **e);
/**
* @brief Get a list of atoms from a given GetProperty reply whose
* type is ATOM
*
* This function is called by all the xcb_ewmh_get_*_from_reply
* functions whose should be used instead of calling it directly.
* Indeed, The GetProperty request has been previously sent by the
* corresponding xcb_ewmh_get_*.
*
* @param atoms The atoms list
* @param r The reply to get the atoms list from
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_atoms_from_reply(xcb_ewmh_get_atoms_reply_t *atoms,
xcb_get_property_reply_t *r);
/**
* @brief Get a list of atoms from the reply of a GetProperty request
* whose type is ATOM
*
* This function is called by all the xcb_ewmh_get_*_reply functions
* whose should be used instead of calling it directly. The
* GetProperty request has been previously sent by the corresponding
* xcb_ewmh_get_*.
*
* @param ewmh The per-screen EWMH specific information
* @param cookie The GetProperty cookie
* @param atoms The atoms list
* @param e The error if any
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_atoms_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_atoms_reply_t *atoms,
xcb_generic_error_t **e);
/**
* @brief Wipe the Atoms list reply
*
* This function must be called to free the memory allocated for atoms
* when the reply is requested in *_reply functions.
*
* @param data The X reply to be freed
*/
void xcb_ewmh_get_atoms_reply_wipe(xcb_ewmh_get_atoms_reply_t *data);
/**
* @brief Get a list of atoms from a given GetProperty reply whose
* type is WINDOW
*
* This function is called by all the xcb_ewmh_get_*_from_reply
* functions whose should be used instead of calling it directly.
* Indeed, The GetProperty request has been previously sent by the
* corresponding xcb_ewmh_get_*.
*
* @param atoms The atoms list
* @param r The reply to get the atoms list from
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_windows_from_reply(xcb_ewmh_get_windows_reply_t *atoms,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_utf8_strings_from_reply(xcb_ewmh_connection_t *ewmh,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_utf8_strings_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_generic_error_t **e);
/**
* @brief Get a list of atoms from the reply of a GetProperty request
* whose type is WINDOW
*
* This function is called by all the xcb_ewmh_get_*_reply functions
* whose should be used instead of calling it directly. The
* GetProperty request has been previously sent by the corresponding
* xcb_ewmh_get_*.
*
* @param ewmh The per-screen EWMH specific information
* @param cookie The GetProperty cookie
* @param atoms The atoms list
* @param e The error if any
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_windows_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_windows_reply_t *atoms,
xcb_generic_error_t **e);
/**
* @brief Wipe the windows list reply
*
* This function must be called to the free the memory allocated for
* windows when the reply is requested in '_reply' functions.
*
* @param data The X reply to be freed
*/
void xcb_ewmh_get_windows_reply_wipe(xcb_ewmh_get_windows_reply_t *data);
/**
* @brief Wipe the UTF-8 strings list reply
*
* This function must be called to the free the memory allocated for
* UTF-8 strings when the reply is requested in '_reply' functions.
*
* @param data The X reply to be freed
*/
void xcb_ewmh_get_utf8_strings_reply_wipe(xcb_ewmh_get_utf8_strings_reply_t *data);
/**
* @brief Send a ChangeProperty request for _NET_SUPPORTED
*
* _NET_SUPPORTED, ATOM[]/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param list_len The number of Atoms supported by the WM
* @param list The Atoms supported by the WM
* @return Cookie associated with the ChangeProperty _NET_SUPPORTED request
*/
xcb_void_cookie_t xcb_ewmh_set_supported(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_atom_t *list);
/**
* @see xcb_ewmh_set_supported
*/
xcb_void_cookie_t xcb_ewmh_set_supported_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_atom_t *list);
/**
* @brief Send GetProperty request to get _NET_SUPPORTED root window
* property
*
* _NET_SUPPORTED, ATOM[]/32
*
* This property MUST be set by the Window Manager to indicate which
* hints it supports. For example: considering _NET_WM_STATE both this
* atom and all supported states e.g. _NET_WM_STATE_MODAL,
* _NET_WM_STATE_STICKY, would be listed. This assumes that backwards
* incompatible changes will not be made to the hints (without being
* renamed).
*
* This form can be used only if the request will cause a reply to be
* generated. Any returned error will be placed in the event queue.
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_SUPPORTED cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_supported_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_supported_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_supported(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the list of supported atoms
*
* @param supported The list of atoms contained in the reply
* @param r GetProperty _NET_SUPPORTED reply
*/
static inline uint8_t
xcb_ewmh_get_supported_from_reply(xcb_ewmh_get_atoms_reply_t *supported,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_atoms_from_reply(supported, r);
}
/**
* @brief Get reply from the GetProperty _NET_SUPPORTED cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_window_supported_unchecked() is used. Otherwise, it stores
* the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_SUPPORTED GetProperty request cookie
* @param supported The reply to be filled
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_supported_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_atoms_reply_t *supported,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_atoms_reply(ewmh, cookie, supported, e);
}
/**
* @brief Send a ChangeProperty request for _NET_CLIENT_LIST
*
* _NET_CLIENT_LIST, WINDOW[]/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param list_len The number of Atoms supported by the WM
* @param list The Atoms supported by the WM
* @return Cookie associated with the ChangeProperty _NET_CLIENT_LIST request
*/
xcb_void_cookie_t xcb_ewmh_set_client_list(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_window_t *list);
/**
* @see xcb_ewmh_set_client_list
*/
xcb_void_cookie_t xcb_ewmh_set_client_list_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_window_t *list);
/**
* @brief Send GetProperty request to get _NET_CLIENT_LIST root window
* property
*
* This array contains all X Windows managed by the Window
* Manager. _NET_CLIENT_LIST has initial mapping order, starting with
* the oldest window. This property SHOULD be set and updated by the
* Window Manager.
*
* @param ewmh The information relative to EWMH.
* @return The _NET_CLIENT_LIST cookie of the GetProperty request.
*/
xcb_get_property_cookie_t xcb_ewmh_get_client_list_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Send GetProperty request to get _NET_CLIENT_LIST root window
* property
*
* @see xcb_ewmh_get_client_list_unchecked
* @param ewmh The information relative to EWMH.
* @return The _NET_CLIENT_LIST cookie of the GetProperty request.
*/
xcb_get_property_cookie_t xcb_ewmh_get_client_list(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the list of client windows from a GetProperty
* _NET_CLIENT_LIST reply
*
* @param clients The list of clients contained in the reply
* @param r GetProperty _NET_CLIENT_LIST reply
*/
static inline uint8_t
xcb_ewmh_get_client_list_from_reply(xcb_ewmh_get_windows_reply_t *clients,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_windows_from_reply(clients, r);
}
/**
* @brief Get reply from the GetProperty _NET_CLIENT_LIST cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_window_client_list_unchecked() is used. Otherwise, it
* stores the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_CLIENT_LIST GetProperty request cookie
* @param clients The list of clients to be filled
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_client_list_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_windows_reply_t *clients,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_windows_reply(ewmh, cookie, clients, e);
}
/**
* @brief Send a ChangeProperty request for _NET_CLIENT_LIST_STACKING
*
* _NET_CLIENT_LIST_STACKING, WINDOW[]/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param list_len The number of Atoms supported by the WM
* @param list The Atoms supported by the WM
* @return Cookie associated with the ChangeProperty _NET_CLIENT_LIST_STACKING request
*/
xcb_void_cookie_t xcb_ewmh_set_client_list_stacking(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_window_t *list);
/**
* @see xcb_ewmh_set_client_list_stacking
*/
xcb_void_cookie_t xcb_ewmh_set_client_list_stacking_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_window_t *list);
/**
* @brief Send GetProperty request to get _NET_CLIENT_LIST_STACKING
* root window property
*
* This array contains all X Windows managed by the Window
* Manager. _NET_CLIENT_LIST_STACKING has initial mapping order,
* starting with the oldest window. This property SHOULD be set and
* updated by the Window Manager.
*
* @param ewmh The information relative to EWMH
* @return The _NET_CLIENT_LIST_STACKING cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_client_list_stacking_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_client_list_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_client_list_stacking(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the list of client windows from a GetProperty
* _NET_CLIENT_LIST_STACKING reply
*
* @param clients The list of clients contained in the reply
* @param r GetProperty _NET_CLIENT_LIST_STACKING reply
*/
static inline uint8_t
xcb_ewmh_get_client_list_stacking_from_reply(xcb_ewmh_get_windows_reply_t *clients,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_windows_from_reply(clients, r);
}
/**
* @brief Get reply from the GetProperty _NET_CLIENT_LIST_STACKING
* cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_window_client_list_stacking_unchecked() is used.
* Otherwise, it stores the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_CLIENT_LIST_STACKING GetProperty request cookie
* @param clients The list of clients to be filled
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_client_list_stacking_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_windows_reply_t *clients,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_windows_reply(ewmh, cookie, clients, e);
}
/**
* @brief Send a ChangeProperty request for _NET_NUMBER_OF_DESKTOPS
*
* _NET_NUMBER_OF_DESKTOPS? CARDINAL/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param number_of_desktops The number of desktops
* @return Cookie associated with the ChangeProperty _NET_NUMBER_OF_DESKTOPS request
*/
xcb_void_cookie_t xcb_ewmh_set_number_of_desktops(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t number_of_desktops);
/**
* @see xcb_ewmh_set_number_of_desktops
*/
xcb_void_cookie_t xcb_ewmh_set_number_of_desktops_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t number_of_desktops);
/**
* @brief Send GetProperty request to get _NET_NUMBER_OF_DESKTOPS root
* window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_NUMBER_OF_DESKTOPS cookie of the GetProperty request.
*/
xcb_get_property_cookie_t xcb_ewmh_get_number_of_desktops_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_number_of_desktops_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_number_of_desktops(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the list of client windows from a GetProperty
* _NET_NUMBER_OF_DESKTOPS reply
*
* @param clients The list of clients contained in the reply
* @param r GetProperty _NET_NUMBER_OF_DESKTOPS reply
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_number_of_desktops_from_reply(uint32_t *number_of_desktops,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_cardinal_from_reply(number_of_desktops, r);
}
/**
* @brief Get reply from the GetProperty _NET_NUMBER_OF_DESKTOPS cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_window_number_of_desktops_unchecked() is used. Otherwise,
* it stores the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_NUMBER_OF_DESKTOPS GetProperty request cookie
* @param supported The reply to be filled
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_number_of_desktops_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *number_of_desktops,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_cardinal_reply(ewmh, cookie, number_of_desktops, e);
}
static inline xcb_void_cookie_t
xcb_ewmh_request_change_number_of_desktops(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t new_number_of_desktops)
{
return xcb_ewmh_send_client_message(ewmh->connection, XCB_NONE,
ewmh->screens[screen_nbr]->root,
ewmh->_NET_NUMBER_OF_DESKTOPS,
sizeof(new_number_of_desktops),
&new_number_of_desktops);
}
/**
* @brief Send a ChangeProperty request for _NET_DESKTOP_GEOMETRY
*
* _NET_DESKTOP_GEOMETRY width, height, CARDINAL[2]/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param new_width The new desktop width
* @param new_height The new desktop height
* @return Cookie associated with the ChangeProperty _NET_DESKTOP_GEOMETRY request
*/
xcb_void_cookie_t xcb_ewmh_set_desktop_geometry(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t new_width,
uint32_t new_height);
/**
* @see xcb_ewmh_set_desktop_geometry
*/
xcb_void_cookie_t xcb_ewmh_set_desktop_geometry_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t new_width,
uint32_t new_height);
/**
* @brief Send GetProperty request to get _NET_DESKTOP_GEOMETRY root
* window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_DESKTOP_GEOMETRY cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_desktop_geometry_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_desktop_geometry_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_desktop_geometry(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Send ClientMessage requesting to change the _NET_DESKTOP_GEOMETRY
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param new_width The new desktop width
* @param new_height The new desktop height
* @return The SendEvent cookie
*/
xcb_void_cookie_t xcb_ewmh_request_change_desktop_geometry(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t new_width,
uint32_t new_height);
/**
* @brief Get the desktop geometry from a GetProperty
* _NET_DESKTOP_GEOMETRY reply
*
* @param width The current desktop width
* @param height The current desktop height
* @param r GetProperty _NET_DESKTOP_GEOMETRY reply
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_desktop_geometry_from_reply(uint32_t *width,
uint32_t *height,
xcb_get_property_reply_t *r);
/**
* @brief Get reply from the GetProperty _NET_DESKTOP_GEOMETRY cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_desktop_geometry_unchecked() is used. Otherwise, it stores
* the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_DESKTOP_GEOMETRY GetProperty request cookie
* @param width The current desktop width
* @param width The current desktop height
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_desktop_geometry_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *width, uint32_t *height,
xcb_generic_error_t **e);
/**
* @brief Send a ChangeProperty request for _NET_DESKTOP_VIEWPORT
*
* _NET_DESKTOP_VIEWPORT x, y, CARDINAL[][2]/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param list_len The number of desktop viewports
* @param list The desktop viewports
* @return Cookie associated with the ChangeProperty _NET_DESKTOP_VIEWPORT request
*/
xcb_void_cookie_t xcb_ewmh_set_desktop_viewport(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_ewmh_coordinates_t *list);
/**
* @see xcb_ewmh_set_desktop_viewport
*/
xcb_void_cookie_t xcb_ewmh_set_desktop_viewport_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_ewmh_coordinates_t *list);
/**
* @brief Send GetProperty request to get _NET_DESKTOP_VIEWPORT root
* window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_DESKTOP_VIEWPORT cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_desktop_viewport_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_desktop_viewport_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_desktop_viewport(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Send ClientMessage requesting to change the _NET_DESKTOP_VIEWPORT
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param new_x The new x coordinate
* @param new_y The new y coordinate
* @return The SendEvent cookie
*/
xcb_void_cookie_t xcb_ewmh_request_change_desktop_viewport(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t x, uint32_t y);
/**
* @brief Get the desktop geometry from a GetProperty
* _NET_DESKTOP_VIEWPORT reply
*
* @param vp The current desktop viewports
* @param r GetProperty _NET_DESKTOP_VIEWPORT reply
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_desktop_viewport_from_reply(xcb_ewmh_get_desktop_viewport_reply_t *vp,
xcb_get_property_reply_t *r);
/**
* @brief Get reply from the GetProperty _NET_DESKTOP_VIEWPORT cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_desktop_viewport_unchecked() is used. Otherwise, it stores
* the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_DESKTOP_VIEWPORT GetProperty request cookie
* @param vp The current desktop viewports
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_desktop_viewport_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_desktop_viewport_reply_t *vp,
xcb_generic_error_t **e);
/**
* @brief Wipe the desktop viewports list reply
*
* This function must be called to free the memory allocated for atoms
* when the reply is requested in xcb_ewmh_get_desktop_viewport_reply
* function.
*
* @param r The X reply to be freed
*/
void xcb_ewmh_get_desktop_viewport_reply_wipe(xcb_ewmh_get_desktop_viewport_reply_t *r);
/**
* @brief Send a ChangeProperty request for _NET_CURRENT_DESKTOP
*
* _NET_CURRENT_DESKTOP desktop, CARDINAL/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param new_current_desktop The new current desktop
* @return Cookie associated with the ChangeProperty _NET_CURRENT_DESKTOP request
*/
xcb_void_cookie_t xcb_ewmh_set_current_desktop(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t new_current_desktop);
/**
* @see xcb_ewmh_set_current_desktop
*/
xcb_void_cookie_t xcb_ewmh_set_current_desktop_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t new_current_desktop);
/**
* @brief Send GetProperty request to get _NET_CURRENT_DESKTOP root
* window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_CURRENT_DESKTOP cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_current_desktop_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_current_desktop_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_current_desktop(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Send ClientMessage requesting to change the _NET_CURRENT_DESKTOP
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param new_desktop The new current desktop
* @param timestamp The request timestamp
* @return The SendEvent cookie
*/
xcb_void_cookie_t xcb_ewmh_request_change_current_desktop(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t new_desktop,
xcb_timestamp_t timestamp);
/**
* @brief Get the desktop geometry from a GetProperty
* _NET_CURRENT_DESKTOP reply
*
* @param current_desktop The current desktop
* @param r GetProperty _NET_CURRENT_DESKTOP reply
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_current_desktop_from_reply(uint32_t *current_desktop,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_cardinal_from_reply(current_desktop, r);
}
/**
* @brief Get reply from the GetProperty _NET_CURRENT_DESKTOP cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_current_desktop_unchecked() is used. Otherwise, it stores
* the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_CURRENT_DESKTOP GetProperty request cookie
* @param vp The current desktop
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_current_desktop_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *current_desktop,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_cardinal_reply(ewmh, cookie, current_desktop, e);
}
/**
* @brief Send a ChangeProperty request for _NET_DESKTOP_NAMES
*
* _NET_DESKTOP_NAMES, UTF8_STRING[]
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param strings_len The number of desktop names
* @param strings The desktop names
* @return Cookie associated with the ChangeProperty _NET_DESKTOP_NAMES request
*/
xcb_void_cookie_t xcb_ewmh_set_desktop_names(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t strings_len,
const char *strings);
/**
* @see xcb_ewmh_set_desktop_names
*/
xcb_void_cookie_t xcb_ewmh_set_desktop_names_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t strings_len,
const char *strings);
/**
* @brief Send GetProperty request to get _NET_DESKTOP_NAMES root
* window property
*
* @param ewmh The information relative to EWMH
* @return The _NET_DESKTOP_NAMES cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_desktop_names_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_desktop_names_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_desktop_names(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the desktop geometry from a GetProperty
* _NET_DESKTOP_NAMES reply
*
* @param ewmh The information relative to EWMH
* @param names The desktop names
* @param r GetProperty _NET_DESKTOP_NAMES reply
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_desktop_names_from_reply(xcb_ewmh_connection_t *ewmh,
xcb_ewmh_get_utf8_strings_reply_t *names,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_utf8_strings_from_reply(ewmh, names, r);
}
/**
* @brief Get reply from the GetProperty _NET_DESKTOP_NAMES cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_desktop_names_unchecked() is used. Otherwise, it stores
* the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_DESKTOP_NAMES GetProperty request cookie
* @param names The desktop names
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_desktop_names_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_utf8_strings_reply_t *names,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_utf8_strings_reply(ewmh, cookie, names, e);
}
/**
* @brief Send a ChangeProperty request for _NET_ACTIVE_WINDOW
*
* _NET_ACTIVE_WINDOW, WINDOW/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param new_active_window The window to make active
* @return Cookie associated with the ChangeProperty _NET_ACTIVE_WINDOW request
*/
xcb_void_cookie_t xcb_ewmh_set_active_window(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t new_active_window);
/**
* @see xcb_ewmh_set_active_window
*/
xcb_void_cookie_t xcb_ewmh_set_active_window_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t new_active_window);
/**
* @brief Send ClientMessage requesting to change the _NET_ACTIVE_WINDOW
*
* The window ID of the currently active window or None if no window
* has the focus. This is a read-only property set by the Window
* Manager. If a Client wants to activate another window, it MUST send
* a _NET_ACTIVE_WINDOW client message to the root window. The
* timestamp is Client's last user activity timestamp at the time of
* the request, and the currently active window is the Client's active
* toplevel window, if any (the Window Manager may be e.g. more likely
* to obey the request if it will mean transferring focus from one
* active window to another).
*
* @see xcb_ewmh_client_source_type_t
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @param window_to_active The window ID to activate
* @param source_indication The source indication
* @param timestamp The client's last user activity timestamp
* @param current_active_window The currently active window or None
*/
xcb_void_cookie_t xcb_ewmh_request_change_active_window(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t window_to_activate,
xcb_ewmh_client_source_type_t source_indication,
xcb_timestamp_t timestamp,
xcb_window_t current_active_window);
/**
* @brief Send GetProperty request to get _NET_ACTIVE_WINDOW root
* window property
*
* The window ID of the currently active window or None if no window
* has the focus. This is a read-only property set by the Window
* Manager. This property SHOULD be set and updated by the Window
* Manager.
*
* This form can be used only if the request will cause a reply to be
* generated. Any returned error will be placed in the event queue.
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_ACTIVE_WINDOW cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_active_window_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Send GetProperty request to get _NET_ACTIVE_WINDOW root
* window property
*
* @see xcb_ewmh_get_active_window_unchecked
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_ACTIVE_WINDOW cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_active_window(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the list of client windows from a GetProperty
* _NET_ACTIVE_WINDOW reply
*
* @param active_window The current active window
* @param r GetProperty _NET_ACTIVE_WINDOW_OF_DESKTOPS reply
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_active_window_from_reply(xcb_window_t *active_window,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_window_from_reply(active_window, r);
}
/**
* @brief Get reply from the GetProperty _NET_ACTIVE_WINDOW cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_active_window_unchecked() is used. Otherwise, it stores
* the error if any.
*
* @param ewmh The information relative to EWMH.
* @param cookie The _NET_ACTIVE_WINDOW GetProperty request cookie.
* @param active_window The reply to be filled.
* @param The xcb_generic_error_t supplied.
* @return Return 1 on success, 0 otherwise.
*/
static inline uint8_t
xcb_ewmh_get_active_window_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_window_t *active_window,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_window_reply(ewmh, cookie, active_window, e);
}
/**
* @brief Send a ChangeProperty request for _NET_WORKAREA
*
* _NET_WORKAREA, x, y, width, height CARDINAL[][4]/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param list_len The number of desktops workareas
* @param list The desktops workareas
* @return Cookie associated with the ChangeProperty _NET_WORKAREA request
*/
xcb_void_cookie_t xcb_ewmh_set_workarea(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_ewmh_geometry_t *list);
/**
* @see xcb_ewmh_set_workarea
*/
xcb_void_cookie_t xcb_ewmh_set_workarea_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_ewmh_geometry_t *list);
/**
* @brief Send GetProperty request to get _NET_WORKAREA root
* window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_WORKAREA cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_workarea_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_virtual_roots_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_workarea(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the desktop geometry from a GetProperty _NET_WORKAREA
* reply
*
* @param wa The current workarea
* @param r GetProperty _NET_WORKAREA reply
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_workarea_from_reply(xcb_ewmh_get_workarea_reply_t *wa,
xcb_get_property_reply_t *r);
/**
* @brief Get reply from the GetProperty _NET_WORKAREA cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_workarea_unchecked() is used. Otherwise, it stores the
* error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_WORKAREA GetProperty request cookie
* @param wa The current workareas of desktops
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
uint8_t xcb_ewmh_get_workarea_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_workarea_reply_t *wa,
xcb_generic_error_t **e);
/**
* @brief Wipe the workarea list reply
*
* This function must be called to free the memory allocated for atoms
* when the reply is requested in xcb_ewmh_get_workarea_reply
* function.
*
* @param r The X reply to be freed
*/
void xcb_ewmh_get_workarea_reply_wipe(xcb_ewmh_get_workarea_reply_t *r);
/**
* @brief Send a ChangeProperty request for _NET_SUPPORTING_WM_CHECK
*
* _NET_SUPPORTING_WM_CHECK, WINDOW/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param new_window The child window created by the WM
* @return Cookie associated with the ChangeProperty _NET_SUPPORTING_WM_CHECK request
*/
xcb_void_cookie_t xcb_ewmh_set_supporting_wm_check(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t new_window);
/**
* @see xcb_ewmh_set_supporting_wm_check
*/
xcb_void_cookie_t xcb_ewmh_set_supporting_wm_check_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t new_window);
/**
* @brief Send GetProperty request to get _NET_SUPPORTING_WM_CHECK
* root window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_SUPPORTING_WM_CHECK cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_supporting_wm_check_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_supporting_wm_check_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_supporting_wm_check(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the list of client windows from a GetProperty
* _NET_SUPPORTING_WM_CHECK reply
*
* @param window The child window created by the WM
* @param r GetProperty _NET_SUPPORTING_WM_CHECK reply
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_supporting_wm_check_from_reply(xcb_window_t *window,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_window_from_reply(window, r);
}
/**
* @brief Get reply from the GetProperty _NET_SUPPORTING_WM_CHECK
* cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_supporting_wm_check_unchecked() is used. Otherwise, it
* stores the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_SUPPORTING_WM_CHECK GetProperty request cookie
* @param window The reply to be filled
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_supporting_wm_check_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_window_t *window,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_window_reply(ewmh, cookie, window, e);
}
/**
* @brief Send a ChangeProperty request for _NET_VIRTUAL_ROOTS
*
* _NET_VIRTUAL_ROOTS, WINDOW[]/32
*
* @param ewmh The per-screen EWMH information
* @param screen_nbr The screen number
* @param list_len The number of virtual root windows
* @param list The virtual root windows
* @return Cookie associated with the ChangeProperty _NET_VIRTUAL_ROOTS request
*/
xcb_void_cookie_t xcb_ewmh_set_virtual_roots(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_window_t *list);
/**
* @see xcb_ewmh_set_virtual_roots
*/
xcb_void_cookie_t xcb_ewmh_set_virtual_roots_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t list_len,
xcb_window_t *list);
/**
* @brief Send GetProperty request to get _NET_VIRTUAL_ROOTS root
* window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_VIRTUAL_ROOTS cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_virtual_roots_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_virtual_roots_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_virtual_roots(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @brief Get the desktop geometry from a GetProperty _NET_WORKAREA
* reply
*
* @param virtual_roots The current virtual root windows
* @param r GetProperty _NET_VIRTUAL_ROOTS reply
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_virtual_roots_from_reply(xcb_ewmh_get_windows_reply_t *virtual_roots,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_windows_from_reply(virtual_roots, r);
}
/**
* @brief Get reply from the GetProperty _NET_VIRTUAL_ROOTS cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_virtual_roots_unchecked() is used. Otherwise, it stores
* the error if any.
*
* @param ewmh The information relative to EWMH
* @param cookie The _NET_VIRTUAL_ROOTS GetProperty request cookie
* @param virtual_roots The current virtual root windows
* @param The xcb_generic_error_t supplied
* @return Return 1 on success, 0 otherwise
*/
static inline uint8_t
xcb_ewmh_get_virtual_roots_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_windows_reply_t *virtual_roots,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_windows_reply(ewmh, cookie, virtual_roots, e);
}
xcb_void_cookie_t xcb_ewmh_set_desktop_layout(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_ewmh_desktop_layout_orientation_t orientation,
uint32_t columns, uint32_t rows,
xcb_ewmh_desktop_layout_starting_corner_t starting_corner);
xcb_void_cookie_t xcb_ewmh_set_desktop_layout_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_ewmh_desktop_layout_orientation_t orientation,
uint32_t columns, uint32_t rows,
xcb_ewmh_desktop_layout_starting_corner_t starting_corner);
/**
* @brief Send GetProperty request to get _NET_DESKTOP_LAYOUT root
* window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_DESKTOP_LAYOUT cookie of the GetProperty request
*/
xcb_get_property_cookie_t xcb_ewmh_get_desktop_layout_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_desktop_layout_unchecked
*/
xcb_get_property_cookie_t xcb_ewmh_get_desktop_layout(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
uint8_t xcb_ewmh_get_desktop_layout_from_reply(xcb_ewmh_get_desktop_layout_reply_t *desktop_layouts,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_desktop_layout_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_desktop_layout_reply_t *desktop_layouts,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_set_showing_desktop(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t desktop);
xcb_void_cookie_t xcb_ewmh_set_showing_desktop_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t desktop);
xcb_get_property_cookie_t xcb_ewmh_get_showing_desktop_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
xcb_get_property_cookie_t xcb_ewmh_get_showing_desktop(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
static inline uint8_t
xcb_ewmh_get_showing_desktop_from_reply(uint32_t *desktop,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_cardinal_from_reply(desktop, r);
}
static inline uint8_t
xcb_ewmh_get_showing_desktop_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *desktop,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_cardinal_reply(ewmh, cookie, desktop, e);
}
static inline xcb_void_cookie_t
xcb_ewmh_request_change_showing_desktop(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
uint32_t enter)
{
return xcb_ewmh_send_client_message(ewmh->connection, XCB_NONE,
ewmh->screens[screen_nbr]->root,
ewmh->_NET_SHOWING_DESKTOP,
sizeof(enter), &enter);
}
xcb_void_cookie_t xcb_ewmh_request_close_window(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t window_to_close,
xcb_timestamp_t timestamp,
xcb_ewmh_client_source_type_t source_indication);
xcb_void_cookie_t xcb_ewmh_request_moveresize_window(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t moveresize_window,
xcb_gravity_t gravity,
xcb_ewmh_client_source_type_t source_indication,
xcb_ewmh_moveresize_window_opt_flags_t flags,
uint32_t x, uint32_t y,
uint32_t width, uint32_t height);
xcb_void_cookie_t xcb_ewmh_request_wm_moveresize(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t moveresize_window,
uint32_t x_root, uint32_t y_root,
xcb_ewmh_moveresize_direction_t direction,
xcb_button_index_t button,
xcb_ewmh_client_source_type_t source_indication);
xcb_void_cookie_t xcb_ewmh_request_restack_window(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t window_to_restack,
xcb_window_t sibling_window,
xcb_stack_mode_t detail);
static inline xcb_void_cookie_t
xcb_ewmh_request_frame_extents(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t client_window)
{
return xcb_ewmh_send_client_message(ewmh->connection, client_window,
ewmh->screens[screen_nbr]->root,
ewmh->_NET_REQUEST_FRAME_EXTENTS, 0, NULL);
}
xcb_void_cookie_t xcb_ewmh_set_wm_name(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t strings_len,
const char *strings);
xcb_void_cookie_t xcb_ewmh_set_wm_name_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t strings_len,
const char *strings);
xcb_get_property_cookie_t xcb_ewmh_get_wm_name_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_name(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_name_from_reply(xcb_ewmh_connection_t *ewmh,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_utf8_strings_from_reply(ewmh, data, r);
}
static inline uint8_t
xcb_ewmh_get_wm_name_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_utf8_strings_reply(ewmh, cookie, data, e);
}
xcb_void_cookie_t xcb_ewmh_set_wm_visible_name(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t strings_len,
const char *strings);
xcb_void_cookie_t xcb_ewmh_set_wm_visible_name_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t strings_len,
const char *strings);
xcb_get_property_cookie_t xcb_ewmh_get_wm_visible_name_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_visible_name(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_visible_name_from_reply(xcb_ewmh_connection_t *ewmh,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_utf8_strings_from_reply(ewmh, data, r);
}
static inline uint8_t
xcb_ewmh_get_wm_visible_name_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_utf8_strings_reply(ewmh, cookie, data, e);
}
xcb_void_cookie_t xcb_ewmh_set_wm_icon_name(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t strings_len,
const char *strings);
xcb_void_cookie_t xcb_ewmh_set_wm_icon_name_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t strings_len,
const char *strings);
xcb_get_property_cookie_t xcb_ewmh_get_wm_icon_name_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_icon_name(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_icon_name_from_reply(xcb_ewmh_connection_t *ewmh,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_utf8_strings_from_reply(ewmh, data, r);
}
static inline uint8_t
xcb_ewmh_get_wm_icon_name_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_utf8_strings_reply(ewmh, cookie, data, e);
}
xcb_void_cookie_t xcb_ewmh_set_wm_visible_icon_name(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t strings_len,
const char *strings);
xcb_void_cookie_t xcb_ewmh_set_wm_visible_icon_name_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t strings_len,
const char *strings);
xcb_get_property_cookie_t xcb_ewmh_get_wm_visible_icon_name_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_visible_icon_name(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_visible_icon_name_from_reply(xcb_ewmh_connection_t *ewmh,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_utf8_strings_from_reply(ewmh, data, r);
}
static inline uint8_t
xcb_ewmh_get_wm_visible_icon_name_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_utf8_strings_reply_t *data,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_utf8_strings_reply(ewmh, cookie, data, e);
}
xcb_void_cookie_t xcb_ewmh_set_wm_desktop(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t desktop);
xcb_void_cookie_t xcb_ewmh_set_wm_desktop_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t desktop);
xcb_get_property_cookie_t xcb_ewmh_get_wm_desktop_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_desktop(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_desktop_from_reply(uint32_t *desktop,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_cardinal_from_reply(desktop, r);
}
static inline uint8_t
xcb_ewmh_get_wm_desktop_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *desktop,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_cardinal_reply(ewmh, cookie, desktop, e);
}
xcb_void_cookie_t xcb_ewmh_request_change_wm_desktop(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t client_window,
uint32_t new_desktop,
xcb_ewmh_client_source_type_t source_indication);
xcb_void_cookie_t xcb_ewmh_set_wm_window_type(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t list_len,
xcb_atom_t *list);
xcb_void_cookie_t xcb_ewmh_set_wm_window_type_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t list_len,
xcb_atom_t *list);
xcb_get_property_cookie_t xcb_ewmh_get_wm_window_type_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_window_type(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_window_type_from_reply(xcb_ewmh_get_atoms_reply_t *wtypes,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_window_type_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_atoms_reply_t *name,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_set_wm_state(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t list_len,
xcb_atom_t *list);
xcb_void_cookie_t xcb_ewmh_set_wm_state_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t list_len,
xcb_atom_t *list);
xcb_get_property_cookie_t xcb_ewmh_get_wm_state_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_state(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_state_from_reply(xcb_ewmh_get_atoms_reply_t *wtypes,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_state_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_atoms_reply_t *name,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_request_change_wm_state(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t client_window,
xcb_ewmh_wm_state_action_t action,
xcb_atom_t first_property,
xcb_atom_t second_property,
xcb_ewmh_client_source_type_t source_indication);
xcb_void_cookie_t xcb_ewmh_set_wm_allowed_actions(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t list_len,
xcb_atom_t *list);
xcb_void_cookie_t xcb_ewmh_set_wm_allowed_actions_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t list_len,
xcb_atom_t *list);
xcb_get_property_cookie_t xcb_ewmh_get_wm_allowed_actions_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_allowed_actions(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_allowed_actions_from_reply(xcb_ewmh_get_atoms_reply_t *wtypes,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_allowed_actions_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_atoms_reply_t *name,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_set_wm_strut(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t left, uint32_t right,
uint32_t top, uint32_t bottom);
xcb_void_cookie_t xcb_ewmh_set_wm_strut_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t left, uint32_t right,
uint32_t top, uint32_t bottom);
xcb_get_property_cookie_t xcb_ewmh_get_wm_strut_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_strut(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_strut_from_reply(xcb_ewmh_get_extents_reply_t *struts,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_strut_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_extents_reply_t *struts,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_set_wm_strut_partial(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
xcb_ewmh_wm_strut_partial_t wm_strut);
xcb_void_cookie_t xcb_ewmh_set_wm_strut_partial_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
xcb_ewmh_wm_strut_partial_t wm_strut);
xcb_get_property_cookie_t xcb_ewmh_get_wm_strut_partial_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_strut_partial(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_strut_partial_from_reply(xcb_ewmh_wm_strut_partial_t *struts,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_strut_partial_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_wm_strut_partial_t *struts,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_set_wm_icon_geometry(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t left, uint32_t right,
uint32_t top, uint32_t bottom);
xcb_void_cookie_t xcb_ewmh_set_wm_icon_geometry_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t left, uint32_t right,
uint32_t top, uint32_t bottom);
xcb_get_property_cookie_t xcb_ewmh_get_wm_icon_geometry_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_icon_geometry(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_icon_geometry_from_reply(xcb_ewmh_geometry_t *icons,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_icon_geometry_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_geometry_t *icons,
xcb_generic_error_t **e);
/**
* @brief Send ChangeProperty request to set _NET_WM_ICON window
* property. The given data is considered to be already
* prepared, namely that it is an array such as: WIDTH1,
* HEIGHT1, IMG1, WIDTH2, HEIGHT2, IMG2.
*
* If you only want to add or append a single icon, you may
* consider using xcb_ewmh_append_wm_icon_checked which is far
* easier to use.
*
* _NET_WM_ICON CARDINAL[][2+n]/32
*
* @param ewmh The information relative to EWMH
* @param mode ChangeProperty mode (xcb_prop_mode_t)
* @param window The window to set the property on
* @param data_len Length of the data
* @param data The data
*/
static inline xcb_void_cookie_t
xcb_ewmh_set_wm_icon_checked(xcb_ewmh_connection_t *ewmh,
uint8_t mode,
xcb_window_t window,
uint32_t data_len, uint32_t *data)
{
return xcb_change_property_checked(ewmh->connection, mode,
window, ewmh->_NET_WM_ICON,
XCB_ATOM_CARDINAL, 32, data_len, data);
}
/**
* @see xcb_ewmh_set_wm_icon_checked
*/
static inline xcb_void_cookie_t
xcb_ewmh_set_wm_icon(xcb_ewmh_connection_t *ewmh,
uint8_t mode,
xcb_window_t window,
uint32_t data_len, uint32_t *data)
{
return xcb_change_property(ewmh->connection, mode, window,
ewmh->_NET_WM_ICON, XCB_ATOM_CARDINAL, 32,
data_len, data);
}
xcb_void_cookie_t xcb_ewmh_append_wm_icon_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t width, uint32_t height,
uint32_t img_len, uint32_t *img);
xcb_void_cookie_t xcb_ewmh_append_wm_icon(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t width, uint32_t height,
uint32_t img_len, uint32_t *img);
xcb_get_property_cookie_t xcb_ewmh_get_wm_icon_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_icon(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_icon_from_reply(xcb_ewmh_get_wm_icon_reply_t *wm_icon,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_icon_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_wm_icon_reply_t *wm_icon,
xcb_generic_error_t **e);
xcb_ewmh_wm_icon_iterator_t xcb_ewmh_get_wm_icon_iterator(const xcb_ewmh_get_wm_icon_reply_t *wm_icon);
unsigned int xcb_ewmh_get_wm_icon_length(const xcb_ewmh_get_wm_icon_reply_t *wm_icon);
void xcb_ewmh_get_wm_icon_next(xcb_ewmh_wm_icon_iterator_t *iterator);
void xcb_ewmh_get_wm_icon_reply_wipe(xcb_ewmh_get_wm_icon_reply_t *wm_icon);
xcb_void_cookie_t xcb_ewmh_set_wm_pid(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t pid);
xcb_void_cookie_t xcb_ewmh_set_wm_pid_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t pid);
xcb_get_property_cookie_t xcb_ewmh_get_wm_pid_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_pid(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_pid_from_reply(uint32_t *pid,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_cardinal_from_reply(pid, r);
}
static inline uint8_t
xcb_ewmh_get_wm_pid_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *pid,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_cardinal_reply(ewmh, cookie, pid, e);
}
xcb_void_cookie_t xcb_ewmh_set_wm_handled_icons(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t handled_icons);
xcb_void_cookie_t xcb_ewmh_set_wm_handled_icons_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t handled_icons);
xcb_get_property_cookie_t xcb_ewmh_get_wm_handled_icons_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_handled_icons(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_handled_icons_from_reply(uint32_t *handled_icons,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_cardinal_from_reply(handled_icons, r);
}
static inline uint8_t
xcb_ewmh_get_wm_handled_icons_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *handled_icons,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_cardinal_reply(ewmh, cookie, handled_icons, e);
}
xcb_void_cookie_t xcb_ewmh_set_wm_user_time(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t xtime);
xcb_void_cookie_t xcb_ewmh_set_wm_user_time_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t pid);
xcb_get_property_cookie_t xcb_ewmh_get_wm_user_time_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_user_time(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_user_time_from_reply(uint32_t *xtime,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_cardinal_from_reply(xtime, r);
}
static inline uint8_t
xcb_ewmh_get_wm_user_time_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *xtime,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_cardinal_reply(ewmh, cookie, xtime, e);
}
xcb_void_cookie_t xcb_ewmh_set_wm_user_time_window(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t xtime);
xcb_void_cookie_t xcb_ewmh_set_wm_user_time_window_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t pid);
xcb_get_property_cookie_t xcb_ewmh_get_wm_user_time_window_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_user_time_window(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
static inline uint8_t
xcb_ewmh_get_wm_user_time_window_from_reply(uint32_t *xtime,
xcb_get_property_reply_t *r)
{
return xcb_ewmh_get_cardinal_from_reply(xtime, r);
}
static inline uint8_t
xcb_ewmh_get_wm_user_time_window_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint32_t *xtime,
xcb_generic_error_t **e)
{
return xcb_ewmh_get_cardinal_reply(ewmh, cookie, xtime, e);
}
xcb_void_cookie_t xcb_ewmh_set_frame_extents(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t left, uint32_t right,
uint32_t top, uint32_t bottom);
xcb_void_cookie_t xcb_ewmh_set_frame_extents_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t left, uint32_t right,
uint32_t top, uint32_t bottom);
xcb_get_property_cookie_t xcb_ewmh_get_frame_extents_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_frame_extents(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_frame_extents_from_reply(xcb_ewmh_get_extents_reply_t *frame_extents,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_frame_extents_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_extents_reply_t *frame_extents,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_send_wm_ping(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
xcb_timestamp_t timestamp);
xcb_void_cookie_t xcb_ewmh_set_wm_sync_request_counter(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
xcb_atom_t wm_sync_request_counter_atom,
uint32_t low, uint32_t high);
xcb_void_cookie_t xcb_ewmh_set_wm_sync_request_counter_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
xcb_atom_t wm_sync_request_counter_atom,
uint32_t low, uint32_t high);
xcb_get_property_cookie_t xcb_ewmh_get_wm_sync_request_counter_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_sync_request_counter(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_sync_request_counter_from_reply(uint64_t *counter,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_sync_request_counter_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
uint64_t *counter,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_send_wm_sync_request(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
xcb_atom_t wm_protocols_atom,
xcb_atom_t wm_sync_request_atom,
xcb_timestamp_t timestamp,
uint64_t counter);
xcb_void_cookie_t xcb_ewmh_set_wm_fullscreen_monitors(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t top, uint32_t bottom,
uint32_t left, uint32_t right);
xcb_void_cookie_t xcb_ewmh_set_wm_fullscreen_monitors_checked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window,
uint32_t top, uint32_t bottom,
uint32_t left, uint32_t right);
xcb_get_property_cookie_t xcb_ewmh_get_wm_fullscreen_monitors_unchecked(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
xcb_get_property_cookie_t xcb_ewmh_get_wm_fullscreen_monitors(xcb_ewmh_connection_t *ewmh,
xcb_window_t window);
uint8_t xcb_ewmh_get_wm_fullscreen_monitors_from_reply(xcb_ewmh_get_wm_fullscreen_monitors_reply_t *monitors,
xcb_get_property_reply_t *r);
uint8_t xcb_ewmh_get_wm_fullscreen_monitors_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_property_cookie_t cookie,
xcb_ewmh_get_wm_fullscreen_monitors_reply_t *monitors,
xcb_generic_error_t **e);
xcb_void_cookie_t xcb_ewmh_request_change_wm_fullscreen_monitors(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t window,
uint32_t top, uint32_t bottom,
uint32_t left, uint32_t right,
xcb_ewmh_client_source_type_t source_indication);
/**
* @brief Set _NET_WM_CM_Sn ownership to the given window
*
* For each screen they manage, compositing manager MUST acquire
* ownership of a selection named _NET_WM_CM_Sn, where n is the screen
* number.
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @param owner The new owner of _NET_WM_CM_Sn selection
* @param timestamp The client's last user activity timestamp
* @param selection_data1 Optional data described by ICCCM
* @param selection_data2 Optional data described by ICCCM
*/
xcb_void_cookie_t xcb_ewmh_set_wm_cm_owner(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t owner,
xcb_timestamp_t timestamp,
uint32_t selection_data1,
uint32_t selection_data2);
/**
* @see xcb_ewmh_set_wm_cm_owner
*/
xcb_void_cookie_t xcb_ewmh_set_wm_cm_owner_checked(xcb_ewmh_connection_t *ewmh,
int screen_nbr,
xcb_window_t owner,
xcb_timestamp_t timestamp,
uint32_t selection_data1,
uint32_t selection_data2);
/**
* @brief Send GetSelectOwner request to get the owner of
* _NET_WM_CM_Sn root window property
*
* @param ewmh The information relative to EWMH
* @param screen_nbr The screen number
* @return The _NET_WM_CM_Sn cookie of the GetSelectionOwner request
*/
xcb_get_selection_owner_cookie_t xcb_ewmh_get_wm_cm_owner_unchecked(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
/**
* @see xcb_ewmh_get_wm_cm_owner_unchecked
*/
xcb_get_selection_owner_cookie_t xcb_ewmh_get_wm_cm_owner(xcb_ewmh_connection_t *ewmh,
int screen_nbr);
uint8_t xcb_ewmh_get_wm_cm_owner_from_reply(xcb_window_t *owner,
xcb_get_selection_owner_reply_t *r);
/**
* @brief Get reply from the GetProperty _NET_CLIENT_LIST cookie
*
* The parameter e supplied to this function must be NULL if
* xcb_get_window_client_list_unchecked() is used. Otherwise, it
* stores the error if any.
*
* @param ewmh The information relative to EWMH.
* @param cookie The _NET_WM_CM_Sn GetSelectionOwner request cookie.
* @param owner The window ID which owns the selection or None.
* @param The xcb_generic_error_t supplied.
* @return Return 1 on success, 0 otherwise.
*/
uint8_t xcb_ewmh_get_wm_cm_owner_reply(xcb_ewmh_connection_t *ewmh,
xcb_get_selection_owner_cookie_t cookie,
xcb_window_t *owner,
xcb_generic_error_t **e);
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#endif /* __XCB_EWMH_H__ */
|