/usr/include/gtkmm-3.0/gtkmm/window.h is in libgtkmm-3.0-dev 3.22.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 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 | // Generated by gmmproc 2.54.0 -- DO NOT MODIFY!
#ifndef _GTKMM_WINDOW_H
#define _GTKMM_WINDOW_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/*
* Copyright (C) 1998-2013 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <vector>
#include <glibmm/object.h>
#include <gtkmm/bin.h>
#include <gtkmm/application.h>
#include <gtkmm/windowgroup.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GtkWindow = struct _GtkWindow;
using GtkWindowClass = struct _GtkWindowClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class Window_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{
class AccelGroup;
class WindowGroup;
/** Toplevel Window.
* This represents all widgets which are physical windows controlled
* by the window manager.
*
* The window will be hidden when the window manager's close button is clicked. Override on_delete_event() to stop this.
*
* Gtk::manage() has no effect on Windows because they have no parent Containers.
* @ingroup Widgets
*/
class Window : public Bin
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef Window CppObjectType;
typedef Window_Class CppClassType;
typedef GtkWindow BaseObjectType;
typedef GtkWindowClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
Window(Window&& src) noexcept;
Window& operator=(Window&& src) noexcept;
// noncopyable
Window(const Window&) = delete;
Window& operator=(const Window&) = delete;
~Window() noexcept override;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class Window_Class;
static CppClassType window_class_;
protected:
explicit Window(const Glib::ConstructParams& construct_params);
explicit Window(GtkWindow* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GtkObject.
GtkWindow* gobj() { return reinterpret_cast<GtkWindow*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkWindow* gobj() const { return reinterpret_cast<GtkWindow*>(gobject_); }
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_set_focus().
virtual void on_set_focus(Widget* focus);
private:
//TODO: Use gtk_window_set_destroy_with_parent() to allow use of Gtk::manage() with top-level windows, using the transient-parent?
public:
explicit Window(WindowType type = WINDOW_TOPLEVEL);
/** The type of the window.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< WindowType > property_type() const;
/** The title of the window.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_title() ;
/** The title of the window.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_title() const;
/** The :startup-id is a write-only property for setting window's
* startup notification identifier. See Gtk::Window::set_startup_id()
* for more details.
*
* @newin{2,12}
*
* @return A PropertyProxy_WriteOnly that allows you to set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_WriteOnly< Glib::ustring > property_startup_id() ;
/** If TRUE, users can resize the window.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_resizable() ;
/** If TRUE, users can resize the window.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_resizable() const;
/** If TRUE, the window is modal (other windows are not usable while this one is up).
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_modal() ;
/** If TRUE, the window is modal (other windows are not usable while this one is up).
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_modal() const;
/** The initial position of the window.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< WindowPosition > property_window_position() ;
/** The initial position of the window.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< WindowPosition > property_window_position() const;
/** The default width of the window, used when initially showing the window.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_default_width() ;
/** The default width of the window, used when initially showing the window.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_default_width() const;
/** The default height of the window, used when initially showing the window.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_default_height() ;
/** The default height of the window, used when initially showing the window.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_default_height() const;
/** If this window should be destroyed when the parent is destroyed.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_destroy_with_parent() ;
/** If this window should be destroyed when the parent is destroyed.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_destroy_with_parent() const;
/** Whether the titlebar should be hidden during maximization.
*
* @newin{3,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_hide_titlebar_when_maximized() ;
/** Whether the titlebar should be hidden during maximization.
*
* @newin{3,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_hide_titlebar_when_maximized() const;
/** Icon for this window.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_icon() ;
/** Icon for this window.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_icon() const;
/** Whether mnemonics are currently visible in this window.
*
* This property is maintained by GTK+ based on user input,
* and should not be set by applications.
*
* @newin{2,20}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_mnemonics_visible() ;
/** Whether mnemonics are currently visible in this window.
*
* This property is maintained by GTK+ based on user input,
* and should not be set by applications.
*
* @newin{2,20}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_mnemonics_visible() const;
/** The :icon-name property specifies the name of the themed icon to
* use as the window icon. See Gtk::IconTheme for more details.
*
* @newin{2,6}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_icon_name() ;
/** The :icon-name property specifies the name of the themed icon to
* use as the window icon. See Gtk::IconTheme for more details.
*
* @newin{2,6}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name() const;
/** The screen where this window will be displayed.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Gdk::Screen> > property_screen() ;
/** The screen where this window will be displayed.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Screen> > property_screen() const;
/** Whether the toplevel is the current active window.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_is_active() const;
/** Whether the input focus is within this GtkWindow.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_has_toplevel_focus() const;
/** Hint to help the desktop environment understand what kind of window this is and how to treat it.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< GdkWindowTypeHint > property_type_hint() ;
/** Hint to help the desktop environment understand what kind of window this is and how to treat it.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< GdkWindowTypeHint > property_type_hint() const;
/** TRUE if the window should not be in the task bar.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_skip_taskbar_hint() ;
/** TRUE if the window should not be in the task bar.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_skip_taskbar_hint() const;
/** TRUE if the window should not be in the pager.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_skip_pager_hint() ;
/** TRUE if the window should not be in the pager.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_skip_pager_hint() const;
/** Unique identifier for the window to be used when restoring a session.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_role() ;
/** Unique identifier for the window to be used when restoring a session.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_role() const;
/** Whether the window should be decorated by the window manager.
*
* @newin{2,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_decorated() ;
/** Whether the window should be decorated by the window manager.
*
* @newin{2,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_decorated() const;
/** The window gravity of the window. See Gtk::Window::move() and Gdk::Gravity for
* more details about window gravity.
*
* @newin{2,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Gdk::Gravity > property_gravity() ;
/** The window gravity of the window. See Gtk::Window::move() and Gdk::Gravity for
* more details about window gravity.
*
* @newin{2,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Gdk::Gravity > property_gravity() const;
/** The transient parent of the window. See Gtk::Window::set_transient_for() for
* more details about transient windows.
*
* @newin{2,10}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Window* > property_transient_for() ;
/** The transient parent of the window. See Gtk::Window::set_transient_for() for
* more details about transient windows.
*
* @newin{2,10}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Window* > property_transient_for() const;
#ifndef GTKMM_DISABLE_DEPRECATED
// _WRAP_PROPERTY("opacity", double, deprecated "Use the opacity property in the Widget base class instead.")
// The GtkWindow::opacity property does not exist in gtk+ 3.7.10 and later. Must hand-code to avoid an ABI break.
/** The opacity of the window, from 0 to 1.
* @deprecated Use the opacity property in the Widget base class instead.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< double > property_opacity() ;
/** The opacity of the window, from 0 to 1.
* @deprecated Use the opacity property in the Widget base class instead.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< double > property_opacity() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Whether the window has a corner resize grip.
*
* Note that the resize grip is only shown if the window is
* actually resizable and not maximized. Use
* Gtk::Window::property_resize_grip_visible() to find out if the resize
* grip is currently shown.
*
* Deprecated: 3.14: Resize grips have been removed.
*
* @newin{3,0}
*
* @deprecated Resize grips have been removed.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_has_resize_grip() ;
/** Whether the window has a corner resize grip.
*
* Note that the resize grip is only shown if the window is
* actually resizable and not maximized. Use
* Gtk::Window::property_resize_grip_visible() to find out if the resize
* grip is currently shown.
*
* Deprecated: 3.14: Resize grips have been removed.
*
* @newin{3,0}
*
* @deprecated Resize grips have been removed.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_has_resize_grip() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Whether a corner resize grip is currently shown.
*
* Deprecated: 3.14: Resize grips have been removed.
*
* @newin{3,0}
*
* @deprecated Resize grips have been removed.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_resize_grip_visible() const;
#endif // GTKMM_DISABLE_DEPRECATED
/** TRUE if the window should be brought to the user's attention.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_urgency_hint() ;
/** TRUE if the window should be brought to the user's attention.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_urgency_hint() const;
/** Whether the window should receive the input focus.
*
* @newin{2,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_accept_focus() ;
/** Whether the window should receive the input focus.
*
* @newin{2,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_accept_focus() const;
/** Whether the window should receive the input focus when mapped.
*
* @newin{2,6}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_focus_on_map() ;
/** Whether the window should receive the input focus when mapped.
*
* @newin{2,6}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_map() const;
/** Whether the window frame should have a close button.
*
* @newin{2,10}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_deletable() ;
/** Whether the window frame should have a close button.
*
* @newin{2,10}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_deletable() const;
/** The Gtk::Application associated with the window.
*
* The application will be kept alive for at least as long as it
* has any windows associated with it (see Glib::application_hold()
* for a way to keep it alive without windows).
*
* Normally, the connection between the application and the window
* will remain until the window is destroyed, but you can explicitly
* remove it by setting the :application property to <tt>nullptr</tt>.
*
* @newin{3,0}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Application> > property_application() ;
/** The Gtk::Application associated with the window.
*
* The application will be kept alive for at least as long as it
* has any windows associated with it (see Glib::application_hold()
* for a way to keep it alive without windows).
*
* Normally, the connection between the application and the window
* will remain until the window is destroyed, but you can explicitly
* remove it by setting the :application property to <tt>nullptr</tt>.
*
* @newin{3,0}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Application> > property_application() const;
/** Whether 'focus rectangles' are currently visible in this window.
*
* This property is maintained by GTK+ based on user input
* and should not be set by applications.
*
* @newin{2,20}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_focus_visible() ;
/** Whether 'focus rectangles' are currently visible in this window.
*
* This property is maintained by GTK+ based on user input
* and should not be set by applications.
*
* @newin{2,20}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_focus_visible() const;
/** The widget to which this window is attached.
* See Gtk::Window::set_attached_to().
*
* Examples of places where specifying this relation is useful are
* for instance a Gtk::Menu created by a Gtk::ComboBox, a completion
* popup window created by Gtk::Entry or a typeahead search entry
* created by Gtk::TreeView.
*
* @newin{3,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Widget* > property_attached_to() ;
/** The widget to which this window is attached.
* See Gtk::Window::set_attached_to().
*
* Examples of places where specifying this relation is useful are
* for instance a Gtk::Menu created by a Gtk::ComboBox, a completion
* popup window created by Gtk::Entry or a typeahead search entry
* created by Gtk::TreeView.
*
* @newin{3,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Widget* > property_attached_to() const;
/** Whether the window is maximized.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_is_maximized() const;
/**
* @par Slot Prototype:
* <tt>void on_my_%set_focus(Widget* focus)</tt>
*
* Flags: Run Last
*
*/
Glib::SignalProxy< void,Widget* > signal_set_focus();
//TODO: Remove no_default_handler when we can break ABI:
/**
* @par Slot Prototype:
* <tt>void on_my_%keys_changed()</tt>
*
* Flags: Run First
*
* The signal_keys_changed() signal gets emitted when the set of accelerators
* or mnemonics that are associated with @a window changes.
*/
Glib::SignalProxy< void > signal_keys_changed();
//Keybinding signals:
/** Sets the title of the Gtk::Window. The title of a window will be
* displayed in its title bar; on the X %Window System, the title bar
* is rendered by the [window manager][gtk-X11-arch],
* so exactly how the title appears to users may vary
* according to a user’s exact configuration. The title should help a
* user distinguish this window from other windows they may have
* open. A good title might include the application name and current
* document filename, for example.
*
* @param title Title of the window.
*/
void set_title(const Glib::ustring& title);
/** Retrieves the title of the window. See set_title().
*
* @return The title of the window, or <tt>nullptr</tt> if none has
* been set explicitly. The returned string is owned by the widget
* and must not be modified or freed.
*/
Glib::ustring get_title() const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** Don’t use this function. It sets the X %Window System “class” and
* “name” hints for a window. According to the ICCCM, you should
* always set these to the same value for all windows in an
* application, and GTK+ sets them to that value by default, so calling
* this function is sort of pointless. However, you may want to call
* set_role() on each window in your application, for the
* benefit of the session manager. Setting the role allows the window
* manager to restore window positions when loading a saved session.
*
* @deprecated Don’t use this function.
*
* @param wmclass_name Window name hint.
* @param wmclass_class Window class hint.
*/
void set_wmclass(const Glib::ustring& wmclass_name, const Glib::ustring& wmclass_class);
#endif // GTKMM_DISABLE_DEPRECATED
/** This function is only useful on X11, not with other GTK+ targets.
*
* In combination with the window title, the window role allows a
* [window manager][gtk-X11-arch] to identify "the
* same" window when an application is restarted. So for example you
* might set the “toolbox” role on your app’s toolbox window, so that
* when the user restarts their session, the window manager can put
* the toolbox back in the same place.
*
* If a window already has a unique title, you don’t need to set the
* role, since the WM can use the title to identify the window when
* restoring the session.
*
* @param role Unique identifier for the window to be used when restoring a session.
*/
void set_role(const Glib::ustring& role);
/** Startup notification identifiers are used by desktop environment to
* track application startup, to provide user feedback and other
* features. This function changes the corresponding property on the
* underlying GdkWindow. Normally, startup identifier is managed
* automatically and you should only use this function in special cases
* like transferring focus from other processes. You should use this
* function before calling present() or any equivalent
* function generating a window map event.
*
* This function is only useful on X11, not with other GTK+ targets.
*
* @newin{2,12}
*
* @param startup_id A string with startup-notification identifier.
*/
void set_startup_id(const Glib::ustring& startup_id);
/** Returns the role of the window. See set_role() for
* further explanation.
*
* @return The role of the window if set, or <tt>nullptr</tt>. The
* returned is owned by the widget and must not be modified or freed.
*/
Glib::ustring get_role() const;
/** Associate @a accel_group with @a window, such that calling
* gtk_accel_groups_activate() on @a window will activate accelerators
* in @a accel_group.
*
* @param accel_group A Gtk::AccelGroup.
*/
void add_accel_group(const Glib::RefPtr<AccelGroup>& accel_group);
/** Reverses the effects of add_accel_group().
*
* @param accel_group A Gtk::AccelGroup.
*/
void remove_accel_group(const Glib::RefPtr<AccelGroup>& accel_group);
/** Sets a position constraint for this window. If the old or new
* constraint is Gtk::WIN_POS_CENTER_ALWAYS, this will also cause
* the window to be repositioned to satisfy the new constraint.
*
* @param position A position constraint.
*/
void set_position(WindowPosition position);
/** Activates the current focused widget within the window.
*
* @return <tt>true</tt> if a widget got activated.
*/
bool activate_focus();
/** If @a focus is not the current focus widget, and is focusable, sets
* it as the focus widget for the window. To set the focus to a particular
* widget in the toplevel, it is usually more convenient to use
* Gtk::Widget::grab_focus() instead of this function.
*
* @param focus Widget to be the new focus widget.
*/
void set_focus(Gtk::Widget& focus);
void unset_focus();
/** Retrieves the current focused widget within the window.
* Note that this is the widget that would have the focus
* if the toplevel window focused; if the toplevel window
* is not focused then `gtk_widget_has_focus (widget)` will
* not be <tt>true</tt> for the widget.
*
* @return The currently focused widget,
* or <tt>nullptr</tt> if there is none.
*/
Widget* get_focus();
/** Retrieves the current focused widget within the window.
* Note that this is the widget that would have the focus
* if the toplevel window focused; if the toplevel window
* is not focused then `gtk_widget_has_focus (widget)` will
* not be <tt>true</tt> for the widget.
*
* @return The currently focused widget,
* or <tt>nullptr</tt> if there is none.
*/
const Widget* get_focus() const;
/** The default widget is the widget that's activated when the user
* presses Enter in a dialog (for example). This function sets the default widget for a Gtk::Window. When setting
* (rather than unsetting) the default widget it's generally easier to
* call Gtk::Widget::grab_focus() on the widget. Before making a widget
* the default widget, you must set the Gtk::CAN_DEFAULT flag on the
* widget you'd like to make the default using GTK_WIDGET_SET_FLAGS().
*
* @param default_widget Widget to be the default.
*/
void set_default(Gtk::Widget& default_widget);
void unset_default();
/** Returns the default widget for @a window. See
* set_default() for more details.
*
* @newin{2,14}
*
* @return The default widget, or <tt>nullptr</tt>
* if there is none.
*/
Widget* get_default_widget();
/** Returns the default widget for @a window. See
* set_default() for more details.
*
* @newin{2,14}
*
* @return The default widget, or <tt>nullptr</tt>
* if there is none.
*/
const Widget* get_default_widget() const;
/** Activates the default widget for the window, unless the current
* focused widget has been configured to receive the default action
* (see Gtk::Widget::set_receives_default()), in which case the
* focused widget is activated.
*
* @return <tt>true</tt> if a widget got activated.
*/
bool activate_default();
/** Dialog windows should be set transient for the main application
* window they were spawned from. This allows
* [window managers][gtk-X11-arch] to e.g. keep the
* dialog on top of the main window, or center the dialog over the
* main window. Gtk::Dialog::new_with_buttons() and other convenience
* functions in GTK+ will sometimes call
* set_transient_for() on your behalf.
*
* Passing <tt>nullptr</tt> for @a parent unsets the current transient window.
*
* On Wayland, this function can also be used to attach a new
* Gtk::WINDOW_POPUP to a Gtk::WINDOW_TOPLEVEL parent already mapped
* on screen so that the Gtk::WINDOW_POPUP will be created as a
* subsurface-based window Gdk::WINDOW_SUBSURFACE which can be
* positioned at will relatively to the Gtk::WINDOW_TOPLEVEL surface.
*
* On Windows, this function puts the child window on top of the parent,
* much as the window manager would have done on X.
*
* @param parent Parent window, or <tt>nullptr</tt>.
*/
void set_transient_for(Window& parent);
/** Unsets the current transient window.
* @see set_transient_for().
* @newin{2,20}
*/
void unset_transient_for();
/** Fetches the transient parent for this window. See
* set_transient_for().
*
* @return The transient parent for this
* window, or <tt>nullptr</tt> if no transient parent has been set.
*/
Window* get_transient_for();
/** Fetches the transient parent for this window. See
* set_transient_for().
*
* @return The transient parent for this
* window, or <tt>nullptr</tt> if no transient parent has been set.
*/
const Window* get_transient_for() const;
/** Unsets the attached-to widget.
* @see set_attached_to().
* @newin{3,4}
*/
void unset_attached_to();
/** Marks @a window as attached to @a attach_widget. This creates a logical binding
* between the window and the widget it belongs to, which is used by GTK+ to
* propagate information such as styling or accessibility to @a window as if it
* was a children of @a attach_widget.
*
* Examples of places where specifying this relation is useful are for instance
* a Gtk::Menu created by a Gtk::ComboBox, a completion popup window
* created by Gtk::Entry or a typeahead search entry created by Gtk::TreeView.
*
* Note that this function should not be confused with
* set_transient_for(), which specifies a window manager relation
* between two toplevels instead.
*
* Passing <tt>nullptr</tt> for @a attach_widget detaches the window.
*
* @newin{3,4}
*
* @param attach_widget A Gtk::Widget, or <tt>nullptr</tt>.
*/
void set_attached_to(Widget& attach_widget);
/** Fetches the attach widget for this window. See
* set_attached_to().
*
* @newin{3,4}
*
* @return The widget where the window
* is attached, or <tt>nullptr</tt> if the window is not attached to any widget.
*/
Widget* get_attached_to();
/** Fetches the attach widget for this window. See
* set_attached_to().
*
* @newin{3,4}
*
* @return The widget where the window
* is attached, or <tt>nullptr</tt> if the window is not attached to any widget.
*/
const Widget* get_attached_to() const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** Request the windowing system to make @a window partially transparent,
* with opacity 0 being fully transparent and 1 fully opaque. (Values
* of the opacity parameter are clamped to the [0,1] range.) On X11
* this has any effect only on X screens with a compositing manager
* running. See Gtk::Widget::is_composited(). On Windows it should work
* always.
*
* Note that setting a window’s opacity after the window has been
* shown causes it to flicker once on Windows.
*
* @newin{2,12}
* Deprecated: 3.8: Use gtk_widget_set_opacity instead.
*
* @deprecated Use Widget::set_opacity() instead.
*
* @param opacity Desired opacity, between 0 and 1.
*/
void set_opacity(double opacity);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Fetches the requested opacity for this window. See
* set_opacity().
*
* @newin{2,12}
* Deprecated: 3.8: Use gtk_widget_get_opacity instead.
*
* @deprecated Use Widget::get_opacity() instead.
*
* @return The requested opacity for this window.
*/
double get_opacity() const;
#endif // GTKMM_DISABLE_DEPRECATED
/** By setting the type hint for the window, you allow the window
* manager to decorate and handle the window in a way which is
* suitable to the function of the window in your application.
*
* This function should be called before the window becomes visible.
*
* Gtk::Dialog::new_with_buttons() and other convenience functions in GTK+
* will sometimes call set_type_hint() on your behalf.
*
* @param hint The window type.
*/
void set_type_hint(Gdk::WindowTypeHint hint);
/** Gets the type hint for this window. See set_type_hint().
*
* @return The type hint for @a window.
*/
Gdk::WindowTypeHint get_type_hint() const;
/** Windows may set a hint asking the desktop environment not to display
* the window in the task bar. This function sets this hint.
*
* @newin{2,2}
*
* @param setting <tt>true</tt> to keep this window from appearing in the task bar.
*/
void set_skip_taskbar_hint(bool setting = true);
/** Gets the value set by set_skip_taskbar_hint()
*
* @newin{2,2}
*
* @return <tt>true</tt> if window shouldn’t be in taskbar.
*/
bool get_skip_taskbar_hint() const;
/** Windows may set a hint asking the desktop environment not to display
* the window in the pager. This function sets this hint.
* (A "pager" is any desktop navigation tool such as a workspace
* switcher that displays a thumbnail representation of the windows
* on the screen.)
*
* @newin{2,2}
*
* @param setting <tt>true</tt> to keep this window from appearing in the pager.
*/
void set_skip_pager_hint(bool setting = true);
/** Gets the value set by set_skip_pager_hint().
*
* @newin{2,2}
*
* @return <tt>true</tt> if window shouldn’t be in pager.
*/
bool get_skip_pager_hint() const;
/** Windows may set a hint asking the desktop environment to draw
* the users attention to the window. This function sets this hint.
*
* @newin{2,8}
*
* @param setting <tt>true</tt> to mark this window as urgent.
*/
void set_urgency_hint(bool setting = true);
/** Gets the value set by set_urgency_hint()
*
* @newin{2,8}
*
* @return <tt>true</tt> if window is urgent.
*/
bool get_urgency_hint() const;
/** Windows may set a hint asking the desktop environment not to receive
* the input focus. This function sets this hint.
*
* @newin{2,4}
*
* @param setting <tt>true</tt> to let this window receive input focus.
*/
void set_accept_focus(bool setting = true);
/** Gets the value set by set_accept_focus().
*
* @newin{2,4}
*
* @return <tt>true</tt> if window should receive the input focus.
*/
bool get_accept_focus() const;
/** Windows may set a hint asking the desktop environment not to receive
* the input focus when the window is mapped. This function sets this
* hint.
*
* @newin{2,6}
*
* @param setting <tt>true</tt> to let this window receive input focus on map.
*/
void set_focus_on_map(bool setting = true);
/** Gets the value set by set_focus_on_map().
*
* @newin{2,6}
*
* @return <tt>true</tt> if window should receive the input focus when
* mapped.
*/
bool get_focus_on_map() const;
//_WRAP_METHOD(void set_destroy_with_parent(bool setting = true), gtk_window_set_destroy_with_parent)
// I don't that that this is ever a good thing for C++.murrayc.
//TODO: Remove?
/** Returns whether the window will be destroyed with its transient parent. See
* set_destroy_with_parent().
*
* @return <tt>true</tt> if the window will be destroyed with its transient parent.
*/
bool get_destroy_with_parent() const;
// I don't that that this is ever a good thing for C++.murrayc.
/** If @a setting is <tt>true</tt>, then @a window will request that it’s titlebar
* should be hidden when maximized.
* This is useful for windows that don’t convey any information other
* than the application name in the titlebar, to put the available
* screen space to better use. If the underlying window system does not
* support the request, the setting will not have any effect.
*
* Note that custom titlebars set with set_titlebar() are
* not affected by this. The application is in full control of their
* content and visibility anyway.
*
* @newin{3,4}
*
* @param setting Whether to hide the titlebar when @a window is maximized.
*/
void set_hide_titlebar_when_maximized(bool setting = true);
/** Returns whether the window has requested to have its titlebar hidden
* when maximized. See set_hide_titlebar_when_maximized().
*
* @newin{3,4}
*
* @return <tt>true</tt> if the window has requested to have its titlebar
* hidden when maximized.
*/
bool get_hide_titlebar_when_maximized() const;
/** Sets the Gtk::Window::property_mnemonics_visible() property.
*
* @newin{2,20}
*
* @param setting The new value.
*/
void set_mnemonics_visible(bool setting = true);
/** Gets the value of the Gtk::Window::property_mnemonics_visible() property.
*
* @newin{2,20}
*
* @return <tt>true</tt> if mnemonics are supposed to be visible
* in this window.
*/
bool get_mnemonics_visible() const;
/** Sets the Gtk::Window::property_focus_visible() property.
*
* @newin{3,2}
*
* @param setting The new value.
*/
void set_focus_visible(bool setting = true);
/** Gets the value of the Gtk::Window::property_focus_visible() property.
*
* @newin{3,2}
*
* @return <tt>true</tt> if “focus rectangles” are supposed to be visible
* in this window.
*/
bool get_focus_visible() const;
/** Sets whether the user can resize a window. Windows are user resizable
* by default.
*
* @param resizable <tt>true</tt> if the user can resize this window.
*/
void set_resizable(bool resizable = true);
/** Gets the value set by set_resizable().
*
* @return <tt>true</tt> if the user can resize the window.
*/
bool get_resizable() const;
/** Window gravity defines the meaning of coordinates passed to
* move(). See move() and Gdk::Gravity for
* more details.
*
* The default window gravity is Gdk::GRAVITY_NORTH_WEST which will
* typically “do what you mean.”
*
* @param gravity Window gravity.
*/
void set_gravity(Gdk::Gravity gravity);
/** Gets the value set by set_gravity().
*
* @return Window gravity.
*/
Gdk::Gravity get_gravity() const;
/** This function sets up hints about how a window can be resized by
* the user. You can set a minimum and maximum size; allowed resize
* increments (e.g. for xterm, you can only resize by the size of a
* character); aspect ratios; and more. See the Gdk::Geometry struct.
*
* @param geometry_widget Widget the geometry hints used to be applied to
* or <tt>nullptr</tt>. Since 3.20 this argument is ignored and GTK behaves as if <tt>nullptr</tt> was
* set.
* @param geometry Struct containing geometry information or <tt>nullptr</tt>.
* @param geom_mask Mask indicating which struct fields should be paid attention to.
*/
void set_geometry_hints(Widget& geometry_widget, const Gdk::Geometry& geometry, Gdk::WindowHints geom_mask);
/** Sets the Gdk::Screen where the @a window is displayed; if
* the window is already mapped, it will be unmapped, and
* then remapped on the new screen.
*
* @newin{2,2}
*
* @param screen A Gdk::Screen.
*/
void set_screen(const Glib::RefPtr<Gdk::Screen>& screen);
/** Returns the Gdk::Screen associated with @a window.
*
* @newin{2,2}
*
* @return A Gdk::Screen.
*/
Glib::RefPtr<Gdk::Screen> get_screen();
/** Returns the Gdk::Screen associated with @a window.
*
* @newin{2,2}
*
* @return A Gdk::Screen.
*/
Glib::RefPtr<const Gdk::Screen> get_screen() const;
/** Returns whether the window is part of the current active toplevel.
* (That is, the toplevel window receiving keystrokes.)
* The return value is <tt>true</tt> if the window is active toplevel
* itself, but also if it is, say, a Gtk::Plug embedded in the active toplevel.
* You might use this function if you wanted to draw a widget
* differently in an active window from a widget in an inactive window.
* See has_toplevel_focus()
*
* @newin{2,4}
*
* @return <tt>true</tt> if the window part of the current active window.
*/
bool is_active() const;
/** Returns whether the input focus is within this GtkWindow.
* For real toplevel windows, this is identical to is_active(),
* but for embedded windows, like Gtk::Plug, the results will differ.
*
* @newin{2,4}
*
* @return <tt>true</tt> if the input focus is within this GtkWindow.
*/
bool has_toplevel_focus() const;
/** By default, windows are decorated with a title bar, resize
* controls, etc. Some [window managers][gtk-X11-arch]
* allow GTK+ to disable these decorations, creating a
* borderless window. If you set the decorated property to <tt>false</tt>
* using this function, GTK+ will do its best to convince the window
* manager not to decorate the window. Depending on the system, this
* function may not have any effect when called on a window that is
* already visible, so you should call it before calling Gtk::Widget::show().
*
* On Windows, this function always works, since there’s no window manager
* policy involved.
*
* @param setting <tt>true</tt> to decorate the window.
*/
void set_decorated(bool setting = true);
/** Returns whether the window has been set to have decorations
* such as a title bar via set_decorated().
*
* @return <tt>true</tt> if the window has been set to have decorations.
*/
bool get_decorated() const;
/** By default, windows have a close button in the window frame. Some
* [window managers][gtk-X11-arch] allow GTK+ to
* disable this button. If you set the deletable property to <tt>false</tt>
* using this function, GTK+ will do its best to convince the window
* manager not to show a close button. Depending on the system, this
* function may not have any effect when called on a window that is
* already visible, so you should call it before calling Gtk::Widget::show().
*
* On Windows, this function always works, since there’s no window manager
* policy involved.
*
* @newin{2,10}
*
* @param setting <tt>true</tt> to decorate the window as deletable.
*/
void set_deletable(bool setting = true);
/** Returns whether the window has been set to have a close button
* via set_deletable().
*
* @newin{2,10}
*
* @return <tt>true</tt> if the window has been set to have a close button.
*/
bool get_deletable() const;
/** Retrieves the list of icons set by set_icon_list().
* The list is copied, but the reference count on each
* member won’t be incremented.
*
* @return Copy of window’s icon list.
*/
std::vector< Glib::RefPtr<Gdk::Pixbuf> > get_icon_list();
/** Retrieves the list of icons set by set_icon_list().
* The list is copied, but the reference count on each
* member won’t be incremented.
*
* @return Copy of window’s icon list.
*/
std::vector< Glib::RefPtr<const Gdk::Pixbuf> > get_icon_list() const;
/** Sets up the icon representing a Gtk::Window. The icon is used when
* the window is minimized (also known as iconified). Some window
* managers or desktop environments may also place it in the window
* frame, or display it in other contexts. On others, the icon is not
* used at all, so your mileage may vary.
*
* set_icon_list() allows you to pass in the same icon in
* several hand-drawn sizes. The list should contain the natural sizes
* your icon is available in; that is, don’t scale the image before
* passing it to GTK+. Scaling is postponed until the last minute,
* when the desired final size is known, to allow best quality.
*
* By passing several sizes, you may improve the final image quality
* of the icon, by reducing or eliminating automatic image scaling.
*
* Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and
* larger images (64x64, 128x128) if you have them.
*
* See also set_default_icon_list() to set the icon
* for all windows in your application in one go.
*
* Note that transient windows (those who have been set transient for another
* window using set_transient_for()) will inherit their
* icon from their transient parent. So there’s no need to explicitly
* set the icon on transient windows.
*
* @param list List of Gdk::Pixbuf.
*/
void set_icon_list(const std::vector< Glib::RefPtr<Gdk::Pixbuf> >& list);
/** Sets up the icon representing a Gtk::Window. This icon is used when
* the window is minimized (also known as iconified). Some window
* managers or desktop environments may also place it in the window
* frame, or display it in other contexts. On others, the icon is not
* used at all, so your mileage may vary.
*
* The icon should be provided in whatever size it was naturally
* drawn; that is, don’t scale the image before passing it to
* GTK+. Scaling is postponed until the last minute, when the desired
* final size is known, to allow best quality.
*
* If you have your icon hand-drawn in multiple sizes, use
* set_icon_list(). Then the best size will be used.
*
* This function is equivalent to calling set_icon_list()
* with a 1-element list.
*
* See also set_default_icon_list() to set the icon
* for all windows in your application in one go.
*
* @param icon Icon image, or <tt>nullptr</tt>.
*/
void set_icon(const Glib::RefPtr<Gdk::Pixbuf>& icon);
//TODO: Correct the since tag.
/** Sets the icon for the window from a named themed icon.
* See the docs for Gtk::IconTheme for more details.
* On some platforms, the window icon is not used at all.
*
* Note that this has nothing to do with the WM_ICON_NAME
* property which is mentioned in the ICCCM.
*
* @newin{2,6}
*
* @param name The name of the themed icon.
*/
void set_icon_name(const Glib::ustring& name);
/** Sets the icon for the window.
*
* This function is equivalent to calling set_icon()
* with a pixbuf created by loading the image from @a filename.
*
* @param filename Location of icon file.
* @return <tt>true</tt> if setting the icon succeeded.
*/
bool set_icon_from_file(const std::string& filename);
/** Gets the value set by set_icon() (or if you've
* called set_icon_list(), gets the first icon in
* the icon list).
*
* @return Icon for window.
*/
Glib::RefPtr<Gdk::Pixbuf> get_icon();
/** Gets the value set by set_icon() (or if you've
* called set_icon_list(), gets the first icon in
* the icon list).
*
* @return Icon for window.
*/
Glib::RefPtr<const Gdk::Pixbuf> get_icon() const;
/** Returns the name of the themed icon for the window,
* see set_icon_name().
*
* @newin{2,6}
*
* @return The icon name or <tt>nullptr</tt> if the window has
* no themed icon.
*/
Glib::ustring get_icon_name() const;
/** Sets an icon list to be used as fallback for windows that haven't
* had set_icon_list() called on them to set up a
* window-specific icon list. This function allows you to set up the
* icon for all windows in your app at once.
*
* See set_icon_list() for more details.
*
* @param list A list of Gdk::Pixbuf.
*/
static void set_default_icon_list(const std::vector< Glib::RefPtr<Gdk::Pixbuf> >& list);
/** Gets the value set by Gtk::Window::set_default_icon_list().
*
* @return Copy of default icon list.
*/
static std::vector< Glib::RefPtr<Gdk::Pixbuf> > get_default_icon_list();
/** Sets an icon to be used as fallback for windows that haven't
* had set_icon() called on them from a pixbuf.
*
* @newin{2,4}
*
* @param icon The icon.
*/
static void set_default_icon(const Glib::RefPtr<Gdk::Pixbuf>& icon);
/** Sets an icon to be used as fallback for windows that haven't
* had set_icon_list() called on them from a named
* themed icon, see set_icon_name().
*
* @newin{2,6}
*
* @param name The name of the themed icon.
*/
static void set_default_icon_name(const Glib::ustring& name);
/** Sets an icon to be used as fallback for windows that haven't
* had set_icon_list() called on them from a file
* on disk. Warns on failure if @a err is <tt>nullptr</tt>.
*
* @newin{2,2}
*
* @param filename Location of icon file.
* @return <tt>true</tt> if setting the icon succeeded.
*/
static bool set_default_icon_from_file(const std::string& filename);
/** By default, after showing the first Gtk::Window, GTK+ calls
* gdk_notify_startup_complete(). Call this function to disable
* the automatic startup notification. You might do this if your
* first window is a splash screen, and you want to delay notification
* until after your real main window has been shown, for example.
*
* In that example, you would disable startup notification
* temporarily, show your splash screen, then re-enable it so that
* showing the main window would automatically result in notification.
*
* @newin{2,2}
*
* @param setting <tt>true</tt> to automatically do startup notification.
*/
static void set_auto_startup_notification(bool setting = true);
/** Sets a window modal or non-modal. Modal windows prevent interaction
* with other windows in the same application. To keep modal dialogs
* on top of main application windows, use
* set_transient_for() to make the dialog transient for the
* parent; most [window managers][gtk-X11-arch]
* will then disallow lowering the dialog below the parent.
*
* @param modal Whether the window is modal.
*/
void set_modal(bool modal = true);
/** Returns whether the window is modal. See set_modal().
*
* @return <tt>true</tt> if the window is set to be modal and
* establishes a grab when shown.
*/
bool get_modal() const;
/** Returns a list of all existing toplevel windows. The widgets
* in the list are not individually referenced. If you want
* to iterate through the list and perform actions involving
* callbacks that might destroy the widgets, you must call
* `g_list_foreach (result, (GFunc)g_object_ref, <tt>nullptr</tt>)` first, and
* then unref all the widgets afterwards.
*
* @return List of toplevel widgets.
*/
static std::vector<Window*> list_toplevels();
/** Adds a mnemonic to this window.
*
* @param keyval The mnemonic.
* @param target The widget that gets activated by the mnemonic.
*/
void add_mnemonic(guint keyval, Widget& target);
/** Removes a mnemonic from this window.
*
* @param keyval The mnemonic.
* @param target The widget that gets activated by the mnemonic.
*/
void remove_mnemonic(guint keyval, Widget& target);
/** Activates the targets associated with the mnemonic.
*
* @param keyval The mnemonic.
* @param modifier The modifiers.
* @return <tt>true</tt> if the activation is done.
*/
bool mnemonic_activate(guint keyval, Gdk::ModifierType modifier);
/** Sets the mnemonic modifier for this window.
*
* @param modifier The modifier mask used to activate
* mnemonics on this window.
*/
void set_mnemonic_modifier(Gdk::ModifierType modifier);
/** Returns the mnemonic modifier for this window. See
* set_mnemonic_modifier().
*
* @return The modifier mask used to activate
* mnemonics on this window.
*/
Gdk::ModifierType get_mnemonic_modifier();
/** Presents a window to the user. This may mean raising the window
* in the stacking order, deiconifying it, moving it to the current
* desktop, and/or giving it the keyboard focus, possibly dependent
* on the user’s platform, window manager, and preferences.
*
* If @a window is hidden, this function calls Gtk::Widget::show()
* as well.
*
* This function should be used when the user tries to open a window
* that’s already open. Say for example the preferences dialog is
* currently open, and the user chooses Preferences from the menu
* a second time; use present() to move the already-open dialog
* where the user can see it.
*
* If you are calling this function in response to a user interaction,
* it is preferable to use present_with_time().
*/
void present();
/** Presents a window to the user in response to a user interaction.
* If you need to present a window without a timestamp, use
* present(). See present() for details.
*
* @newin{2,8}
*
* @param timestamp The timestamp of the user interaction (typically a
* button or key press event) which triggered this call.
*/
void present(guint32 timestamp);
/** Asks to iconify (i.e.\ minimize) the specified @a window. Note that
* you shouldn’t assume the window is definitely iconified afterward,
* because other entities (e.g. the user or
* [window manager][gtk-X11-arch]) could deiconify it
* again, or there may not be a window manager in which case
* iconification isn’t possible, etc. But normally the window will end
* up iconified. Just don’t write code that crashes if not.
*
* It’s permitted to call this function before showing a window,
* in which case the window will be iconified before it ever appears
* onscreen.
*
* You can track iconification via the “window-state-event” signal
* on Gtk::Widget.
*/
void iconify();
/** Asks to deiconify (i.e.\ unminimize) the specified @a window. Note
* that you shouldn’t assume the window is definitely deiconified
* afterward, because other entities (e.g. the user or
* [window manager][gtk-X11-arch])) could iconify it
* again before your code which assumes deiconification gets to run.
*
* You can track iconification via the “window-state-event” signal
* on Gtk::Widget.
*/
void deiconify();
/** Asks to stick @a window, which means that it will appear on all user
* desktops. Note that you shouldn’t assume the window is definitely
* stuck afterward, because other entities (e.g. the user or
* [window manager][gtk-X11-arch] could unstick it
* again, and some window managers do not support sticking
* windows. But normally the window will end up stuck. Just don't
* write code that crashes if not.
*
* It’s permitted to call this function before showing a window.
*
* You can track stickiness via the “window-state-event” signal
* on Gtk::Widget.
*/
void stick();
/** Asks to unstick @a window, which means that it will appear on only
* one of the user’s desktops. Note that you shouldn’t assume the
* window is definitely unstuck afterward, because other entities
* (e.g. the user or [window manager][gtk-X11-arch]) could
* stick it again. But normally the window will
* end up stuck. Just don’t write code that crashes if not.
*
* You can track stickiness via the “window-state-event” signal
* on Gtk::Widget.
*/
void unstick();
/** Asks to maximize @a window, so that it becomes full-screen. Note that
* you shouldn’t assume the window is definitely maximized afterward,
* because other entities (e.g. the user or
* [window manager][gtk-X11-arch]) could unmaximize it
* again, and not all window managers support maximization. But
* normally the window will end up maximized. Just don’t write code
* that crashes if not.
*
* It’s permitted to call this function before showing a window,
* in which case the window will be maximized when it appears onscreen
* initially.
*
* You can track maximization via the “window-state-event” signal
* on Gtk::Widget, or by listening to notifications on the
* Gtk::Window::property_is_maximized() property.
*/
void maximize();
/** Asks to unmaximize @a window. Note that you shouldn’t assume the
* window is definitely unmaximized afterward, because other entities
* (e.g. the user or [window manager][gtk-X11-arch])
* could maximize it again, and not all window
* managers honor requests to unmaximize. But normally the window will
* end up unmaximized. Just don’t write code that crashes if not.
*
* You can track maximization via the “window-state-event” signal
* on Gtk::Widget.
*/
void unmaximize();
/** Asks to place @a window in the fullscreen state. Note that you
* shouldn’t assume the window is definitely full screen afterward,
* because other entities (e.g. the user or
* [window manager][gtk-X11-arch]) could unfullscreen it
* again, and not all window managers honor requests to fullscreen
* windows. But normally the window will end up fullscreen. Just
* don’t write code that crashes if not.
*
* You can track the fullscreen state via the “window-state-event” signal
* on Gtk::Widget.
*
* @newin{2,2}
*/
void fullscreen();
/** Asks to toggle off the fullscreen state for @a window. Note that you
* shouldn’t assume the window is definitely not full screen
* afterward, because other entities (e.g. the user or
* [window manager][gtk-X11-arch]) could fullscreen it
* again, and not all window managers honor requests to unfullscreen
* windows. But normally the window will end up restored to its normal
* state. Just don’t write code that crashes if not.
*
* You can track the fullscreen state via the “window-state-event” signal
* on Gtk::Widget.
*
* @newin{2,2}
*/
void unfullscreen();
/** Asks to place @a window in the fullscreen state. Note that you shouldn't assume
* the window is definitely full screen afterward.
*
* You can track the fullscreen state via the "window-state-event" signal
* on Gtk::Widget.
*
* @newin{3,18}
*
* @param screen A Gdk::Screen to draw to.
* @param monitor Which monitor to go fullscreen on.
*/
void fullscreen_on_monitor(const Glib::RefPtr<Gdk::Screen>& screen, int monitor);
/** Requests that the window is closed, similar to what happens
* when a window manager close button is clicked.
*
* This function can be used with close buttons in custom
* titlebars.
*
* @newin{3,10}
*/
void close();
/** Starts resizing a window. This function is used if an application
* has window resizing controls. When GDK can support it, the resize
* will be done using the standard mechanism for the
* [window manager][gtk-X11-arch] or windowing
* system. Otherwise, GDK will try to emulate window resizing,
* potentially not all that well, depending on the windowing system.
*
* @param button Mouse button that initiated the drag.
* @param edge Position of the resize control.
* @param root_x X position where the user clicked to initiate the drag, in root window coordinates.
* @param root_y Y position where the user clicked to initiate the drag.
* @param timestamp Timestamp from the click event that initiated the drag.
*/
void begin_resize_drag(Gdk::WindowEdge edge, int button, int root_x, int root_y, guint32 timestamp);
/** Starts moving a window. This function is used if an application has
* window movement grips. When GDK can support it, the window movement
* will be done using the standard mechanism for the
* [window manager][gtk-X11-arch] or windowing
* system. Otherwise, GDK will try to emulate window movement,
* potentially not all that well, depending on the windowing system.
*
* @param button Mouse button that initiated the drag.
* @param root_x X position where the user clicked to initiate the drag, in root window coordinates.
* @param root_y Y position where the user clicked to initiate the drag.
* @param timestamp Timestamp from the click event that initiated the drag.
*/
void begin_move_drag(int button, int root_x, int root_y, guint32 timestamp);
/** Sets the default size of a window. If the window’s “natural” size
* (its size request) is larger than the default, the default will be
* ignored. More generally, if the default size does not obey the
* geometry hints for the window (set_geometry_hints() can
* be used to set these explicitly), the default size will be clamped
* to the nearest permitted size.
*
* Unlike Gtk::Widget::set_size_request(), which sets a size request for
* a widget and thus would keep users from shrinking the window, this
* function only sets the initial size, just as if the user had
* resized the window themselves. Users can still shrink the window
* again as they normally would. Setting a default size of -1 means to
* use the “natural” default size (the size request of the window).
*
* For more control over a window’s initial size and how resizing works,
* investigate set_geometry_hints().
*
* For some uses, resize() is a more appropriate function.
* resize() changes the current size of the window, rather
* than the size to be used on initial display. resize() always
* affects the window itself, not the geometry widget.
*
* The default size of a window only affects the first time a window is
* shown; if a window is hidden and re-shown, it will remember the size
* it had prior to hiding, rather than using the default size.
*
* Windows can’t actually be 0x0 in size, they must be at least 1x1, but
* passing 0 for @a width and @a height is OK, resulting in a 1x1 default size.
*
* If you use this function to reestablish a previously saved window size,
* note that the appropriate size to save is the one returned by
* get_size(). Using the window allocation directly will not
* work in all circumstances and can lead to growing or shrinking windows.
*
* @param width Width in pixels, or -1 to unset the default width.
* @param height Height in pixels, or -1 to unset the default height.
*/
void set_default_size(int width, int height);
/** Gets the default size of the window. A value of -1 for the width or
* height indicates that a default size has not been explicitly set
* for that dimension, so the “natural” size of the window will be
* used.
*
* @param width Location to store the default width.
* @param height Location to store the default height.
*/
void get_default_size(int& width, int& height) const;
/** Resizes the window as if the user had done so, obeying geometry
* constraints. The default geometry constraint is that windows may
* not be smaller than their size request; to override this
* constraint, call Gtk::Widget::set_size_request() to set the window's
* request to a smaller value.
*
* If resize() is called before showing a window for the
* first time, it overrides any default size set with
* set_default_size().
*
* Windows may not be resized smaller than 1 by 1 pixels.
*
* When using client side decorations, GTK+ will do its best to adjust
* the given size so that the resulting window size matches the
* requested size without the title bar, borders and shadows added for
* the client side decorations, but there is no garantee that the
* result will be totally accurate because these widgets added for
* client side decorations depend on the theme and may not be realized
* or visible at the time resize() is issued.
*
* Typically, resize() will compensate for the GtkHeaderBar
* height only if it's known at the time the resulting GtkWindow
* configuration is issued.
* For example, if new widgets are added after the GtkWindow configuration
* and cause the GtkHeaderBar to grow in height, this will result in a
* window content smaller that specified by resize() and not
* a larger window.
*
* @param width Width in pixels to resize the window to.
* @param height Height in pixels to resize the window to.
*/
void resize(int width, int height);
/** Obtains the current size of @a window. If @a window is not onscreen,
* it returns the size GTK+ will suggest to the
* [window manager][gtk-X11-arch]
* for the initial window
* size (but this is not reliably the same as the size the window
* manager will actually select). The size obtained by
* get_size() is the last size received in a
* Gdk::EventConfigure, that is, GTK+ uses its locally-stored size,
* rather than querying the X server for the size. As a result, if you
* call resize() then immediately call
* get_size(), the size won’t have taken effect yet. After
* the window manager processes the resize request, GTK+ receives
* notification that the size has changed via a configure event, and
* the size of the window gets updated.
*
* @note Nearly any use of this function creates a race condition,
* because the size of the window may change between the time that you
* get the size and the time that you perform some action assuming
* that size is the current size. To avoid race conditions, connect to
* “configure-event” on the window and adjust your size-dependent
* state to match the size delivered in the Gdk::EventConfigure.
*
* @note The returned size does not include the
* size of the window manager decorations (aka the window frame or
* border). Those are not drawn by GTK+ and GTK+ has no reliable
* method of determining their size.
*
* @note If you are getting a window size in order to position
* the window onscreen, there may be a better way. The preferred
* way is to simply set the window’s semantic type with
* set_type_hint(), which allows the window manager to
* e.g. center dialogs. Also, if you set the transient parent of
* dialogs with set_transient_for() window managers
* will often center the dialog over its parent window. It's
* much preferred to let the window manager handle these
* things rather than doing it yourself, because all apps will
* behave consistently and according to user prefs if the window
* manager handles it. Also, the window manager can take the size
* of the window decorations/border into account, while your
* application cannot.
*
* @note When using client side decorations, GTK+ will do its best to
* adjust the returned values to match the logical size of the window
* excluding the widgets added for client side decorations, but there
* is no garantee that the result will be totally accurate because
* these widgets depend on the theme and may not be realized or
* visible at the time get_size() is invoked.
*
* In any case, if you insist on application-specified window
* positioning, there’s still a better way than
* doing it yourself - set_position() will frequently
* handle the details for you.
*
* @param width Return location for width.
* @param height Return location for height.
*/
void get_size(int& width, int& height) const;
/** Asks the [window manager][gtk-X11-arch] to move
* @a window to the given position. %Window managers are free to ignore
* this; most window managers ignore requests for initial window
* positions (instead using a user-defined placement algorithm) and
* honor requests after the window has already been shown.
*
* @note the position is the position of the gravity-determined
* reference point for the window. The gravity determines two things:
* first, the location of the reference point in root window
* coordinates; and second, which point on the window is positioned at
* the reference point.
*
* By default the gravity is Gdk::GRAVITY_NORTH_WEST, so the reference
* point is simply the @a x, @a y supplied to move(). The
* top-left corner of the window decorations (aka window frame or
* border) will be placed at @a x, @a y. Therefore, to position a window
* at the top left of the screen, you want to use the default gravity
* (which is Gdk::GRAVITY_NORTH_WEST) and move the window to 0,0.
*
* To position a window at the bottom right corner of the screen, you
* would set Gdk::GRAVITY_SOUTH_EAST, which means that the reference
* point is at @a x + the window width and @a y + the window height, and
* the bottom-right corner of the window border will be placed at that
* reference point. So, to place a window in the bottom right corner
* you would first set gravity to south east, then write:
* `gtk_window_move (window, gdk_screen_width() - window_width,
* gdk_screen_height() - window_height)` (note that this
* example does not take multi-head scenarios into account).
*
* The [Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec)
* has a nice table of gravities in the “implementation notes” section.
*
* The get_position() documentation may also be relevant.
*
* @param x X coordinate to move window to.
* @param y Y coordinate to move window to.
*/
void move(int x, int y);
/** This function returns the position you need to pass to
* move() to keep @a window in its current position.
* This means that the meaning of the returned value varies with
* window gravity. See move() for more details.
*
* The reliability of this function depends on the windowing system
* currently in use. Some windowing systems, such as Wayland, do not
* support a global coordinate system, and thus the position of the
* window will always be (0, 0). Others, like X11, do not have a reliable
* way to obtain the geometry of the decorations of a window if they are
* provided by the window manager. Additionally, on X11, window manager
* have been known to mismanage window gravity, which result in windows
* moving even if you use the coordinates of the current position as
* returned by this function.
*
* If you haven’t changed the window gravity, its gravity will be
* Gdk::GRAVITY_NORTH_WEST. This means that get_position()
* gets the position of the top-left corner of the window manager
* frame for the window. move() sets the position of this
* same top-left corner.
*
* If a window has gravity Gdk::GRAVITY_STATIC the window manager
* frame is not relevant, and thus get_position() will
* always produce accurate results. However you can’t use static
* gravity to do things like place a window in a corner of the screen,
* because static gravity ignores the window manager decorations.
*
* Ideally, this function should return appropriate values if the
* window has client side decorations, assuming that the windowing
* system supports global coordinates.
*
* In practice, saving the window position should not be left to
* applications, as they lack enough knowledge of the windowing
* system and the window manager state to effectively do so. The
* appropriate way to implement saving the window position is to
* use a platform-specific protocol, wherever that is available.
*
* @param root_x Return location for X coordinate of gravity-determined reference point.
* @param root_y Return location for Y coordinate of gravity-determined reference point.
*/
void get_position(int& root_x, int& root_y) const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** Parses a standard X %Window System geometry string - see the
* manual page for X (type “man X”) for details on this.
* parse_geometry() does work on all GTK+ ports
* including Win32 but is primarily intended for an X environment.
*
* If either a size or a position can be extracted from the
* geometry string, parse_geometry() returns <tt>true</tt>
* and calls set_default_size() and/or move()
* to resize/move the window.
*
* If parse_geometry() returns <tt>true</tt>, it will also
* set the Gdk::HINT_USER_POS and/or Gdk::HINT_USER_SIZE hints
* indicating to the window manager that the size/position of
* the window was user-specified. This causes most window
* managers to honor the geometry.
*
* Note that for parse_geometry() to work as expected, it has
* to be called when the window has its “final” size, i.e. after calling
* Gtk::Widget::show_all() on the contents and set_geometry_hints()
* on the window.
*
* [C example ellipted]
*
* Deprecated: 3.20: Geometry handling in GTK is deprecated.
*
* @deprecated Geometry handling in GTK is deprecated.
*
* @param geometry Geometry string.
* @return <tt>true</tt> if string was parsed successfully.
*/
bool parse_geometry(const Glib::ustring& geometry);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Like set_default_size(), but @a width and @a height are interpreted
* in terms of the base size and increment set with
* gtk_window_set_geometry_hints.
*
* @newin{3,0}
*
* Deprecated: 3.20: This function does nothing. If you want to set a default
* size, use set_default_size() instead.
*
* @deprecated This function does nothing. If you want to set a default size, use set_default_size() instead.
*
* @param width Width in resize increments, or -1 to unset the default width.
* @param height Height in resize increments, or -1 to unset the default height.
*/
void set_default_geometry(int width, int height);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Like resize(), but @a width and @a height are interpreted
* in terms of the base size and increment set with
* gtk_window_set_geometry_hints.
*
* @newin{3,0}
*
* Deprecated: 3.20: This function does nothing. Use
* resize() and compute the geometry yourself.
*
* @deprecated This function does nothing. Use resize() and compute the geometry yourself.
*
* @param width Width in resize increments to resize the window to.
* @param height Height in resize increments to resize the window to.
*/
void resize_to_geometry(int width, int height);
#endif // GTKMM_DISABLE_DEPRECATED
/** Returns the group for @a window or the default group, if
* @a window is <tt>nullptr</tt> or if @a window does not have an explicit
* window group.
*
* @newin{2,10}
*
* @return The Gtk::WindowGroup for a window or the default group.
*/
Glib::RefPtr<WindowGroup> get_group();
/** Returns the group for @a window or the default group, if
* @a window is <tt>nullptr</tt> or if @a window does not have an explicit
* window group.
*
* @newin{2,10}
*
* @return The Gtk::WindowGroup for a window or the default group.
*/
Glib::RefPtr<const WindowGroup> get_group() const;
/** Returns whether @a window has an explicit window group.
*
* @newin{2,22}
*
* @return <tt>true</tt> if @a window has an explicit window group.
*/
bool has_group() const;
/** Gets the type of the window. See Gtk::WindowType.
*
* @newin{2,20}
*
* @return The type of the window.
*/
WindowType get_window_type() const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** Hides @a window, then reshows it, resetting the
* default size and position of the window. Used
* by GUI builders only.
*
* Deprecated: 3.10: GUI builders can call Gtk::Widget::hide(),
* Gtk::Widget::unrealize() and then Gtk::Widget::show() on @a window
* themselves, if they still need this functionality.
*
* @deprecated GUI builders can call Widget::hide(), Widget::unrealize() and then Widget::show() themselves, if they still need this functionality.
*/
void reshow_with_initial_size();
#endif // GTKMM_DISABLE_DEPRECATED
/** Gets the Gtk::Application associated with the window (if any).
*
* @newin{3,0}
*
* @return A Gtk::Application, or <tt>nullptr</tt>.
*/
Glib::RefPtr<Application> get_application();
/** Gets the Gtk::Application associated with the window (if any).
*
* @newin{3,0}
*
* @return A Gtk::Application, or <tt>nullptr</tt>.
*/
Glib::RefPtr<const Application> get_application() const;
/** Sets or unsets the Gtk::Application associated with the window.
*
* The application will be kept alive for at least as long as the window
* is open.
*
* @newin{3,0}
*
* @param application A Gtk::Application, or <tt>nullptr</tt>.
*/
void set_application(const Glib::RefPtr<Application>& application);
/** Unsets the Application associated with the window.
* This could cause the application to exit if it is the application's last window.
*/
void unset_application();
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets whether @a window has a corner resize grip.
*
* Note that the resize grip is only shown if the window
* is actually resizable and not maximized. Use
* resize_grip_is_visible() to find out if the
* resize grip is currently shown.
*
* @newin{3,0}
*
* Deprecated: 3.14: Resize grips have been removed.
*
* @deprecated Resize grips have been removed.
*
* @param value <tt>true</tt> to allow a resize grip.
*/
void set_has_resize_grip(bool value = true);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Determines whether the window may have a resize grip.
*
* @newin{3,0}
*
* Deprecated: 3.14: Resize grips have been removed.
*
* @deprecated Resize grips have been removed.
*
* @return <tt>true</tt> if the window has a resize grip.
*/
bool get_has_resize_grip() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Determines whether a resize grip is visible for the specified window.
*
* @newin{3,0}
*
* Deprecated: 3.14: Resize grips have been removed.
*
* @deprecated Resize grips have been removed.
*
* @return <tt>true</tt> if a resize grip exists and is visible.
*/
bool get_resize_grip_is_visible() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** If a window has a resize grip, this will retrieve the grip
* position, width and height into the specified Gdk::Rectangle.
*
* @newin{3,0}
*
* Deprecated: 3.14: Resize grips have been removed.
*
* @deprecated Resize grips have been removed.
*
* @param rect A pointer to a Gdk::Rectangle which we should store
* the resize grip area.
* @return <tt>true</tt> if the resize grip’s area was retrieved.
*/
bool get_resize_grip_area(Gdk::Rectangle& rect) const;
#endif // GTKMM_DISABLE_DEPRECATED
/** Asks to keep @a window above, so that it stays on top. Note that
* you shouldn’t assume the window is definitely above afterward,
* because other entities (e.g. the user or
* [window manager][gtk-X11-arch]) could not keep it above,
* and not all window managers support keeping windows above. But
* normally the window will end kept above. Just don’t write code
* that crashes if not.
*
* It’s permitted to call this function before showing a window,
* in which case the window will be kept above when it appears onscreen
* initially.
*
* You can track the above state via the “window-state-event” signal
* on Gtk::Widget.
*
* Note that, according to the
* [Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec),
* the above state is mainly meant for user preferences and should not
* be used by applications e.g. for drawing attention to their
* dialogs.
*
* @newin{2,4}
*
* @param setting Whether to keep @a window above other windows.
*/
void set_keep_above(bool setting = true);
/** Asks to keep @a window below, so that it stays in bottom. Note that
* you shouldn’t assume the window is definitely below afterward,
* because other entities (e.g. the user or
* [window manager][gtk-X11-arch]) could not keep it below,
* and not all window managers support putting windows below. But
* normally the window will be kept below. Just don’t write code
* that crashes if not.
*
* It’s permitted to call this function before showing a window,
* in which case the window will be kept below when it appears onscreen
* initially.
*
* You can track the below state via the “window-state-event” signal
* on Gtk::Widget.
*
* Note that, according to the
* [Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec),
* the above state is mainly meant for user preferences and should not
* be used by applications e.g. for drawing attention to their
* dialogs.
*
* @newin{2,4}
*
* @param setting Whether to keep @a window below other windows.
*/
void set_keep_below(bool setting = true);
/** Sets a custom titlebar for @a window.
*
* If you set a custom titlebar, GTK+ will do its best to convince
* the window manager not to put its own titlebar on the window.
* Depending on the system, this function may not work for a window
* that is already visible, so you set the titlebar before calling
* Gtk::Widget::show().
*
* @newin{3,10}
*
* @param titlebar The widget to use as titlebar.
*/
void set_titlebar(Widget& titlebar);
/** Returns the custom titlebar that has been set with
* set_titlebar().
*
* @newin{3,16}
*
* @return The custom titlebar, or <tt>nullptr</tt>.
*/
Widget* get_titlebar();
/** Returns the custom titlebar that has been set with
* set_titlebar().
*
* @newin{3,16}
*
* @return The custom titlebar, or <tt>nullptr</tt>.
*/
const Widget* get_titlebar() const;
/** Retrieves the current maximized state of @a window.
*
* Note that since maximization is ultimately handled by the window
* manager and happens asynchronously to an application request, you
* shouldn’t assume the return value of this function changing
* immediately (or at all), as an effect of calling
* maximize() or unmaximize().
*
* @newin{3,12}
*
* @return Whether the window has a maximized state.
*/
bool is_maximized() const;
/** Returns a default accel group for this window
* This is a gtkmm-specific function. This accel group can not
* be removed.
*/
Glib::RefPtr<AccelGroup> get_accel_group();
//TODO: Remove the virtual from this when we can break ABI.
/** Brings the window to the front.
* This is just a more obvious convenience wrapper for get_window()->raise().
*/
virtual void raise();
///Overriden to warn that it doesn't make sense to use Gtk::manage() on this class because it has no parent container.
void set_manage() override;
protected:
//See comments in the implementations:
void destroy_();
void _release_c_instance();
private:
//We'll create an accel_group if it's requested, and remember it.
//Otherwise, you'd have to create it, add it to the window, then remember it somewhere else while you add it to other widgets.
Glib::RefPtr<AccelGroup> accel_group_;
};
} // namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::Window
*/
Gtk::Window* wrap(GtkWindow* object, bool take_copy = false);
} //namespace Glib
#endif /* _GTKMM_WINDOW_H */
|