/usr/include/Wt/WApplication is in libwt-dev 3.3.3+dfsg-4.1.
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 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WAPPLICATION_
#define WAPPLICATION_
#include <vector>
#include <string>
#include <set>
// even boost/poolfwd.hpp includes <windows.h> ...
namespace boost {
struct default_user_allocator_new_delete;
template <typename UserAllocator>
class pool;
}
#include <boost/any.hpp>
#include <boost/shared_ptr.hpp>
#include <Wt/WObject>
#include <Wt/WCssStyleSheet>
#include <Wt/WEvent>
#include <Wt/WJavaScriptPreamble>
#include <Wt/WLocale>
#include <Wt/WMessageResourceBundle>
#include <Wt/WSignal>
#include <Wt/WString>
#include <boost/function.hpp>
namespace Wt {
#ifndef WT_TARGET_JAVA
/*
* Symbols used to check that included version matches library version
* against which you link.
*/
struct WtLibVersion { };
extern WT_API const WtLibVersion WT_INCLUDED_VERSION;
#endif
class WApplication;
class WCombinedLocalizedStrings;
class WContainerWidget;
class WEnvironment;
class WEvent;
class WLoadingIndicator;
class WLogEntry;
class WResource;
class WText;
namespace Ext {
class Dialog;
class MessageBox;
}
class WebSession;
class UpdateLockImpl;
class SoundManager;
#ifndef WT_TARGET_JAVA
/*! \brief Typedef for a function that creates WApplication objects.
*
* \sa WRun()
*
* \relates WApplication
*/
typedef boost::function<WApplication* (const WEnvironment&)> ApplicationCreator;
#endif // !WT_TARGET_JAVA
#ifdef WT_TARGET_JAVA
/*! \brief An HTML Meta Header
*/
#endif // WT_TARGET_JAVA
class MetaHeader {
public:
/*! \brief Constructor
*
* Creates a meta header. The lang and user agents are optional, and should
* be an empty string if not used.
*/
MetaHeader(MetaHeaderType type, const std::string& name,
const WString& content, const std::string& lang,
const std::string& userAgent);
MetaHeaderType type;
std::string name, lang, userAgent;
WString content;
};
/*! \class WApplication Wt/WApplication Wt/WApplication
* \brief Represents an application instance for a single session.
*
* \if cpp
*
* Each user session of your application has a corresponding
* %WApplication instance. You need to create a new instance and return
* it as the result of the callback function passed to WRun(). The
* instance is the main entry point to session information, and holds
* a reference to the root() of the widget tree.
*
* \elseif java
*
* Each user session of your application has a corresponding
* %WApplication instance. You need to create a new instance and return
* it as the result of {javadoclink WtServlet#createApplication(WEnvironment)}.
* The instance is the main entry point to session information,
* and holds a reference to the root() of the widget tree.
*
* \endif
*
* The recipe for a %Wt web application, which allocates new
* WApplication instances for every user visiting the application is
* thus:
*
* \if cpp
* \code
* WApplication *createApplication(const WEnvironment WEnvironment& env)
* {
* //
* // Optionally, check the environment and redirect to an error page.
* //
* bool valid = ...;
*
* WApplication *app;
* if (!valid) {
* app = new WApplication(env);
* app->redirect("error.html");
* app->quit();
* } else {
* // usually you will specialize your application class
* app = new WApplication(env);
*
* //
* // Add widgets to app->root() and return the application object.
* //
* }
*
* return app;
* }
* \endcode
* \elseif java
* \code
* public class HelloServlet extends WtServlet {
* public HelloServlet() {
* super();
* }
*
* public WApplication createApplication(WEnvironment env) {
* // In practice, you will specialize WApplication and simply
* // return a new instance.
* WApplication app = new WApplication(env);
* app.getRoot().addWidget(new WText("Hello world."));
* return app;
* }
* }
* \endcode
* \endif
*
* \if cpp
*
* Throughout the session, the instance is available through
* WApplication::instance() (or through #wApp). The application may be
* exited either using the method quit(), or because of a timeout
* after the user has closed the window, but not because the user does
* not interact: keep-alive messages in the background will keep the
* session around as long as the user has the page opened. In either
* case, the application object is deleted, allowing for cleanup of
* the entire widget tree, and any other resources.
*
* \elseif java
*
* Throughout the session, the instance is available through the
* static method WApplication::instance(), which uses thread-specific
* storage to keep track of the current session. The application may
* be exited either using the method quit(), or because of a timeout
* after the user has closed the window, but not because the user does
* not interact: keep-alive messages in the background will keep the
* session around as long as the user has the page opened.
*
* \endif
*
* The %WApplication object provides access to session-wide settings, including:
*
* - circumstancial information through environment(), which gives
* details about the user, start-up arguments, and user agent
* capabilities.
* - the application title with setTitle().
* - inline and external style sheets using styleSheet() and
* useStyleSheet().
* - inline and external JavaScript using doJavaScript() and require().
* - the top-level widget in root(), representing the entire browser window,
* or multiple top-level widgets using bindWidget() when deployed in
* %WidgetSet mode to manage a number of widgets within a 3rd party page.
* - definition of cookies using setCookie() to persist information across
* sessions, which may be read using WEnvironment::getCookie() in a future
* session.
* - management of the internal path (that enables browser history and
* bookmarks) using setInternalPath() and related methods.
* - support for server-initiated updates with enableUpdates()
* \if cpp
* - localization information and message resources bundles using setLocale()
* and messageResourceBundle().
* \elseif java
* - localization information and message resources bundles, with
* setLocale() and setLocalizedStrings()
* \endif
*/
class WT_API WApplication : public WObject
{
public:
/*! \brief Enumeration that indicates the method for dynamic (AJAX-alike)
* updates ((<b>deprecated</b>).
*
* \sa setAjaxMethod()
*/
enum AjaxMethod {
XMLHttpRequest, //!< Using the XMLHttpRequest object (real AJAX)
DynamicScriptTag //!< Using dynamic script tags (for cross-domain AJAX)
};
#ifndef WT_TARGET_JAVA
/*! \brief Typedef for a function that creates WApplication objects.
*
* \sa WRun()
*/
typedef Wt::ApplicationCreator ApplicationCreator;
#endif // WT_TARGET_JAVA
/*! \brief Creates a new application instance.
*
* The \p environment provides information on the initial request,
* user agent, and deployment-related information.
*/
#if defined(DOXYGEN_ONLY) || defined(WT_TARGET_JAVA)
WApplication(const WEnvironment& environment);
#else
WApplication(const WEnvironment& environment,
WtLibVersion version = WT_INCLUDED_VERSION);
#endif
#ifndef WT_TARGET_JAVA
/*! \brief Destructor.
*
* The destructor deletes the root() container, and as a consequence
* the entire widget tree.
*/
~WApplication();
#endif // WT_TARGET_JAVA
/*! \brief Returns the current application instance.
*
* \if cpp
* This is the same as the global define #wApp. In a multi-threaded server,
* this method uses thread-specific storage to fetch the current session.
* \elseif java
* This method uses thread-specific storage to fetch the current session.
* \endif
*/
static WApplication *instance();
/*! \brief Returns the environment information.
*
* This method returns the environment object that was used when
* constructing the application. The environment provides
* information on the initial request, user agent, and
* deployment-related information.
*
* \sa url(), sessionId()
*/
const WEnvironment& environment() const;
/*! \brief Returns the root container.
*
* This is the top-level widget container of the application, and
* corresponds to entire browser window. The user interface of your
* application is represented by the content of this container.
*
* \if cpp
*
* The %root() widget is only defined when the application manages
* the entire window. When deployed as a \link Wt::WidgetSet
* WidgetSet\endlink application, there is no %root() container, and
* \c 0 is returned. Instead, use bindWidget() to bind one or more
* root widgets to existing HTML <div> (or other) elements on
* the page.
*
* \elseif java
*
* The root() widget is only defined when the application manages
* the entire window. When deployed as a \link Wt::WidgetSet
* WidgetSet\endlink application, there is no %root() container, and
* <code>null</code> is returned. Instead, use bindWidget() to bind
* one or more root widgets to existing HTML <div> (or other)
* elements on the page.
*
* \endif
*/
WContainerWidget *root() const { return widgetRoot_; }
/*! \brief Finds a widget by name.
*
* This finds a widget in the application's widget hierarchy. It
* does not only consider widgets in the root(), but also widgets
* that are placed outside this root, such as in dialogs, or other
* "roots" such as all the bound widgets in a widgetset application.
*
* \sa WWidget::setObjectName(), WWidget::find()
*/
WWidget *findWidget(const std::string& name);
/** @name Style sheets and CSS
*/
//@{
/*! \brief Returns a reference to the inline style sheet.
*
* Widgets may allow configuration of their look and feel through
* style classes. These may be defined in this inline stylesheet, or
* in external style sheets.
*
* It is usually preferable to use external stylesheets (and
* consider more accessible). Still, the internal stylesheet has as
* benefit that style rules may be dynamically updated, and it is
* easier to manage logistically.
*
* \sa useStyleSheet()
* \sa WWidget::setStyleClass()
*/
WCssStyleSheet& styleSheet() { return styleSheet_; }
/*! \brief Adds an external style sheet.
*
* The \p link is a link to a stylesheet.
*
* The \p media indicates the CSS media to which this stylesheet
* applies. This may be a comma separated list of media. The default
* value is "all" indicating all media.
*
* This is an overloaded method for convenience, equivalent to:
* \code
* useStyleSheet(Wt::WCssStyleSheet(link, media))
* \endcode
*/
void useStyleSheet(const WLink& link, const std::string& media = "all");
/*! \brief Conditionally adds an external style sheet.
*
* This is an overloaded method for convenience, equivalent to:
* \code
* useStyleSheet(Wt::WCssStyleSheet(link, media), condition)
* \endcode
*/
void useStyleSheet(const WLink& link, const std::string& condition,
const std::string& media);
/*! \brief Adds an external stylesheet.
*
* Widgets may allow configuration of their look and feel through
* style classes. These may be defined in an inline stylesheet,
* or in external style sheets.
*
* External stylesheets are inserted after the internal style sheet,
* and can therefore override default styles set by widgets in the
* internal style sheet.
*
* If not empty, \p condition is a string that is used to apply the
* stylesheet to specific versions of IE. Only a limited subset of
* the IE conditional comments syntax is supported (since these are
* in fact interpreted server-side instead of client-side). Examples
* are:
*
* - "IE gte 6": only for IE version 6 or later.
* - "!IE gte 6": only for IE versions prior to IE6.
* - "IE lte 7": only for IE versions prior to IE7.
*
* \sa styleSheet(), useStyleSheet(const std::string&, const std::string&)
* \sa WWidget::setStyleClass()
*/
void useStyleSheet(const WCssStyleSheet& styleSheet,
const std::string& condition = "");
/*! \brief Sets the theme.
*
* The theme provides the look and feel of several built-in widgets,
* using CSS style rules. Rules for each theme are defined in the
* <tt>resources/themes/</tt><i>theme</i><tt>/</tt> folder.
*
* The default theme is "default" CSS theme.
*/
void setTheme(const WTheme *theme);
/*! \brief Returns the theme.
*/
const WTheme *theme() const { return theme_; }
/*! \brief Sets a CSS theme.
*
* This sets a WCssTheme as theme.
*
* The theme provides the look and feel of several built-in widgets,
* using CSS style rules. Rules for each CSS theme are defined in
* the <tt>resources/themes/</tt><i>name</i><tt>/</tt> folder.
*
* The default theme is "default". Setting an empty theme "" will
* result in a stub CSS theme that does not load any stylesheets.
*/
void setCssTheme(const std::string& name);
/*! \brief Sets the layout direction.
*
* The default direction is LeftToRight.
*
* This sets the language text direction, which by itself sets the
* default text alignment and reverse the column orders of <table>
* elements.
*
* In addition, %Wt will take this setting into account in WTextEdit,
* WTableView and WTreeView (so that columns are reverted), and swap
* the behaviour of WWidget::setFloatSide() and
* WWidget::setOffsets() for RightToLeft languages. Note that CSS
* settings themselves are not affected by this setting, and thus
* for example <tt>"float: right"</tt> will move a box to the right,
* irrespective of the layout direction.
*
* The library sets <tt>"Wt-ltr"</tt> or <tt>"Wt-rtl"</tt> as style
* classes for the document body. You may use this if to override
* certain style rules for a Right-to-Left document.
*
* For example:
* \code
* body .sidebar { float: right; }
* body.Wt-rtl .sidebar { float: left; }
* \endcode
*
* \note The layout direction can be set only at application startup
* and does not have the effect of rerendering the entire UI.
*/
void setLayoutDirection(LayoutDirection direction);
/*! \brief Returns the layout direction.
*
* \sa setLayoutDirection()
*/
LayoutDirection layoutDirection() const { return layoutDirection_; }
/*! \brief Sets a style class to the entire page <body>.
*
* \sa setHtmlClass()
*/
void setBodyClass(const std::string& styleClass);
/*! \brief Returns the style class set for the entire page <body>.
*
* \sa setBodyClass()
*/
std::string bodyClass() const { return bodyClass_; }
/*! \brief Sets a style class to the entire page <html>.
*
* \sa setBodyClass()
*/
void setHtmlClass(const std::string& styleClass);
/*! \brief Returns the style class set for the entire page <html>.
*
* \sa setHtmlClass()
*/
std::string htmlClass() const { return htmlClass_; }
//@}
/*! \brief Sets the window title.
*
* Sets the browser window title to \p title.
*
* The default title is "".
*
* \sa title()
*/
void setTitle(const WString& title);
/*! \brief Returns the window title.
*
* \sa setTitle(const WString&)
*/
const WString& title() const { return title_; }
/*! \brief Returns the close message.
*
* \sa setConfirmCloseMessage()
*/
const WString& closeMessage() const { return closeMessage_; }
/*! \brief Returns the resource object that provides localized strings.
*
* \if cpp
* The default value is a WMessageResourceBundle instance, which
* uses XML files to resolve localized strings, but you can set a
* custom class using setLocalizedStrings().
* \elseif java
* This returns the object previously set using setLocalizedStrings().
* \endif
*
* WString::tr() is used to create localized strings, whose
* localized translation is looked up through this object, using a
* key.
*
* \if cpp
* \sa WString::tr(), messageResourceBundle()
* \elseif java
* \sa WString::tr()
* \endif
*/
WLocalizedStrings *localizedStrings();
#ifdef WT_TARGET_JAVA
/*! \brief Accesses the built-in resource bundle.
*
* This is an internal function and should not be called directly.
*
* \sa localizedStrings()
*/
#endif // WT_TARGET_JAVA
WMessageResourceBundle& builtinLocalizedStrings();
/*! \brief Sets the resource object that provides localized strings.
*
* The \p translator resolves localized strings within the current
* application locale.
*
* \if cpp
* The previous resource is deleted, and ownership of the new resource
* passes to the application.
* \endif
*
* \sa localizedStrings(), WString::tr(const char *key)
*/
void setLocalizedStrings(WLocalizedStrings *stringResolver);
#ifndef WT_TARGET_JAVA
/*! \brief Returns the message resource bundle.
*
* The message resource bundle defines the list of external XML
* files that are used to lookup localized strings.
*
* The default localizedStrings() is a WMessageResourceBundle
* object, and this method returns localizedStrings() downcasted to
* this type.
*
* \sa WString::tr(const char *key)
*/
WMessageResourceBundle& messageResourceBundle();
#endif // WT_TARGET_JAVA
/*! \brief Changes the locale.
*
* The locale is used by the localized strings resource to resolve
* localized strings.
*
* By passing an empty \p locale, the default locale is
* chosen.
*
* When the locale is changed, refresh() is called, which will
* resolve the strings of the current user-interface in the new
* locale.
*
* At construction, the locale is copied from the environment
* (WEnvironment::locale()), and this is the locale that was
* configured by the user in his browser preferences, and passed
* using an HTTP request header.
*
* \sa localizedStrings(), WString::tr()
*/
void setLocale(const WLocale& locale);
/*! \brief Returns the current locale.
*
* \sa setLocale(const WLocale&)
*/
const WLocale& locale() const { return locale_; }
/*! \brief Refreshes the application.
*
* This lets the application to refresh its data, including strings
* from message-resource bundles. This done by propagating
* WWidget::refresh() through the widget hierarchy.
*
* This method is also called when the user hits the refresh (or
* reload) button, if this can be caught within the current session.
*
* \if cpp
*
* The reload button may only be caught when %Wt is configured so that
* reload should not spawn a new session. When URL rewriting is used for
* session tracking, this will cause an ugly session ID to be added to the
* URL. See \ref config_session for configuring the reload
* behavior ("<reload-is-new-session>").
*
* \elseif java
*
* The reload button may only be caught when cookies for session
* tracking are configured in the servlet container.
*
* \endif
*
* \sa WWidget::refresh()
*/
virtual void refresh();
/*! \brief Binds a top-level widget for a WidgetSet deployment.
*
* This method binds a \p widget to an existing element with DOM id
* \p domId on the page. The element type should correspond with
* the widget type (e.g. it should be a <div> for a
* WContainerWidget, or a <table> for a WTable).
*
* \sa root()
* \sa Wt::WidgetSet
*/
void bindWidget(WWidget *widget, const std::string& domId);
/** @name URLs and internal paths
*/
//@{
/*! \brief Returns a URL for the current session
*
* Returns the (relative) URL for this application session
* (including the session ID if necessary). The URL includes the
* full application path, and is expanded by the browser into a full
* URL.
*
* For example, for an application deployed at \code
* http://www.mydomain.com/stuff/app.wt \endcode this method might
* return <tt>"/stuff/app.wt?wtd=AbCdEf"</tt>. Additional query
* parameters can be appended in the form of
* <tt>"¶m1=value¶m2=value"</tt>.
*
* To obtain a URL that is suitable for bookmarking the current
* application state, to be used across sessions, use bookmarkUrl()
* instead.
*
* \sa redirect(), WEnvironment::hostName(), WEnvironment::urlScheme()
* \sa bookmarkUrl()
*/
std::string url(const std::string& internalPath = std::string()) const;
/*! \brief Makes an absolute URL.
*
* Returns an absolute URL for a given (relative url) by including
* the schema, hostname, and deployment path.
*
* If \p url is "", then the absolute base URL is returned. This is
* the absolute URL at which the application is deployed, up to the
* last '/'.
*
* This is not used in the library, except when a public URL is
* needed, e.g. for inclusion in an email.
*
* You may want to reimplement this method when the application is
* hosted behind a reverse proxy or in general the public URL of the
* application cannot be guessed correctly by the application.
*/
virtual std::string makeAbsoluteUrl(const std::string& url) const;
/*! \brief "Resolves" a relative URL taking into account internal paths.
*
* Using HTML5 History API or in a plain HTML session (without ugly
* internal paths), the internal path is present as a full part of
* the URL. This has a consequence that relative URLs, if not dealt
* with, would be resolved against the last 'folder' name of the
* internal path, rather than against the application deployment
* path (which is what you probably want).
*
* When using a widgetset mode deployment, or when configuring a
* baseURL property in the configuration, this method will make an
* absolute URL so that the property is fetched from the right
* server.
*
* Otherwise, this method will fixup a relative URL so that it
* resolves correctly against the base path of an application. This
* does not necessarily mean that the URL is resolved into an
* absolute URL. In fact, %Wt will simply prepend a sequence of "../"
* path elements to correct for the internal path. When passed an
* absolute URL (i.e. starting with '/'), the url is returned
* unchanged.
*
* For URLs passed to the %Wt API (and of which the library knows it
* is represents a URL) this method is called internally by the
* library. But it may be useful for URLs which are set e.g. inside
* a WTemplate.
*/
std::string resolveRelativeUrl(const std::string& url) const;
/*! \brief Returns a bookmarkable URL for the current internal path.
*
* Is equivalent to <tt>bookmarkUrl(internalPath())</tt>, see
* bookmarkUrl(const std::string&) const.
*
* To obtain a URL that is refers to the current session of the
* application, use url() instead.
*
* \sa url(), bookmarkUrl(const std::string&) const
*/
std::string bookmarkUrl() const;
/*! \brief Returns a bookmarkable URL for a given internal path.
*
* Returns the (relative) URL for this application that includes the
* internal path \p internalPath, usable across sessions.
*
* The returned URL concatenates the internal path to the application
* base URL, and when no JavaScript is available and URL rewriting is used
* for session-tracking, a session Id is appended to reuse an existing
* session if available.
*
* \if cpp
* See also \ref config_session for configuring the session-tracking
* method.
*
* For the built-in httpd, when the application is deployed at a folder
* (ending with '/'), only an exact matching path is routed to
* the application (this can be changed since Wt 3.1.9, see
* \ref wthttpd ), making clean URLs impossible. Returned URLs then
* include a <tt>"?_="</tt> encoding for the internal path.
* \endif
*
* You can use bookmarkUrl() as the destination for a WAnchor, and
* listen to a click event is attached to a slot that switches to
* the internal path \p internalPath (see
* WAnchor::setRefInternalPath()). In this way, an anchor can be
* used to switch between internal paths within an application
* regardless of the situation (browser with or without Ajax
* support, or a web spider bot), but still generates suitable URLs
* across sessions, which can be used for bookmarking, opening in a
* new window/tab, or indexing.
*
* To obtain a URL that refers to the current session of the
* application, use url() instead.
*
* \sa url(), bookmarkUrl()
*
* \if cpp
* \note the \p internalPath should be UTF8 encoded (we may fix the API
* to use WString in the future).
* \endif
*/
std::string bookmarkUrl(const std::string& internalPath) const;
/*! \brief Changes the internal path.
*
* A %Wt application may manage multiple virtual paths. The virtual
* path is appended to the application URL. Depending on the
* situation, the path is directly appended to the application URL
* or it is appended using a name anchor (#).
*
* For example, for an application deployed at:
* \code
* http://www.mydomain.com/stuff/app.wt
* \endcode
* for which an \p internalPath <tt>"/project/z3cbc/details/"</tt> is
* set, the two forms for the application URL are:
* <ul>
* <li> in an AJAX session (HTML5):
* \code
* http://www.mydomain.com/stuff/app.wt/project/z3cbc/details/
* \endcode
* </li><li> in an AJAX session (HTML4):
* \code
* http://www.mydomain.com/stuff/app.wt#/project/z3cbc/details/
* \endcode
* </li><li>
* </li><li>
* in a plain HTML session:
* \code
* http://www.mydomain.com/stuff/app.wt/project/z3cbc/details/
* \endcode
* </li></ul>
*
* Note, since %Wt 3.1.9, the actual form of the URL no longer
* affects relative URL resolution, since now %Wt includes an HTML
* <tt>meta base</tt> tag which points to the deployment path,
* regardless of the current internal path. This does break
* deployments behind a reverse proxy which changes paths.
*
* \if cpp
* For the built-in httpd, when the application is deployed
* at a folder (ending with '/'), only an exact matching path is
* routed to the application (this can be changed since Wt 3.1.9,
* see \ref wthttpd ), making clean URLs impossible. Returned
* URLs then include a <tt>"?_="</tt> encoding for the internal
* path:
*
* \code
* http://www.mydomain.com/stuff/?_=/project/z3cbc/details/
* \endcode
* \endif
*
* When the internal path is changed, an entry is added to the
* browser history. When the user navigates back and forward through
* this history (using the browser back/forward buttons), an
* internalPathChanged() event is emitted. You should listen to this
* signal to switch the application to the corresponding state. When
* \p emitChange is \c true, this signal is also emitted by setting
* the path (but only if the path is actually changed).
*
* A url that includes the internal path may be obtained using
* bookmarkUrl().
*
* The \p internalPath must start with a '/'. In this way, you
* can still use normal anchors in your HTML. Internal path changes
* initiated in the browser to paths that do not start with a '/'
* are ignored.
*
* \sa bookmarkUrl(), internalPath(), internalPathChanged()
*
* \if cpp
* \note the \p path should be UTF8 encoded (we may fix the API
* to use WString in the future).
* \endif
*/
void setInternalPath(const std::string& path, bool emitChange = false);
/*! \brief Sets whether an internal path is valid by default.
*
* This configures how you treat (invalid) internal paths. If an
* internal path is treated valid by default then you need to call
* setInternalPath(false) for an invalid path. If on the other hand
* you treat an internal path as invalid by default, then you need
* to call setInternalPath(true) for a valid path.
*
* A user which opens an invalid internal path will receive a HTTP
* 404-Not Found response code (if sent an HTML response).
*
* The default value is \c true.
*/
void setInternalPathDefaultValid(bool valid);
/*! \brief Returns whether an internal path is valid by default.
*
* \sa setInternalPathDefaultValid()
*/
bool internalPathDefaultValid() const { return internalPathDefaultValid_; }
/*! \brief Sets whether the current internal path is valid.
*
* You can use this function in response to an internal path change
* event (or at application startup) to indicate whether the new (or
* initial) internal path is valid. This has only an effect on plain
* HTML sessions, or on the first response in an application
* deployed with progressive bootstrap settings, as this generates
* then a 404 Not-Found response.
*
* \sa internalPathChanged(), setInternalPathDefaultValid()
*/
void setInternalPathValid(bool valid);
/*! \brief Returns whether the current internal path is valid.
*
* \sa setInternalPathValid()
*/
bool internalPathValid() const { return internalPathValid_; }
/*! \brief Returns the current internal path.
*
* When the application is just created, this is equal to
* WEnvironment::internalPath().
*
* \sa setInternalPath(), internalPathNextPart(), internalPathMatches()
*
* \if cpp
* \note the \p returned path is UTF8 (we may fix the API
* to use WString in the future).
* \endif
*/
std::string internalPath() const;
/*! \brief Returns a part of the current internal path.
*
* This is a convenience method which returns the next \p folder
* in the internal path, after the given \p path.
*
* For example, when the current internal path is
* <tt>"/project/z3cbc/details"</tt>, this method returns
* <tt>"details"</tt> when called with <tt>"/project/z3cbc/"</tt> as
* \p path argument.
*
* The \p path must start with a '/', and internalPathMatches()
* should evaluate to \c true for the given \p path. If not,
* an empty string is returned and an error message is logged.
*
* \sa internalPath(), internalPathChanged()
*
* \if cpp
* \note the \p internal path is UTF8 encoded (we may fix the API
* to use WString in the future).
* \endif
*/
std::string internalPathNextPart(const std::string& path) const;
std::string internalSubPath(const std::string& path) const;
/*! \brief Checks if the internal path matches a given path.
*
* Returns whether the current internalPath() starts with
* \p path (or is equal to \p path). You will typically use
* this method within a slot conneted to the internalPathChanged()
* signal, to check that an internal path change affects the
* widget. It may also be useful before changing \p path using
* setInternalPath() if you do not intend to remove sub paths when
* the current internal path already matches \p path.
*
* The \p path must start with a '/'.
*
* \sa setInternalPath(), internalPath()
*
* \if cpp
* \note the \p internal path is UTF8 encoded (we may fix the API
* to use WString in the future).
* \endif
*/
bool internalPathMatches(const std::string& path) const;
/*! \brief %Signal which indicates that the user changes the internal path.
*
* This signal indicates a change to the internal path, which is
* usually triggered by the user using the browser back/forward
* buttons.
*
* The argument contains the new internal path.
*
* \sa setInternalPath()
*
* \if cpp
* \note the \p internal path is UTF8 encoded (we may fix the API
* to use WString in the future).
* \endif
*/
Signal<std::string>& internalPathChanged();
Signal<std::string>& internalPathInvalid() { return internalPathInvalid_; }
/*! \brief Redirects the application to another location.
*
* The client will be redirected to a new location identified by \p
* url. Use this in conjunction with quit() if you want to the
* application to be terminated as well.
*
* Calling %redirect() does not imply %quit() since it may be useful
* to switch between a non-secure and secure (SSL) transport
* connection.
*/
void redirect(const std::string& url);
//@}
/*! \brief Returns the URL at which the resources are deployed.
*
* Returns resolveRelativeUrl(relativeResourcesUrl())
*/
static std::string resourcesUrl();
/*! \brief Returns the URL at which the resources are deployed.
*
* \if cpp
* This returns the value of the 'resources' property set in the
* configuration file, and may thus be a URL relative to the deployment
* path.
* \endif
*
* \sa resolveRelativeUrl()
*/
static std::string relativeResourcesUrl();
#ifndef WT_TARGET_JAVA
/*! \brief Returns the appRoot special property
*
* This returns the "appRoot" property, with a trailing slash added
* to the end if it was not yet present.
*
* The property "appRoot" was introduced as a generalization of the
* working directory for the location of files that do not need to
* be served over http to the client, but are required by the
* program to run properly. Typically, these are message resource
* bundles (xml), CSV files, database files (e.g. SQLite files for
* Wt::Dbo), ...
*
* Some connectors do not allow you to control what the current
* working directory (CWD) is set to (fcgi, isapi). Instead of
* referring to files assuming a sensible CWD, it is therefore
* better to refer to them relative to the application root.
*
* The appRoot property is special in the sense that it can be set
* implicitly by the connector (see the connector documentation for
* more info). If it was not set by the connector, it can be set as
* a normal property in the configuration file (the default
* wt_config.xml describes how to set properties). If the property
* is not set at all, it is assumed that the appRoot is CWD and this
* function will return an empty string.
*
* \if cpp
* Usage example:
* \code
* messageResourceBundle().use(appRoot() + "text");
* messageResourceBundle().use(appRoot() + "charts");
*
* Wt::Dbo::backend::Sqlite3 sqlite3_(appRoot() + "planner.db");
* \endcode
* \endif
*
* \sa WServer::appRoot(), docRoot()
*/
static std::string appRoot();
/*! \brief Returns the server document root.
*
* This returns the filesystem path that corresponds to the document root
* of the webserver.
*
* \note This does not work reliably for complex webserver configurations
* (e.g. using FastCGI with Apache and rewrite rules). See also the
* <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=26052">
* discussion here</a>.
*
* \sa appRoot()
*/
std::string docRoot() const;
#else
static std::string appRoot();
#endif // WT_TARGET_JAVA
/*! \brief Returns the unique identifier for the current session.
*
* The session id is a string that uniquely identifies the current session.
* Note that the actual contents has no particular meaning and client
* applications should in no way try to interpret its value.
*/
std::string sessionId() const;
#ifndef WT_TARGET_JAVA
/*! \brief Changes the session id.
*
* To mitigate session ID fixation attacks, you should use this
* method to change the session ID to a new random value after a
* user has authenticated himself.
*
* \sa sessionId()
*/
void changeSessionId();
#endif // WT_TARGET_JAVA
WebSession *session() const { return session_; }
/** @name Manipulation outside the main event loop
*/
//@{
/*! \brief Enables server-initiated updates.
*
* By default, updates to the user interface are possible only at
* startup, during any event (in a slot), or at regular time points
* using WTimer. This is the normal %Wt event loop.
*
* In some cases, one may want to modify the user interface from a
* second thread, outside the event loop. While this may be worked
* around by the WTimer, in some cases, there are bandwidth and
* processing overheads associated which may be unnecessary, and
* which create a trade-off with time resolution of the updates.
*
* When \p enabled is \c true, this enables "server push" (what is
* called 'comet' in AJAX terminology). Widgets may then be
* modified, created or deleted outside of the event loop (e.g. in
* response to execution of another thread), and these changes are
* propagated by calling triggerUpdate().
*
* \if cpp
* There are two ways for safely manipulating a session's UI, with
* respect to thread-safety and application life-time (the library
* can decide to terminate an application if it lost connectivity
* with the browser).
*
* <h3>WServer::post()</h3>
*
* The easiest and less error-prone solution is to post an event,
* represented by a function/method call, to a session using
* WServer::post().
*
* The method is non-blocking: it returns immediately, avoiding
* dead-lock scenarios. The function is called from within a thread
* of the server's thread pool, and not if the session has been or
* is being terminated. The function is called in the context of the
* targeted application session, and with exclusive access to the
* session.
*
* <h3>WApplication::UpdateLock</h3>
*
* A more direct approach is to grab the application's update lock and
* manipulate the application's state directly from another thread.
*
* At any time, the application may be deleted (e.g. because of a
* time out or because the user closes the application window). You
* should thus make sure you do no longer reference an application
* after it has been deleted. When %Wt decides to delete an
* application, it first runs WApplication::finalize() and then
* invokes the destructor. While doing this, any other thread trying
* to grab the update lock will unblock, but the lock will return \c
* false. You should therefore always check whether the lock is
* valid.
*
* \elseif java
*
* Note that you need to grab the application's update lock to avoid
* concurrency problems, whenever you modify the application's state
* from another thread.
*
* \endif
*
* An example of how to modify the widget tree outside the event loop
* and propagate changes is:
* \if cpp
* \code
* // You need to have a reference to the application whose state
* // you are about to manipulate.
* // You should prevent the application from being deleted somehow,
* // before you could grab the application lock.
* Wt::WApplication *app = ...;
*
* {
* // Grab the application lock. It is a scoped lock.
* Wt::WApplication::UpdateLock lock(app);
*
* if (lock) {
* // We now have exclusive access to the application: we can safely modify the widget tree for example.
* app->root()->addWidget(new Wt::WText("Something happened!"));
*
* // Push the changes to the browser
* app->triggerUpdate();
* }
* }
* \endcode
* \elseif java
* \code
* // You need to have a reference to the application whose state
* // you are about to manipulate.
* WApplication app = ...;
*
* // Grab the application lock
* WApplication.UpdateLock lock = app.getUpdateLock();
*
* try {
* // We now have exclusive access to the application:
* // we can safely modify the widget tree for example.
* app.getRoot().addWidget(new WText("Something happened!"));
*
* // Push the changes to the browser
* app.triggerUpdate();
* } finally {
* lock.release();
* }
* \endcode
* \endif
*
* \if java
* This works only if your servlet container supports the Servlet 3.0
* API. If you try to invoke this function on a servlet container with
* no such support, an exception will be thrown.
* \endif
*
* \note This works only if JavaScript is available on the client.
*
* \sa triggerUpdate()
*/
void enableUpdates(bool enabled = true);
/*! \brief Returns whether server-initiated updates are enabled.
*
* \sa enableUpdates()
*/
bool updatesEnabled() const { return serverPush_ > 0; }
/*! \brief Propagates server-initiated updates.
*
* When the lock to the application is released, changes will
* propagate to the user interface. This call only has an effect
* after updates have been enabled from within the normal event loop
* using enableUpdates().
*
* This is typically used only outside of the main event loop,
* e.g. from another thread or from within a method posted to an
* application using WServer::post(), since changes always propagate
* within the event loop at the end of the event.
*
* The update is not immediate, and thus changes that happen after this
* call will equally be pushed to the client.
*
* \sa enableUpdates()
*/
void triggerUpdate();
#ifndef WT_TARGET_JAVA
/*! \brief A RAII lock for manipulating and updating the
* application and its widgets outside of the event loop.
*
* You can use this lock to manipulate widgets outside of the event
* loop. Inside the event loop (including events posted using
* WServer::post()), this lock is already held by the library itself.
*
* The lock is recursive, so trying to take a lock, while already
* holding a lock, will not block.
*/
#else
/*! \brief A synchronization lock for manipulating and updating the
* application and its widgets outside of the event loop.
*
* You need to take this lock only when you want to manipulate
* widgets outside of the event loop. Inside the event loop, this
* lock is already held by the library itself.
*
* \sa getUpdateLock()
*/
#endif // WT_TARGET_JAVA
class WT_API UpdateLock
{
public:
#ifndef WT_TARGET_JAVA
/*! \brief Creates and locks the given application.
*
* The lock guarantees exclusive access to modify the
* application's state.
*
* You should also consider WServer::post() for lock-free
* communication between different application sessions.
*
* As soon as the library decides to destroy the application, the
* lock will no longer succeed in taking the application lock. You
* can need to detect this by checking that after the lock is taken,
* the lock is taken:
* \code
* WApplication::UpdateLock lock(app);
* if (lock) {
* // exclusive access to app state
* }
* \endcode
*/
UpdateLock(WApplication *app);
/*! \brief Copy constructor (<b>deprecated</b>).
*
* By copying the lock, lock ownership is transferred. The original
* object becomes empty, and its destructor has no longer the
* effect of releasing the lock.
*
* \deprecated use UpdateLock(WApplication *) instead of getUpdateLock()
* which requires this copy.
*/
UpdateLock(const UpdateLock&);
/*! \brief Tests whether the update lock was succesfully taken.
*
* This may return \c false when the library has already decided
* to destroy the session (but before your application
* finalizer/destructor has run to notify helper threads that the
* application is destroyed).
*/
operator bool() const { return ok_; }
/*! \brief Releases the lock.
*/
~UpdateLock();
#else
/*! \brief Releases the lock.
*/
void release();
#endif
private:
#ifdef WT_TARGET_JAVA
UpdateLock(WApplication *app);
bool createdHandler_;
#endif // WT_TARGET_JAVA
#ifndef WT_TARGET_JAVA
mutable UpdateLockImpl *impl_;
bool ok_;
#endif // !WT_TARGET_JAVA
friend class WApplication;
};
#ifndef WT_TARGET_JAVA
/*! \brief Grabs and returns the lock for manipulating widgets outside
* the event loop (<b>deprecated</b>).
*
* You need to keep this lock in scope while manipulating widgets
* outside of the event loop. In normal cases, inside the %Wt event
* loop, you do not need to care about it.
*
* \sa enableUpdates(), triggerUpdate()
*
* \deprecated Use the RAII-style UpdateLock(WApplication *) constructor
* instead.
*/
#else
/*! \brief Grabs and returns the lock for manipulating widgets outside
* the event loop.
*
* You need to keep this lock in scope while manipulating widgets
* outside of the event loop. In normal cases, inside the %Wt event
* loop, you do not need to care about it.
*
* \sa enableUpdates(), triggerUpdate()
*/
#endif // WT_TARGET_JAVA
UpdateLock getUpdateLock();
/*! \brief Attach an auxiliary thread to this application.
*
* In a multi-threaded environment, WApplication::instance() uses
* thread-local data to retrieve the application object that
* corresponds to the session currently being handled by the
* thread. This is set automatically by the library whenever an
* event is delivered to the application, or when you use the
* UpdateLock to modify the application from an auxiliary thread
* outside the normal event loop.
*
* When you want to manipulate the widget tree inside the main event
* loop, but from within an auxiliary thread, then you cannot use
* the UpdateLock since this will create an immediate dead
* lock. Instead, you may attach the auxiliary thread to the
* application, by calling this method from the auxiliary thread,
* and in this way you can modify the application from within that
* thread without needing the update lock.
*
* Calling attachThread() with \p attach = \c false, detaches the
* current thread.
*/
void attachThread(bool attach = true);
//@}
/** @name Invoking JavaScript or including scripts
*/
//@{
/*! \brief Executes some JavaScript code.
*
* This method may be used to call some custom \p javaScript code as
* part of an event response.
*
* This function does not wait until the JavaScript is run, but
* returns immediately. The JavaScript will be run after the normal
* event handling, unless \p afterLoaded is set to \c false.
*
* In most situations, it's more robust to use
* WWidget::doJavaScript() however.
*
* \sa WWidget::doJavaScript(), declareJavaScriptFunction()
*/
void doJavaScript(const std::string& javascript, bool afterLoaded = true);
/*! \brief Adds JavaScript statements that should be run continuously.
*
* This is an internal method.
*
* It is used by for example layout managers to adjust the layout
* whenever the DOM tree is manipulated.
*
* \sa doJavaScript()
*/
void addAutoJavaScript(const std::string& javascript);
/*! \brief Declares an application-wide JavaScript function.
*
* The function is stored in WApplication::javaScriptClass().
*
* The next code snippet declares and invokes function foo:
* \if cpp
* \code
* app->declareJavaScriptFunction("foo",
* "function(id) { ... }");
* ...
* std::string id("myId");
* app->doJavaScript(app->javaScriptClass() + ".foo('" + id + "');");
* \endcode
* \endif
*/
void declareJavaScriptFunction(const std::string& name,
const std::string& function);
/*! \brief Loads a JavaScript library.
*
* Loads a JavaScript library located at the URL \p url. %Wt keeps
* track of libraries (with the same URL) that already have been
* loaded, and will load a library only once. In addition, you may
* provide a \p symbol which if already defined will also indicate
* that the library was already loaded (possibly outside of %Wt when
* in WidgetSet mode).
*
* This method returns \c true only when the library is loaded
* for the first time.
*
* JavaScript libraries may be loaded at any point in time. Any
* JavaScript code is deferred until the library is loaded, except
* for JavaScript that was defined to load before, passing \c false
* as second parameter to doJavaScript().
*
* Although %Wt includes an off-the-shelf JQuery version (which can
* also be used by your own JavaScript code), you can override the
* one used by %Wt and load another JQuery version instead, but this
* needs to be done using requireJQuery().
*/
bool require(const std::string& url,
const std::string& symbol = std::string());
/*! \brief Loads a custom JQuery library.
*
* %Wt ships with a rather old version of JQuery (1.4.1) which is
* sufficient for its needs and is many times smaller than more recent
* JQuery releases (about 50% smaller).
*
* Using this function, you can replace Wt's JQuery version with another
* version of JQuery.
*
* \code
* requireJQuery("jquery/jquery-1.7.2.min.js");
* \endcode
*/
bool requireJQuery(const std::string& url);
bool customJQuery() const { return customJQuery_; }
/*! \brief Sets the name of the application JavaScript class.
*
* This should be called right after construction of the application, and
* changing the JavaScript class is only supported for WidgetSet mode
* applications. The \p className should be a valid JavaScript identifier, and
* should also be unique in a single page.
*/
void setJavaScriptClass(const std::string& className);
/*! \brief Returns the name of the application JavaScript class.
*
* This JavaScript class encapsulates all JavaScript methods
* specific to this application instance. The method is foreseen to
* allow multiple applications to run simultaneously on the same
* page in Wt::WidgtSet mode, without interfering.
*/
std::string javaScriptClass() { return javaScriptClass_; }
//@}
/*! \brief Processes UI events.
*
* You may call this method during a long operation to:
* - propagate widget changes to the client.
* - process UI events.
*
* This method starts a recursive event loop, blocking the current
* thread, and resumes when all pending user interface events have been
* processed.
*
* Because a thread is blocked, this may affect your application
* scalability.
*/
void processEvents();
/*! \brief Blocks the thread, waiting for an UI event.
*
* This function is used by functions like WDialog::exec() or
* WPopupMenu::exec(), to block the current thread waiting for a new
* event.
*
* This requires that at least one additional thread is available to
* process incoming requests, and is not scalable when working with
* a fixed size thread pools.
*/
virtual void waitForEvent();
#ifndef WT_TARGET_JAVA
/*! \brief Reads a configuration property.
*
* Tries to read a configured value for the property
* \p name. The method returns whether a value is defined for
* the property, and sets it to \p value.
*
* \sa WServer::readConfigurationProperty()
*/
static bool readConfigurationProperty(const std::string& name,
std::string& value);
#else
/*! \brief Reads a configuration property.
*
* Tries to read a configured value for the property
* \p name. If no value was configured, the default \p value
* is returned.
*/
static std::string *readConfigurationProperty(const std::string& name,
const std::string& value);
#endif // WT_TARGET_JAVA
/*! \brief Sets the Ajax communication method (<b>deprecated</b>).
*
* This method has no effect.
*
* Since %Wt 3.1.8, a communication method that works is detected at
* run time. For widget set mode, cross-domain Ajax is chosen if
* available.
*
* \deprecated this setting is no longer needed.
*/
void setAjaxMethod(AjaxMethod method);
/*! \brief Returns the Ajax communication method (<b>deprecated</b>).
*
* \sa setAjaxMethod()
*/
AjaxMethod ajaxMethod() const { return ajaxMethod_; }
/*
* The DOM root object. This contains not only the application root but
* also other invisible objects (timers, dialog covers, ...).
*/
WContainerWidget *domRoot() const { return domRoot_; }
/*
* A phony DOM root object, used to logically contain all widgets bound
* in widgetset mode.
*/
WContainerWidget *domRoot2() const { return domRoot2_; }
/*
* Encode an object to a string, to make it referencable from JavaScript.
* Currently only used to encode the drag object in drag & drop.
*
* FIXME: provide a way to remove the encoding!
*
* \see decodeObject()
*/
std::string encodeObject(WObject *object);
/*
* Decode an object.
*
* \see encodeObject()
*/
WObject *decodeObject(const std::string& objectId) const;
#ifndef WT_TARGET_JAVA
/*! \brief Initializes the application, post-construction.
*
* This method is invoked by the %Wt library after construction of a
* new application. You may reimplement this method to do additional
* initialization that is not possible from the constructor
* (e.g. which uses virtual methods).
*/
virtual void initialize();
/*! \brief Finalizes the application, pre-destruction.
*
* This method is invoked by the %Wt library before destruction of a
* new application. You may reimplement this method to do additional
* finalization that is not possible from the destructor (e.g. which
* uses virtual methods).
*/
virtual void finalize();
#else
/*! \brief Destroys the application session.
*
* The application is destroyed when the session is invalidated. You
* should put here any logic which is needed to cleanup the
* application session.
*
* The default implementation does nothing.
*/
virtual void destroy();
#endif //WT_TARGET_JAVA
/*! \brief Changes the threshold for two-phase rendering.
*
* This changes the threshold for the \p size of a JavaScript
* response (in bytes) to render invisible changes in one go. If the
* bandwidth for rendering the invisible changes exceed the
* threshold, they will be fetched in a second communication, after
* the visible changes have been rendered.
*
* The value is a trade-off: setting it smaller will always use
* two-phase rendering, increasing the total render time but
* reducing the latency for the visible changes. Setting it too
* large will increase the latency to render the visible changes,
* since first also all invisible changes need to be computed and
* received in the browser.
*
* \if cpp
* The initial value is read from the configuration file, see \ref
* config_general.
* \endif
*/
void setTwoPhaseRenderingThreshold(int size);
/*! \brief Sets a new cookie.
*
* Use cookies to transfer information across different sessions
* (e.g. a user name). In a subsequent session you will be able to
* read this cookie using WEnvironment::getCookie(). You cannot use
* a cookie to store information in the current session.
*
* The name must be a valid cookie name (of type 'token': no special
* characters or separators, see RFC2616 page 16). The value may be
* anything. Specify the maximum age (in seconds) after which the
* client must discard the cookie. To delete a cookie, use a value of '0'.
*
* By default the cookie only applies to the application deployment
* path (WEnvironment::deploymentPath()) in the current domain. To
* set a proper value for domain, see also RFC2109.
*
* \if cpp
* \note %Wt provides session tracking automatically, and may be configured
* to use a cookie for this. You only need to use cookies yourself
* if you want to remember some information (like a logged in identity)
* <i>across sessions</i>.
* \endif
*
* \sa WEnvironment::supportsCookies(), WEnvironment::getCookie()
*/
void setCookie(const std::string& name, const std::string& value,
int maxAge, const std::string& domain = "",
const std::string& path = "", bool secure = false);
#ifndef WT_TARGET_JAVA
void setCookie(const std::string& name, const std::string& value,
const WDateTime& expires, const std::string& domain = "",
const std::string& path = "", bool secure = false);
#endif // WT_TARGET_JAVA
/*! \brief Removes a cookie.
*
* \sa setCookie()
*/
void removeCookie(const std::string& name, const std::string& domain = "",
const std::string& path = "");
/*! \brief Adds an HTML meta link.
*
* When a link was previously set for the same \p href, its contents
* are replaced.
* When an empty string is used for the arguments \p media, \p hreflang,
* \p type or \p sizes, they will be ignored.
*
* \sa removeMetaLink()
*/
void addMetaLink(const std::string &href,
const std::string &rel,
const std::string &media,
const std::string &hreflang,
const std::string &type,
const std::string &sizes,
bool disabled);
/*! \brief Removes the HTML meta link.
*
* \sa addMetaLink()
*/
void removeMetaLink(const std::string &href);
/*! \brief Adds an HTML meta header.
*
* \sa addMetaHeader(MetaHeaderType, const std::string&, const WString&, const std::string&)
*/
void addMetaHeader(const std::string& name, const WString& content,
const std::string& lang = "");
/*! \brief Adds an HTML meta header.
*
* This method sets either a "name" meta headers, which configures a
* document property, or a "http-equiv" meta headers, which defines
* a HTTP headers (but these latter headers are being deprecated).
*
* A meta header can however only be added in the following situations:
*
* - when a plain HTML session is used (including when the user agent is a
* bot), you can add meta headers at any time.
* - or, when \ref progressive_bootstrap "progressive bootstrap" is
* used, you can set meta headers for any type of session, from
* within the application constructor (which corresponds to the
* initial request).
* - but never for a Wt::WidgetSet mode application since then the
* application is hosted within a foreign HTML page.
*
* These situations coincide with WEnvironment::ajax() returning \c
* false (see environment()). The reason that it other cases the
* HTML page has already been rendered, and will not be rerendered
* since all updates are done dynamically.
*
* As an alternative, you can use the <meta-headers>
* configuration property in the configuration file, which will be
* applied in all circumstances.
*
* \sa removeMetaHeader()
*/
void addMetaHeader(MetaHeaderType type, const std::string& name,
const WString& content, const std::string& lang = "");
/*! \brief Removes one or all meta headers.
*
* Removes the meta header with given type and name (if it is present).
* If name is empty, all meta headers of the given type are removed.
*
* \sa addMetaHeader()
*/
void removeMetaHeader(MetaHeaderType type, const std::string& name = "");
#ifndef WT_TARGET_JAVA
/*! \brief Adds an entry to the application log.
*
* Starts a new log entry of the given \p type in the %Wt
* application log file. This method returns a stream-like object to
* which the message may be streamed.
*
* \if cpp
* A typical usage would be:
* \code
* wApp->log("notice") << "User " << userName << " logged in successfully.";
* \endcode
*
* This would create a log entry that looks like:
* \verbatim
[2008-Jul-13 14:01:17.817348] 16879 [/app.wt Z2gCmSxIGjLHD73L] [notice] "User bart logged in successfully."
* \endverbatim
* \endif
*
* \if cpp
* \sa \ref config_general
* \endif
*/
WLogEntry log(const std::string& type) const;
#endif // WT_TARGET_JAVA
/*! \brief Sets the loading indicator.
*
* The loading indicator is shown to indicate that a response from
* the server is pending or JavaScript is being evaluated.
*
* The default loading indicator is a WDefaultLoadingIndicator.
*
* When setting a new loading indicator, the previous one is
* deleted.
*/
void setLoadingIndicator(WLoadingIndicator *indicator);
/*! \brief Returns the loading indicator.
*
* \sa setLoadingIndicator()
*/
WLoadingIndicator *loadingIndicator() const { return loadingIndicator_; }
/*
* A url to a resource that provides a one pixel gif. This is sometimes
* useful for CSS hackery to make IE behave.
*/
std::string onePixelGifUrl();
/*
* The doctype used to deliver the application.
*/
std::string docType() const;
/*! \brief Quits the application.
*
* This quits the application with a default restart message resolved
* as WString::tr("Wt.QuittedMessage").
*
* \sa quit(const WString&)
*/
void quit();
/*! \brief Quits the application.
*
* The method returns immediately, but has as effect that the
* application will be terminated after the current event is
* completed.
*
* The current widget tree (including any modifications still
* pending and applied during the current event handling) will still
* be rendered, after which the application is terminated.
*
* If the restart message is not empty, then the user will be
* offered to restart the application (using the provided message)
* when further interacting with the application.
*
* \sa redirect()
*/
void quit(const WString& restartMessage);
/*! \brief Returns whether the application has quit. (<b>deprecated</b>)
*
* \sa quit()
*
* \deprecated hasQuit() is proper English
*/
bool isQuited() const { return quitted_; }
/*! \brief Returns whether the application has quit.
*
* \sa quit()
*/
bool hasQuit() const { return quitted_; }
/*! \brief Returns the current maximum size of a request to the
* application.
*
* The returned value is the maximum request size in bytes.
*
* \if cpp
* The maximum request size is configured in the configuration file,
* see \ref config_general.
* \endif
*
* \sa requestTooLarge()
*/
::int64_t maximumRequestSize() const;
/*! \brief %Signal which indicates that too a large request was received.
*
* The integer parameter is the request size that was received in bytes.
*/
Signal< ::int64_t >& requestTooLarge() { return requestTooLarge_; }
/*
* For persistent sessions only: redirect to another session.
*/
void redirectToSession(const std::string& sessionId);
/*
* For persistent sessions only: return whether the persistent session
* is connected to a browser.
*/
bool isConnected() const { return connected_; }
/** @name Global keyboard and mouse events
*/
//@{
/*! \brief Event signal emitted when a keyboard key is pushed down.
*
* The application receives key events when no widget currently
* has focus. Otherwise, key events are handled by the widget in focus,
* and its ancestors.
*
* \sa See WInteractWidget::keyWentDown()
*/
EventSignal<WKeyEvent>& globalKeyWentDown();
/*! \brief Event signal emitted when a "character" was entered.
*
* The application receives key events when no widget currently
* has focus. Otherwise, key events are handled by the widget in focus,
* and its ancestors.
*
* \sa See WInteractWidget::keyPressed()
*/
EventSignal<WKeyEvent>& globalKeyPressed();
/*! \brief Event signal emitted when a keyboard key is released.
*
* The application receives key events when no widget currently
* has focus. Otherwise, key events are handled by the widget in focus,
* and its ancestors.
*
* \sa See WInteractWidget::keyWentUp()
*/
EventSignal<WKeyEvent>& globalKeyWentUp();
/*! \brief Event signal emitted when enter was pressed.
*
* The application receives key events when no widget currently
* has focus. Otherwise, key events are handled by the widget in focus,
* and its ancestors.
*
* \sa See WInteractWidget::enterPressed()
*/
EventSignal<>& globalEnterPressed();
/*! \brief Event signal emitted when escape was pressed.
*
* The application receives key events when no widget currently
* has focus. Otherwise, key events are handled by the widget in focus,
* and its ancestors.
*
* \sa See WInteractWidget::escapePressed()
*/
EventSignal<>& globalEscapePressed();
//@}
/*
* Returns whether debug was configured.
* (should be public API ?)
*/
bool debug() const;
/*
* Methods for client-side focus
*/
void setFocus(const std::string& id, int selectionStart, int selectionEnd);
#ifdef WT_DEBUG_JS
void loadJavaScript(const char *jsFile);
#else
#ifdef WT_TARGET_JAVA
/*! \brief Loads an internal JavaScript file.
*
* This is an internal function and should not be called directly.
*
* \sa require(), doJavaScript()
*/
#endif
void loadJavaScript(const char *jsFile, const WJavaScriptPreamble& preamble);
#endif
bool javaScriptLoaded(const char *jsFile) const;
/*! \brief Sets the message for the user to confirm closing of the
* application window/tab.
*
* If the message is empty, then the user may navigate away from the page
* without confirmation.
*
* Otherwise the user will be prompted with a browser-specific
* dialog asking him to confirm leaving the page. This \p message is
* added to the page.
*
* \sa unload()
*/
void setConfirmCloseMessage(const WString& message);
/*! \brief Sets the message for the user when the application was .
*/
void enableInternalPaths();
// should we move this into an InternalPaths utility class / namespace ?
#ifdef WT_TARGET_JAVA
/*! \brief Utility function to check if one path falls under another path.
*
* This returns whether the \p query path matches the given \p path,
* meaning that it is equal to that path or it specifies a more
* specific sub path of that path.
*/
#endif // WT_TARGET_JAVA
static bool pathMatches(const std::string& path, const std::string& query);
#ifndef WT_TARGET_JAVA
/*! \brief Defers rendering of the current event response.
*
* This method defers the rendering of the current event response
* until resumeRendering() is called. This may be used if you do not
* want to actively block the current thread while waiting for an
* event which is needed to complete the current event
* response. Note that this effectively freezes the user interface,
* and thus you should only do this if you know that the event you
* are waiting for will arrive shortly, or there is really nothing more
* useful for the user to do than wait for the action to complete.
*
* A typical use case is in conjunction with the Http::Client, to
* defer the rendering while waiting for the Http::Client to
* complete.
*
* The function may be called multiple times and the number of deferral
* requests is counted. The current response is deferred until as
* many calls to resumeRendering() have been performed.
*
* \sa resumeRendering()
*/
void deferRendering();
/*! \brief Resumes rendering of a deferred event response.
*
* \sa deferRendering()
*/
void resumeRendering();
#endif
#ifndef WT_CNOR
/*! \brief Protects a function against deletion of the target object.
*
* When posting an event using WServer::post(), it is convenient to
* bind an object method to be called. However, while
* WServer::post() guarantees that the application to which an event
* is posted is still alive, it may be that the targeted widget (or
* WObject in general) has been deleted.
*
* This function wraps such an object method with a protection layer
* which guarantees that the method is only called when the targeted
* object is alive, in the same way as how a signal automatically
* disconnects slots from objects that are being deleted.
*
* You typically will bind the function immediately within the event
* loop where you register the "callback", and pass this bound
* function to (typically an external thread) which calls post()
* later on. What you cannot do is bind the function only later on,
* since at that time the target object may already have been
* destroyed.
*
* As with the signal/slot connection tracking mechanism, this
* requires that the object is a WObject.
*/
template <typename F> boost::function<void()> bind(const F& f);
#endif // WT_CNOR
/*! \brief Encodes an untrusted URL to prevent referer leaks.
*
* This encodes an URL so that in case the session ID is present
* in the current URL, this session ID does not leak to the refenced
* URL.
*
* Wt will safely handle URLs in the API (in WImage and WAnchor) but
* you may want to use this function to encode URLs which you use in
* WTemplate texts.
*/
std::string encodeUntrustedUrl(const std::string& url) const;
/*! \brief Pushes a (modal) widget onto the expose stack.
*
* This defines a new context of widgets that are currently visible.
*/
void pushExposedConstraint(WWidget *w);
void popExposedConstraint(WWidget *w);
void addGlobalWidget(WWidget *w);
void removeGlobalWidget(WWidget *w);
protected:
/*! \brief Notifies an event to the application.
*
* This method is called by the event loop for propagating an event
* to the application. It provides a single point of entry for
* events to the application, besides the application constructor.
*
* You may want to reimplement this method for two reasons:
*
* - for having a single point for exception handling: while you may want
* to catch recoverable exceptions in a more appropriate place, general
* (usually fatal) exceptions may be caught here. You will in probably
* also want to catch the same exceptions in the application constructor
* in the same way.
* - you want to manage resource usage during requests. For example, at
* the end of request handling, you want to return a database session
* back to the pool. Since %notify() is also used for rendering right after
* the application is created, this will also clean up resources after
* application construction.
*
* In either case, you will need to call the base class
* implementation of %notify(), as otherwise no events will be
* delivered to your application.
*
* The following shows a generic template for reimplementhing this
* method for both managing request resources and generic exception
* handling.
*
* \if cpp
* \code
* MyApplication::notify(const WEvent& event)
* {
* // Grab resources for during request handling
* try {
* WApplication::notify(event);
* } catch (MyException& exception) {
* // handle this exception in a central place
* }
* // Free resources used during request handling
* }
* \endcode
* \elseif java
* \code
* void notify(WEvent event) {
* // Grab resources for during request handling
* try {
* super.notify(event);
* } catch (MyException exception) {
* // handle this exception in a central place
* }
* // Free resources used during request handling
* }
* \endcode
* \endif
*
* Note that any uncaught exception throw during event handling
* terminates the session.
*/
virtual void notify(const WEvent& e);
/*! \brief Returns whether a widget is exposed in the interface.
*
* The default implementation simply returns \c true, unless a modal
* dialog is active, in which case it returns \c true only for widgets
* that are inside the dialog.
*
* You may want to reimplement this method if you wish to disallow
* events from certain widgets even when they are inserted in the
* widget hierachy.
*/
virtual bool isExposed(WWidget *w) const;
/*! \brief Progresses to an Ajax-enabled user interface.
*
* This method is called when the progressive bootstrap method is used, and
* support for AJAX has been detected. The default behavior will propagate
* the WWidget::enableAjax() method through the widget hierarchy.
*
* You may want to reimplement this method if you want to make
* changes to the user-interface when AJAX is enabled. You should
* always call the base implementation.
*
* \sa WWidget::enableAjax()
*/
virtual void enableAjax();
/*! \brief Handles a browser unload event.
*
* The browser unloads the application when the user navigates away or
* when he closes the window or tab.
*
* When <tt>reload-is-new-session</tt> is set to \c true, then the
* default implementation of this method terminates this session by
* calling quit(), otherwise the session is scheduled to expire within
* seconds (since it may be a refresh).
*
* You may want to reimplement this if you want to keep the
* application running until it times out (as was the behaviour
* before %Wt 3.1.6).
*/
virtual void unload();
private:
Signal< ::int64_t > requestTooLarge_;
struct ScriptLibrary {
ScriptLibrary(const std::string& uri, const std::string& symbol);
std::string uri, symbol, beforeLoadJS;
bool operator< (const ScriptLibrary& other) const;
bool operator== (const ScriptLibrary& other) const;
};
struct MetaLink {
MetaLink(const std::string &href,
const std::string &rel,
const std::string &media,
const std::string &hreflang,
const std::string &type,
const std::string &sizes,
bool disabled);
std::string href;
std::string rel;
std::string media;
std::string hreflang;
std::string type;
std::string sizes;
bool disabled;
};
#ifndef WT_TARGET_JAVA
typedef std::map<std::string, EventSignalBase *> SignalMap;
#else
typedef std::map<std::string, WeakReference<EventSignalBase *> > SignalMap;
#endif
typedef std::map<std::string, WResource *> ResourceMap;
typedef std::map<std::string, WObject *> ObjectMap;
/*
* Basic application stuff
*/
WebSession *session_; // session owning this application
#ifndef WT_CNOR
boost::weak_ptr<WebSession> weakSession_; // used to sense destruction
#endif // WT_CNOR
WString title_;
WString closeMessage_;
bool titleChanged_, closeMessageChanged_;
WContainerWidget *widgetRoot_; // widgets in main DOM root
WContainerWidget *domRoot_; // main DOM root
WContainerWidget *domRoot2_; // other virtual root for WidgetSet mode
WContainerWidget *timerRoot_; // timers in main DOM root
WCssStyleSheet styleSheet_; // internal stylesheet
WCombinedLocalizedStrings *localizedStrings_;
WLocale locale_;
std::string oldInternalPath_, newInternalPath_;
Signal<std::string> internalPathChanged_, internalPathInvalid_;
bool internalPathIsChanged_;
bool internalPathDefaultValid_, internalPathValid_;
int serverPush_;
bool serverPushChanged_;
#ifndef WT_TARGET_JAVA
boost::pool<boost::default_user_allocator_new_delete> *eventSignalPool_;
#endif // WT_TARGET_JAVA
std::string javaScriptClass_;
AjaxMethod ajaxMethod_;
bool quitted_;
WString quittedMessage_;
std::string onePixelGifUrl_;
bool internalPathsEnabled_;
WWidget *exposedOnly_;
WLoadingIndicator *loadingIndicator_;
WWidget *loadingIndicatorWidget_;
bool connected_;
std::string htmlClass_, bodyClass_;
bool bodyHtmlClassChanged_;
bool enableAjax_;
#ifndef WT_TARGET_JAVA
bool initialized_;
#endif // WT_TARGET_JAVA
std::string focusId_;
int selectionStart_, selectionEnd_;
LayoutDirection layoutDirection_;
std::vector<ScriptLibrary> scriptLibraries_;
int scriptLibrariesAdded_;
const WTheme *theme_;
std::vector<WCssStyleSheet> styleSheets_;
int styleSheetsAdded_;
std::vector<MetaHeader> metaHeaders_;
std::vector<MetaLink> metaLinks_;
SignalMap exposedSignals_; // signals that may be accessed
ResourceMap exposedResources_; // resources that may be accessed
ObjectMap encodedObjects_; // objects encoded for internal purposes
// like 'virtual pointers' (see D&D)
bool exposeSignals_; // if we are currently exposing signals
// (see WViewWidget)
std::string afterLoadJavaScript_, beforeLoadJavaScript_;
int newBeforeLoadJavaScript_;
std::string autoJavaScript_;
bool autoJavaScriptChanged_;
#ifndef WT_DEBUG_JS
std::vector<WJavaScriptPreamble> javaScriptPreamble_;
int newJavaScriptPreamble_;
#else
std::vector<const char *> newJavaScriptToLoad_;
#endif // WT_DEBUG_JS
std::set<const char *> javaScriptLoaded_;
bool customJQuery_;
EventSignal<> showLoadingIndicator_, hideLoadingIndicator_;
JSignal<> unloaded_;
std::map<const char *, boost::any> objectStore_;
WContainerWidget *timerRoot() const { return timerRoot_; }
WEnvironment& env(); // short-hand for session_->env()
/*
* Functions for exposed signals, resources, and objects
*/
void addExposedSignal(EventSignalBase* signal);
void removeExposedSignal(EventSignalBase* signal);
EventSignalBase *decodeExposedSignal(const std::string& signalName) const;
EventSignalBase *decodeExposedSignal(const std::string& objectId,
const std::string& name);
SignalMap& exposedSignals() { return exposedSignals_; }
std::string resourceMapKey(WResource *resource);
std::string addExposedResource(WResource *resource);
void removeExposedResource(WResource *resource);
WResource *decodeExposedResource(const std::string& resourceMapKey) const;
/*
* Methods for application state handling
*/
bool changeInternalPath(const std::string& path);
bool changedInternalPath(const std::string& path);
/*
* Methods for accessing javaScript, which may have erase-on-read
* semantics
*/
void streamAfterLoadJavaScript(WStringStream& out);
void streamBeforeLoadJavaScript(WStringStream& out, bool all);
void streamJavaScriptPreamble(WStringStream& out, bool all);
#ifdef WT_DEBUG_JS
void loadJavaScriptFile(WStringStream& out, const char *jsFile);
#endif // WT_DEBUG_JS
/*
* Methods that control exposing of signals
*/
void setExposeSignals(bool how) { exposeSignals_ = how; }
bool exposeSignals() const { return exposeSignals_; }
void doUnload();
#ifndef WT_TARGET_JAVA
int startWaitingAtLock();
void endWaitingAtLock(int id);
#endif // WT_TARGET_JAVA
std::string focus() const { return focusId_; }
int selectionStart() const { return selectionStart_; }
int selectionEnd() const { return selectionEnd_; }
/*
* Methods for audio handling
*/
SoundManager *getSoundManager();
SoundManager *soundManager_;
static const char *RESOURCES_URL;
#ifdef WT_TARGET_JAVA
JSlot showLoadJS;
JSlot hideLoadJS;
#endif
friend class WebRenderer;
friend class WebSession;
friend class WebController;
friend class EventSignalBase;
friend class JavaScriptEvent;
friend class UpdateLockImpl;
friend class WContainerWidget;
friend class WDialog;
friend class WFileUpload;
friend class WFormWidget;
friend class WInteractWidget;
friend class WLineEdit;
friend class WMenu;
friend class WResource;
friend class WSound;
friend class WString;
friend class WTextArea;
friend class WTimer;
friend class WViewWidget;
friend class WWidget;
friend class Ext::Dialog;
friend class Ext::MessageBox;
};
#ifndef WT_TARGET_JAVA
#ifdef DOXYGEN_ONLY
/*! \brief Runs the %Wt application server.
*
* This function runs the application server, and should be called
* only once (e.g. from within your main function).
*
* The \p createApplication parameter is a <tt>boost::function</tt>
* object that should create a new application instance for a new user
* visiting the application. It is of type:
* <tt>boost::function<Wt::WApplication* (const
* Wt::WEnvironment&)></tt>, and thus you can pass to it a function
* like:
*
* <pre>
* Wt::WApplication *createApplication(const Wt::WEnvironment& env)
* {
* // ...
* }
* </pre>
*
* When using the built-in httpd, the implementation listens for POSIX
* termination signals (or console CTRL-C) event. You can use the
* WServer class for more flexible control on starting and stopping
* the server.
*
* \relates WServer
* \sa WApplication
*/
extern int WRun(int argc, char** argv,
ApplicationCreator createApplication = 0);
#else // DOXYGEN_ONLY
extern int WTCONNECTOR_API WRun(int argc, char** argv,
ApplicationCreator createApplication = 0);
#endif // DOXYGEN_ONLY
#endif // WT_TARGET_JAVA
/*! \def wApp
* \brief Global constant for accessing the application instance.
*
* This is equivalent to WApplication::instance()
*
* \relates WApplication
*/
#define wApp Wt::WApplication::instance()
#ifndef WT_CNOR
extern void WT_API WtEmitBindSignal(const boost::shared_ptr< Wt::Signals::signal<void()> >& s);
#else
extern void WT_API WtEmitBindSignal(const boost::shared_ptr< Wt::Signals::signal0<void> >& s);
#endif
#ifndef WT_CNOR
template <typename F>
boost::function<void()> Wt::WApplication::bind(const F& f)
{
typedef boost::shared_ptr< Wt::Signals::signal<void()> > SignalPtr;
SignalPtr s(new Wt::Signals::signal<void()>());
s->connect(f);
return boost::bind(&WtEmitBindSignal, s);
}
#endif // WT_CNOR
}
#endif // WAPPLICATION_
|