/usr/include/wx-3.0/wx/wxPython/i_files/html.i is in python-wxgtk3.0-dev 3.0.1.1+dfsg-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 | /////////////////////////////////////////////////////////////////////////////
// Name: html.i
// Purpose: SWIG definitions of html classes
//
// Author: Robin Dunn
//
// Created: 25-Nov-1998
// RCS-ID: $Id$
// Copyright: (c) 2003 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
%define DOCSTRING
"Classes for a simple HTML rendering window, HTML Help Window, etc."
%enddef
%module(package="wx", docstring=DOCSTRING) html
%{
#include "wx/wxPython/wxPython.h"
#include "wx/wxPython/pyclasses.h"
#include "wx/wxPython/pyistream.h"
#include "wx/wxPython/printfw.h"
#include <wx/html/htmlwin.h>
#include <wx/html/htmprint.h>
#include <wx/html/helpctrl.h>
#include <wx/html/helpwnd.h>
#include <wx/html/helpfrm.h>
#include <wx/html/helpdlg.h>
%}
//---------------------------------------------------------------------------
%import windows.i
%pythoncode { wx = _core }
%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
MAKE_CONST_WXSTRING2(HtmlWindowNameStr, wxT("htmlWindow"))
MAKE_CONST_WXSTRING2(HtmlPrintoutTitleStr, wxT("Printout"))
MAKE_CONST_WXSTRING2(HtmlPrintingTitleStr, wxT("Printing"))
// TODO: Split this file into multiple %included files that coresponds to the
// wx/html include files (more or less.)
//---------------------------------------------------------------------------
%newgroup
enum {
wxHTML_ALIGN_LEFT,
wxHTML_ALIGN_CENTER,
wxHTML_ALIGN_RIGHT,
wxHTML_ALIGN_BOTTOM,
wxHTML_ALIGN_TOP,
wxHTML_CLR_FOREGROUND,
wxHTML_CLR_BACKGROUND,
wxHTML_UNITS_PIXELS,
wxHTML_UNITS_PERCENT,
wxHTML_INDENT_LEFT,
wxHTML_INDENT_RIGHT,
wxHTML_INDENT_TOP,
wxHTML_INDENT_BOTTOM,
wxHTML_INDENT_HORIZONTAL,
wxHTML_INDENT_VERTICAL,
wxHTML_INDENT_ALL,
wxHTML_COND_ISANCHOR,
wxHTML_COND_ISIMAGEMAP,
wxHTML_COND_USER,
};
enum {
wxHW_SCROLLBAR_NEVER,
wxHW_SCROLLBAR_AUTO,
wxHW_NO_SELECTION,
wxHW_DEFAULT_STYLE,
};
// enums for wxHtmlWindow::OnOpeningURL
enum wxHtmlOpeningStatus
{
wxHTML_OPEN,
wxHTML_BLOCK,
wxHTML_REDIRECT
};
enum wxHtmlURLType
{
wxHTML_URL_PAGE,
wxHTML_URL_IMAGE,
wxHTML_URL_OTHER
};
//---------------------------------------------------------------------------
class wxHtmlLinkInfo : public wxObject {
public:
wxHtmlLinkInfo(const wxString& href, const wxString& target = wxPyEmptyString);
~wxHtmlLinkInfo();
wxString GetHref();
wxString GetTarget();
wxMouseEvent* GetEvent();
wxHtmlCell* GetHtmlCell();
void SetEvent(const wxMouseEvent *e);
void SetHtmlCell(const wxHtmlCell * e);
%property(Event, GetEvent, SetEvent, doc="See `GetEvent` and `SetEvent`");
%property(Href, GetHref, doc="See `GetHref`");
%property(HtmlCell, GetHtmlCell, SetHtmlCell, doc="See `GetHtmlCell` and `SetHtmlCell`");
%property(Target, GetTarget, doc="See `GetTarget`");
};
//---------------------------------------------------------------------------
class wxHtmlTag : public wxObject {
public:
// Never need to create a new tag from Python...
//wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache);
wxString GetName();
bool HasParam(const wxString& par);
wxString GetParam(const wxString& par, int with_commas = false);
// Can't do this one as-is, but GetParam should be enough...
//int ScanParam(const wxString& par, const char *format, void* param);
wxString GetAllParams();
bool HasEnding();
int GetBeginPos();
int GetEndPos1();
int GetEndPos2();
%property(AllParams, GetAllParams, doc="See `GetAllParams`");
%property(BeginPos, GetBeginPos, doc="See `GetBeginPos`");
%property(EndPos1, GetEndPos1, doc="See `GetEndPos1`");
%property(EndPos2, GetEndPos2, doc="See `GetEndPos2`");
%property(Name, GetName, doc="See `GetName`");
};
//---------------------------------------------------------------------------
class wxHtmlParser : public wxObject {
public:
// wxHtmlParser(); This is an abstract base class...
void SetFS(wxFileSystem *fs);
wxFileSystem* GetFS();
wxObject* Parse(const wxString& source);
void InitParser(const wxString& source);
void DoneParser();
void DoParsing(/*int begin_pos, int end_pos*/);
void StopParsing();
// wxObject* GetProduct();
%disownarg(wxHtmlTagHandler *handler );
void AddTagHandler(wxHtmlTagHandler *handler);
void PushTagHandler(wxHtmlTagHandler* handler, wxString tags);
void PopTagHandler();
%cleardisown(wxHtmlTagHandler *handler );
wxString* GetSource();
// virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const;
// void AddText(const char* txt) = 0;
// void AddTag(const wxHtmlTag& tag);
// Returns HTML source inside the element (i.e. between the starting
// and ending tag)
wxString GetInnerSource(const wxHtmlTag& tag);
%property(FS, GetFS, SetFS, doc="See `GetFS` and `SetFS`");
%property(Source, GetSource, doc="See `GetSource`");
};
//---------------------------------------------------------------------------
class wxHtmlWinParser : public wxHtmlParser {
public:
wxHtmlWinParser(wxPyHtmlWindow *wnd = NULL);
void SetDC(wxDC *dc);
wxDC* GetDC();
int GetCharHeight();
int GetCharWidth();
wxHtmlWindowInterface *GetWindowInterface();
// Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
%extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
self->SetFonts(normal_face, fixed_face, temp);
if (temp)
delete [] temp;
}
}
// Sets font sizes to be relative to the given size or the system
// default size; use either specified or default font
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxPyEmptyString,
const wxString& fixed_face = wxPyEmptyString);
wxHtmlContainerCell* GetContainer();
wxHtmlContainerCell* OpenContainer();
wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);
wxHtmlContainerCell* CloseContainer();
int GetFontSize();
void SetFontSize(int s);
// Try to map a font size in points to the HTML 1-7 font size range.
void SetFontPointSize(int pt);
int GetFontBold();
void SetFontBold(int x);
int GetFontItalic();
void SetFontItalic(int x);
int GetFontUnderlined();
void SetFontUnderlined(int x);
int GetFontFixed();
void SetFontFixed(int x);
int GetAlign();
void SetAlign(int a);
wxColour GetLinkColor();
void SetLinkColor(const wxColour& clr);
%pythoncode {
GetLinkColour = GetLinkColor
SetLinkColour = SetLinkColor
}
wxColour GetActualColor();
void SetActualColor(const wxColour& clr);
%pythoncode {
GetActualColour = GetActualColor
SetActualColour = SetActualColor
}
void SetLink(const wxString& link);
wxFont* CreateCurrentFont();
wxHtmlLinkInfo GetLink();
%property(ActualColor, GetActualColor, SetActualColor, doc="See `GetActualColor` and `SetActualColor`");
%property(ActualColour, GetActualColour, SetActualColour, doc="See `GetActualColour` and `SetActualColour`");
%property(Align, GetAlign, SetAlign, doc="See `GetAlign` and `SetAlign`");
%property(CharHeight, GetCharHeight, doc="See `GetCharHeight`");
%property(CharWidth, GetCharWidth, doc="See `GetCharWidth`");
%property(Container, GetContainer, SetContainer, doc="See `GetContainer` and `SetContainer`");
%property(DC, GetDC, SetDC, doc="See `GetDC` and `SetDC`");
%property(FontBold, GetFontBold, SetFontBold, doc="See `GetFontBold` and `SetFontBold`");
%property(FontFixed, GetFontFixed, SetFontFixed, doc="See `GetFontFixed` and `SetFontFixed`");
%property(FontItalic, GetFontItalic, SetFontItalic, doc="See `GetFontItalic` and `SetFontItalic`");
%property(FontSize, GetFontSize, SetFontSize, doc="See `GetFontSize` and `SetFontSize`");
%property(FontUnderlined, GetFontUnderlined, SetFontUnderlined, doc="See `GetFontUnderlined` and `SetFontUnderlined`");
%property(Link, GetLink, SetLink, doc="See `GetLink` and `SetLink`");
%property(LinkColor, GetLinkColor, SetLinkColor, doc="See `GetLinkColor` and `SetLinkColor`");
%property(LinkColour, GetLinkColour, SetLinkColour, doc="See `GetLinkColour` and `SetLinkColour`");
%property(WindowInterface, GetWindowInterface, doc="See `GetWindowInterface`");
};
//---------------------------------------------------------------------------
%{
class wxPyHtmlTagHandler : public wxHtmlTagHandler {
DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler)
public:
wxPyHtmlTagHandler() : wxHtmlTagHandler() {};
wxHtmlParser* GetParser() { return m_Parser; }
void ParseInner(const wxHtmlTag& tag) { wxHtmlTagHandler::ParseInner(tag); }
DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
PYPRIVATE;
};
IMPLEMENT_DYNAMIC_CLASS(wxPyHtmlTagHandler, wxHtmlTagHandler);
IMP_PYCALLBACK_STRING__pure(wxPyHtmlTagHandler, wxHtmlTagHandler, GetSupportedTags);
IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
%}
%rename(HtmlTagHandler) wxPyHtmlTagHandler;
class wxPyHtmlTagHandler : public wxObject {
public:
%pythonAppend wxPyHtmlTagHandler setCallbackInfo(HtmlTagHandler)
wxPyHtmlTagHandler();
void _setCallbackInfo(PyObject* self, PyObject* _class);
void SetParser(wxHtmlParser *parser);
wxHtmlParser* GetParser();
void ParseInner(const wxHtmlTag& tag);
%property(Parser, GetParser, SetParser, doc="See `GetParser` and `SetParser`");
};
//---------------------------------------------------------------------------
%{
class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler {
DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler)
public:
wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {};
wxHtmlWinParser* GetParser() { return m_WParser; }
void ParseInner(const wxHtmlTag& tag)
{ wxHtmlWinTagHandler::ParseInner(tag); }
DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
PYPRIVATE;
};
IMPLEMENT_DYNAMIC_CLASS( wxPyHtmlWinTagHandler, wxHtmlWinTagHandler);
IMP_PYCALLBACK_STRING__pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, GetSupportedTags);
IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleTag);
%}
%rename(HtmlWinTagHandler) wxPyHtmlWinTagHandler;
class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
public:
%pythonAppend wxPyHtmlWinTagHandler setCallbackInfo(HtmlWinTagHandler)
wxPyHtmlWinTagHandler();
void _setCallbackInfo(PyObject* self, PyObject* _class);
void SetParser(wxHtmlParser *parser);
wxHtmlWinParser* GetParser();
void ParseInner(const wxHtmlTag& tag);
%property(Parser, GetParser, SetParser, doc="See `GetParser` and `SetParser`");
};
//---------------------------------------------------------------------------
%{
class wxPyHtmlTagsModule : public wxHtmlTagsModule {
public:
wxPyHtmlTagsModule(PyObject* thc) : wxHtmlTagsModule() {
m_tagHandlerClass = thc;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
Py_INCREF(m_tagHandlerClass);
wxPyEndBlockThreads(blocked);
RegisterModule(this);
wxHtmlWinParser::AddModule(this);
}
void OnExit() {
wxPyBlock_t blocked = wxPyBeginBlockThreads();
Py_DECREF(m_tagHandlerClass);
m_tagHandlerClass = NULL;
for (size_t x=0; x < m_objArray.GetCount(); x++) {
PyObject* obj = (PyObject*)m_objArray.Item(x);
Py_DECREF(obj);
}
wxPyEndBlockThreads(blocked);
};
void FillHandlersTable(wxHtmlWinParser *parser) {
// Wave our magic wand... (if it works it's a miracle! ;-)
wxPyHtmlWinTagHandler* thPtr = 0;
// First, make a new instance of the tag handler
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* arg = PyTuple_New(0);
PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg);
Py_DECREF(arg);
// now figure out where it's C++ object is...
if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler"))) {
wxPyEndBlockThreads(blocked);
return;
}
wxPyEndBlockThreads(blocked);
// add it,
parser->AddTagHandler(thPtr);
// and track it.
m_objArray.Add(obj);
}
private:
PyObject* m_tagHandlerClass;
wxArrayPtrVoid m_objArray;
};
%}
%inline %{
void wxHtmlWinParser_AddTagHandler(PyObject* tagHandlerClass) {
// Dynamically create a new wxModule. Refcounts tagHandlerClass
// and adds itself to the wxModules list and to the wxHtmlWinParser.
wxModule* module = new wxPyHtmlTagsModule(tagHandlerClass);
wxModule::InitializeModules();
}
%}
//---------------------------------------------------------------------------
%typemap(out) wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); }
%typemap(out) const wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); }
//---------------------------------------------------------------------------
%newgroup
// wxHtmlSelection is data holder with information about text selection.
// Selection is defined by two positions (beginning and end of the selection)
// and two leaf(!) cells at these positions.
class wxHtmlSelection
{
public:
wxHtmlSelection();
~wxHtmlSelection();
void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell,
const wxPoint& toPos, const wxHtmlCell *toCell);
%Rename(SetCells, void, Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell));
const wxHtmlCell *GetFromCell() const;
const wxHtmlCell *GetToCell() const;
// these values are in absolute coordinates:
const wxPoint& GetFromPos() const;
const wxPoint& GetToPos() const;
// // these are From/ToCell's private data
// const wxPoint& GetFromPrivPos() const;
// const wxPoint& GetToPrivPos() const;
// void SetFromPrivPos(const wxPoint& pos);
// void SetToPrivPos(const wxPoint& pos);
// void ClearPrivPos();
const bool IsEmpty() const;
%property(FromCell, GetFromCell, doc="See `GetFromCell`");
%property(FromPos, GetFromPos, doc="See `GetFromPos`");
// %property(FromPrivPos, GetFromPrivPos, SetFromPrivPos, doc="See `GetFromPrivPos` and `SetFromPrivPos`");
%property(ToCell, GetToCell, doc="See `GetToCell`");
%property(ToPos, GetToPos, doc="See `GetToPos`");
// %property(ToPrivPos, GetToPrivPos, SetToPrivPos, doc="See `GetToPrivPos` and `SetToPrivPos`");
};
enum wxHtmlSelectionState
{
wxHTML_SEL_OUT, // currently rendered cell is outside the selection
wxHTML_SEL_IN, // ... is inside selection
wxHTML_SEL_CHANGING // ... is the cell on which selection state changes
};
// Selection state is passed to wxHtmlCell::Draw so that it can render itself
// differently e.g. when inside text selection or outside it.
class wxHtmlRenderingState
{
public:
wxHtmlRenderingState();
~wxHtmlRenderingState();
void SetSelectionState(wxHtmlSelectionState s);
wxHtmlSelectionState GetSelectionState() const;
void SetFgColour(const wxColour& c);
const wxColour& GetFgColour() const;
void SetBgColour(const wxColour& c);
const wxColour& GetBgColour() const;
%property(BgColour, GetBgColour, SetBgColour, doc="See `GetBgColour` and `SetBgColour`");
%property(FgColour, GetFgColour, SetFgColour, doc="See `GetFgColour` and `SetFgColour`");
%property(SelectionState, GetSelectionState, SetSelectionState, doc="See `GetSelectionState` and `SetSelectionState`");
};
// HTML rendering customization. This class is used when rendering wxHtmlCells
// as a callback:
class wxHtmlRenderingStyle
{
public:
virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
%property(SelectedTextBgColour, GetSelectedTextBgColour, doc="See `GetSelectedTextBgColour`");
%property(SelectedTextColour, GetSelectedTextColour, doc="See `GetSelectedTextColour`");
};
// Standard style:
class wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle
{
public:
};
// Information given to cells when drawing them. Contains rendering state,
// selection information and rendering style object that can be used to
// customize the output.
class wxHtmlRenderingInfo
{
public:
wxHtmlRenderingInfo();
~wxHtmlRenderingInfo();
void SetSelection(wxHtmlSelection *s);
wxHtmlSelection *GetSelection() const;
void SetStyle(wxHtmlRenderingStyle *style);
wxHtmlRenderingStyle& GetStyle();
wxHtmlRenderingState& GetState();
%property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
%property(State, GetState, doc="See `GetState`");
%property(Style, GetStyle, SetStyle, doc="See `GetStyle` and `SetStyle`");
};
//---------------------------------------------------------------------------
%newgroup
enum
{
wxHTML_FIND_EXACT = 1,
wxHTML_FIND_NEAREST_BEFORE = 2,
wxHTML_FIND_NEAREST_AFTER = 4
};
class wxHtmlCell : public wxObject {
public:
%typemap(out) wxHtmlCell*; // turn off this typemap
wxHtmlCell();
~wxHtmlCell();
// Turn it back on again
%typemap(out) wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); }
int GetPosX();
int GetPosY();
int GetWidth();
int GetHeight();
int GetDescent();
// Returns the maximum possible length of the cell.
// Call Layout at least once before using GetMaxTotalWidth()
int GetMaxTotalWidth() const;
const wxString& GetId() const;
void SetId(const wxString& id);
wxHtmlLinkInfo* GetLink(int x = 0, int y = 0);
wxHtmlCell* GetNext();
wxHtmlContainerCell* GetParent();
wxHtmlCell* GetFirstChild() const;
// Returns cursor to be used when mouse is over the cell:
virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;
// Formatting cells are not visible on the screen, they only alter
// renderer's state.
bool IsFormattingCell() const;
void SetLink(const wxHtmlLinkInfo& link);
%disownarg(wxHtmlCell*);
void SetNext(wxHtmlCell *cell);
%cleardisown(wxHtmlCell*);
void SetParent(wxHtmlContainerCell *p);
void SetPos(int x, int y);
void Layout(int w);
void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
wxHtmlRenderingInfo& info);
void DrawInvisible(wxDC& dc, int x, int y,
wxHtmlRenderingInfo& info);
const wxHtmlCell* Find(int condition, const void* param);
virtual bool ProcessMouseClick(wxHtmlWindowInterface *window,
const wxPoint& pos,
const wxMouseEvent& event);
// TODO: bool AdjustPagebreak(int* INOUT,
// wxArrayInt& known_pagebreaks);
void SetCanLiveOnPagebreak(bool can);
// Can the line be broken before this cell?
bool IsLinebreakAllowed() const;
// Returns True for simple == terminal cells, i.e. not composite ones.
// This if for internal usage only and may disappear in future versions!
bool IsTerminalCell() const;
// Find a cell inside this cell positioned at the given coordinates
// (relative to this's positions). Returns NULL if no such cell exists.
// The flag can be used to specify whether to look for terminal or
// nonterminal cells or both. In either case, returned cell is deepest
// cell in cells tree that contains [x,y].
wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
unsigned flags = wxHTML_FIND_EXACT) const;
// Returns absolute position of the cell on HTML canvas
// If rootCell is provided, then it's considered to be the root of the
// hierarchy and the returned value is relative to it.
wxPoint GetAbsPos(wxHtmlCell *rootCell = NULL) const;
// Returns root cell of the hierarchy (i.e. grand-grand-...-parent that
// doesn't have a parent itself)
wxHtmlCell *GetRootCell() const;
// Returns first (last) terminal cell inside this cell. It may return NULL,
// but it is rare -- only if there are no terminals in the tree.
wxHtmlCell *GetFirstTerminal() const ;
wxHtmlCell *GetLastTerminal() const ;
// Returns cell's depth, i.e. how far under the root cell it is
// (if it is the root, depth is 0)
unsigned GetDepth() const;
// Returns True if the cell appears before 'cell' in natural order of
// cells (= as they are read). If cell A is (grand)parent of cell B,
// then both A.IsBefore(B) and B.IsBefore(A) always return True.
bool IsBefore(wxHtmlCell *cell) const;
// Converts the cell into text representation. If sel != NULL then
// only part of the cell inside the selection is converted.
wxString ConvertToText(wxHtmlSelection *sel) const;
%property(Depth, GetDepth, doc="See `GetDepth`");
%property(Descent, GetDescent, doc="See `GetDescent`");
%property(FirstChild, GetFirstChild, doc="See `GetFirstChild`");
%property(FirstTerminal, GetFirstTerminal, doc="See `GetFirstTerminal`");
%property(Height, GetHeight, doc="See `GetHeight`");
%property(Id, GetId, SetId, doc="See `GetId` and `SetId`");
%property(LastTerminal, GetLastTerminal, doc="See `GetLastTerminal`");
%property(Link, GetLink, SetLink, doc="See `GetLink` and `SetLink`");
%property(MaxTotalWidth, GetMaxTotalWidth, doc="See `GetMaxTotalWidth`");
%property(MouseCursor, GetMouseCursor, doc="See `GetMouseCursor`");
%property(Next, GetNext, SetNext, doc="See `GetNext` and `SetNext`");
%property(Parent, GetParent, SetParent, doc="See `GetParent` and `SetParent`");
%property(PosX, GetPosX, doc="See `GetPosX`");
%property(PosY, GetPosY, doc="See `GetPosY`");
%property(RootCell, GetRootCell, doc="See `GetRootCell`");
%property(Width, GetWidth, doc="See `GetWidth`");
};
class wxHtmlWordCell : public wxHtmlCell
{
public:
wxHtmlWordCell(const wxString& word, wxDC& dc);
wxString ConvertToText(wxHtmlSelection *sel) const;
bool IsLinebreakAllowed() const;
void SetPreviousWord(wxHtmlWordCell *cell);
};
class wxHtmlWordWithTabsCell : public wxHtmlWordCell
{
public:
wxHtmlWordWithTabsCell(const wxString& word,
const wxString& wordOrig,
size_t linepos,
const wxDC& dc);
};
class wxHtmlContainerCell : public wxHtmlCell {
public:
wxHtmlContainerCell(wxHtmlContainerCell *parent);
%disownarg(wxHtmlCell*);
void InsertCell(wxHtmlCell *cell);
%cleardisown(wxHtmlCell*);
void SetAlignHor(int al);
int GetAlignHor();
void SetAlignVer(int al);
int GetAlignVer();
void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
int GetIndent(int ind);
int GetIndentUnits(int ind);
void SetAlign(const wxHtmlTag& tag);
void SetWidthFloat(int w, int units);
%Rename(SetWidthFloatFromTag, void, SetWidthFloat(const wxHtmlTag& tag));
void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP);
void SetBackgroundColour(const wxColour& clr);
wxColour GetBackgroundColour();
void SetBorder(const wxColour& clr1, const wxColour& clr2, int border=1);
wxHtmlCell* GetFirstChild();
%pragma(python) addtoclass = "GetFirstCell = GetFirstChild"
%property(AlignHor, GetAlignHor, SetAlignHor, doc="See `GetAlignHor` and `SetAlignHor`");
%property(AlignVer, GetAlignVer, SetAlignVer, doc="See `GetAlignVer` and `SetAlignVer`");
%property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
%property(FirstChild, GetFirstChild, doc="See `GetFirstChild`");
%property(Indent, GetIndent, SetIndent, doc="See `GetIndent` and `SetIndent`");
%property(IndentUnits, GetIndentUnits, doc="See `GetIndentUnits`");
};
class wxHtmlColourCell : public wxHtmlCell {
public:
wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND);
};
class wxHtmlFontCell : public wxHtmlCell
{
public:
wxHtmlFontCell(wxFont *font);
};
class wxHtmlWidgetCell : public wxHtmlCell {
public:
wxHtmlWidgetCell(wxWindow* wnd, int w = 0);
};
//---------------------------------------------------------------------------
// wxHtmlFilter
//---------------------------------------------------------------------------
%newgroup
%{ // here's the C++ version
class wxPyHtmlFilter : public wxHtmlFilter {
DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter)
public:
wxPyHtmlFilter() : wxHtmlFilter() {}
// returns True if this filter is able to open&read given file
virtual bool CanRead(const wxFSFile& file) const {
bool rval = false;
bool found;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) {
PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false); // cast away const
rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
Py_DECREF(obj);
}
wxPyEndBlockThreads(blocked);
return rval;
}
// Reads given file and returns HTML document.
// Returns empty string if opening failed
virtual wxString ReadFile(const wxFSFile& file) const {
wxString rval;
bool found;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) {
PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false); // cast away const
PyObject* ro;
ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(O)", obj));
Py_DECREF(obj);
if (ro) {
rval = Py2wxString(ro);
Py_DECREF(ro);
}
}
wxPyEndBlockThreads(blocked);
return rval;
}
PYPRIVATE;
};
IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter);
%}
// And now the version seen by SWIG
%rename(HtmlFilter) wxPyHtmlFilter;
class wxPyHtmlFilter : public wxObject {
public:
%pythonAppend wxPyHtmlFilter setCallbackInfo(HtmlFilter)
wxPyHtmlFilter();
void _setCallbackInfo(PyObject* self, PyObject* _class);
};
// TODO: wxHtmlFilterHTML
//---------------------------------------------------------------------------
class wxHtmlWindowInterface
{
public:
/// Ctor
wxHtmlWindowInterface();
virtual ~wxHtmlWindowInterface();
/**
Called by the parser to set window's title to given text.
*/
virtual void SetHTMLWindowTitle(const wxString& title) = 0;
// /**
// Called when a link is clicked.
// @param link information about the clicked link
// */
// virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link) = 0;
// /**
// Called when the parser needs to open another URL (e.g. an image).
// @param type Type of the URL request (e.g. image)
// @param url URL the parser wants to open
// @param redirect If the return value is wxHTML_REDIRECT, then the
// URL to redirect to will be stored in this variable
// (the pointer must never be NULL)
// @return indicator of how to treat the request
// */
// virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type,
// const wxString& url,
// wxString *redirect) const = 0;
/**
Converts coordinates @a pos relative to given @a cell to
physical coordinates in the window.
*/
virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell,
const wxPoint& pos) const = 0;
/// Returns the window used for rendering (may be NULL).
virtual wxWindow* GetHTMLWindow() = 0;
/// Returns background colour to use by default.
virtual wxColour GetHTMLBackgroundColour() const = 0;
/// Sets window's background to colour @a clr.
virtual void SetHTMLBackgroundColour(const wxColour& clr) = 0;
/// Sets window's background to given bitmap.
virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg) = 0;
/// Sets status bar text.
virtual void SetHTMLStatusText(const wxString& text) = 0;
/// Type of mouse cursor
enum HTMLCursor
{
/// Standard mouse cursor (typically an arrow)
HTMLCursor_Default,
/// Cursor shown over links
HTMLCursor_Link,
/// Cursor shown over selectable text
HTMLCursor_Text
};
/**
Returns mouse cursor of given @a type.
*/
// virtual wxCursor GetHTMLCursor(HTMLCursor type) const = 0;
%property(HTMLBackgroundColour, GetHTMLBackgroundColour, SetHTMLBackgroundColour, doc="See `GetHTMLBackgroundColour` and `SetHTMLBackgroundColour`");
%property(HTMLWindow, GetHTMLWindow, doc="See `GetHTMLWindow`");
};
//---------------------------------------------------------------------------
// wxHtmlWindow
//---------------------------------------------------------------------------
%newgroup
// TODO?
// wxHtmlWindowInterface and wxHtmlWindowMouseHelper
%{
class wxPyHtmlWindow : public wxHtmlWindow {
DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow)
public:
wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHW_DEFAULT_STYLE,
const wxString& name = wxPyHtmlWindowNameStr)
: wxHtmlWindow(parent, id, pos, size, style, name) {};
wxPyHtmlWindow() : wxHtmlWindow() {};
bool ScrollToAnchor(const wxString& anchor) {
return wxHtmlWindow::ScrollToAnchor(anchor);
}
bool HasAnchor(const wxString& anchor) {
const wxHtmlCell *c = m_Cell->Find(wxHTML_COND_ISANCHOR, &anchor);
return c!=NULL;
}
void OnLinkClicked(const wxHtmlLinkInfo& link);
wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
const wxString& url,
wxString *redirect) const;
DEC_PYCALLBACK__STRING(OnSetTitle);
DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover);
DEC_PYCALLBACK_BOOL_CELLINTINTME(OnCellClicked);
PYPRIVATE;
};
IMPLEMENT_ABSTRACT_CLASS( wxPyHtmlWindow, wxHtmlWindow );
IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle);
IMP_PYCALLBACK__CELLINTINT(wxPyHtmlWindow, wxHtmlWindow, OnCellMouseHover);
IMP_PYCALLBACK_BOOL_CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked);
void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
bool found;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) {
PyObject* obj = wxPyConstructObject((void*)&link, wxT("wxHtmlLinkInfo"), 0);
wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
Py_DECREF(obj);
}
wxPyEndBlockThreads(blocked);
if (! found)
wxHtmlWindow::OnLinkClicked(link);
}
wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
const wxString& url,
wxString *redirect) const {
bool found;
wxHtmlOpeningStatus rval;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
PyObject* ro;
PyObject* s = wx2PyString(url);
ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iO)", type, s));
Py_DECREF(s);
if (PyString_Check(ro)
#if PYTHON_API_VERSION >= 1009
|| PyUnicode_Check(ro)
#endif
) {
*redirect = Py2wxString(ro);
rval = wxHTML_REDIRECT;
}
else {
PyObject* num = PyNumber_Int(ro);
rval = (wxHtmlOpeningStatus)PyInt_AsLong(num);
Py_DECREF(num);
}
Py_DECREF(ro);
}
wxPyEndBlockThreads(blocked);
if (! found)
rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
return rval;
}
%}
MustHaveApp(wxPyHtmlWindow);
%rename(HtmlWindow) wxPyHtmlWindow;
class wxPyHtmlWindow : public wxScrolledWindow //,
// public wxHtmlWindowInterface //,
// public wxHtmlWindowMouseHelper
{
public:
%pythonAppend wxPyHtmlWindow "self._setOORInfo(self);" setCallbackInfo(HtmlWindow)
%pythonAppend wxPyHtmlWindow() ""
%typemap(out) wxPyHtmlWindow*; // turn off this typemap
wxPyHtmlWindow(wxWindow *parent, int id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int style=wxHW_DEFAULT_STYLE,
const wxString& name = wxPyHtmlWindowNameStr);
%RenameCtor(PreHtmlWindow, wxPyHtmlWindow());
// Turn it back on again
%typemap(out) wxPyHtmlWindow* { $result = wxPyMake_wxObject($1, $owner); }
bool Create(wxWindow *parent, int id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int style=wxHW_SCROLLBAR_AUTO,
const wxString& name = wxPyHtmlWindowNameStr);
void _setCallbackInfo(PyObject* self, PyObject* _class);
// Set HTML page and display it. !! source is HTML document itself,
// it is NOT address/filename of HTML document. If you want to
// specify document location, use LoadPage() instead
// Return value : False if an error occurred, True otherwise
bool SetPage(const wxString& source);
// Load HTML page from given location. Location can be either
// a) /usr/wxGTK2/docs/html/wx.htm
// b) http://www.somewhere.uk/document.htm
// c) ftp://ftp.somesite.cz/pub/something.htm
// In case there is no prefix (http:,ftp:), the method
// will try to find it itself (1. local file, then http or ftp)
// After the page is loaded, the method calls SetPage() to display it.
// Note : you can also use path relative to previously loaded page
// Return value : same as SetPage
bool LoadPage(const wxString& location);
// Loads HTML page from file
bool LoadFile(const wxString& filename);
// Append to current page
bool AppendToPage(const wxString& source);
// Returns full location of opened page
wxString GetOpenedPage();
// Returns anchor within opened page
wxString GetOpenedAnchor();
// Returns <TITLE> of opened page or empty string otherwise
wxString GetOpenedPageTitle();
// Sets frame in which page title will be displayed. Format is format of
// frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
void SetRelatedFrame(wxFrame* frame, const wxString& format);
wxFrame* GetRelatedFrame();
// After(!) calling SetRelatedFrame, this sets statusbar slot where messages
// will be displayed. Default is -1 = no messages.
%nokwargs SetRelatedStatusBar;
void SetRelatedStatusBar(int bar);
void SetRelatedStatusBar(wxStatusBar*, int index = 0);
// Sets fonts to be used when displaying HTML page.
%extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
self->SetFonts(normal_face, fixed_face, temp);
if (temp)
delete [] temp;
}
}
// Sets font sizes to be relative to the given size or the system
// default size; use either specified or default font
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxPyEmptyString,
const wxString& fixed_face = wxPyEmptyString);
DocDeclStr(
void, SetLabel(const wxString& title),
"", "");
// Sets space between text and window borders.
void SetBorders(int b);
// Sets the bitmap to use for background (currnetly it will be tiled,
// when/if we have CSS support we could add other possibilities...)
void SetBackgroundImage(const wxBitmap& bmpBg);
// Saves custom settings into cfg config. it will use the path 'path'
// if given, otherwise it will save info into currently selected path.
// saved values : things set by SetFonts, SetBorders.
void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
// Goes to previous/next page (in browsing history)
// Returns True if successful, False otherwise
bool HistoryBack();
bool HistoryForward();
bool HistoryCanBack();
bool HistoryCanForward();
// Resets History
void HistoryClear();
// Returns pointer to conteiners/cells structure.
wxHtmlContainerCell* GetInternalRepresentation();
// Returns a pointer to the parser.
wxHtmlWinParser* GetParser();
bool ScrollToAnchor(const wxString& anchor);
bool HasAnchor(const wxString& anchor);
//Adds input filter
static void AddFilter(wxPyHtmlFilter *filter);
// Helper functions to select parts of page:
void SelectWord(const wxPoint& pos);
void SelectLine(const wxPoint& pos);
void SelectAll();
// Convert selection to text:
wxString SelectionToText();
// Converts current page to text:
wxString ToText();
void OnLinkClicked(const wxHtmlLinkInfo& link);
void OnSetTitle(const wxString& title);
void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
bool OnCellClicked(wxHtmlCell *cell,
wxCoord x, wxCoord y,
const wxMouseEvent& event);
wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
const wxString& url,
wxString *redirect) const;
%MAKE_BASE_FUNC(HtmlWindow, OnLinkClicked);
%MAKE_BASE_FUNC(HtmlWindow, OnSetTitle);
%MAKE_BASE_FUNC(HtmlWindow, OnCellMouseHover);
%MAKE_BASE_FUNC(HtmlWindow, OnCellClicked);
static wxVisualAttributes
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
/// Type of mouse cursor
enum HTMLCursor
{
/// Standard mouse cursor (typically an arrow)
HTMLCursor_Default,
/// Cursor shown over links
HTMLCursor_Link,
/// Cursor shown over selectable text
HTMLCursor_Text
};
// Returns standard HTML cursor as used by wxHtmlWindow
static wxCursor GetDefaultHTMLCursor(HTMLCursor type);
// private:
// // wxHtmlWindowInterface methods:
// virtual void SetHTMLWindowTitle(const wxString& title);
// virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link);
// virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type,
// const wxString& url,
// wxString *redirect) const;
// virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell,
// const wxPoint& pos) const;
// virtual wxWindow* GetHTMLWindow();
// virtual wxColour GetHTMLBackgroundColour() const;
// virtual void SetHTMLBackgroundColour(const wxColour& clr);
// virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg);
// virtual void SetHTMLStatusText(const wxString& text);
// virtual wxCursor GetHTMLCursor(HTMLCursor type) const;
%property(InternalRepresentation, GetInternalRepresentation, doc="See `GetInternalRepresentation`");
%property(OpenedAnchor, GetOpenedAnchor, doc="See `GetOpenedAnchor`");
%property(OpenedPage, GetOpenedPage, doc="See `GetOpenedPage`");
%property(OpenedPageTitle, GetOpenedPageTitle, doc="See `GetOpenedPageTitle`");
%property(Parser, GetParser, doc="See `GetParser`");
%property(RelatedFrame, GetRelatedFrame, doc="See `GetRelatedFrame`");
};
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
%newgroup
MustHaveApp(wxHtmlDCRenderer);
class wxHtmlDCRenderer : public wxObject {
public:
wxHtmlDCRenderer();
~wxHtmlDCRenderer();
%nokwargs SetDC;
void SetDC(wxDC *dc, double pixel_scale = 1.0);
void SetDC(wxDC *dc, double pixel_scale, double font_scale);
void SetSize(int width, int height);
void SetHtmlText(const wxString& html,
const wxString& basepath = wxPyEmptyString,
bool isdir = true);
// Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
%extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
self->SetFonts(normal_face, fixed_face, temp);
if (temp)
delete [] temp;
}
}
// Sets font sizes to be relative to the given size or the system
// default size; use either specified or default font
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxPyEmptyString,
const wxString& fixed_face = wxPyEmptyString);
int Render(int x, int y, wxArrayInt& known_pagebreaks, int from = 0,
int dont_render = false, int to = INT_MAX);
int GetTotalHeight();
// returns total height of the html document
// (compare Render's return value with this)
%property(TotalHeight, GetTotalHeight, doc="See `GetTotalHeight`");
};
enum {
wxPAGE_ODD,
wxPAGE_EVEN,
wxPAGE_ALL
};
MustHaveApp(wxHtmlPrintout);
class wxHtmlPrintout : public wxPyPrintout {
public:
wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr);
//~wxHtmlPrintout(); wxPrintPreview object takes ownership...
void SetHtmlText(const wxString& html,
const wxString &basepath = wxPyEmptyString,
bool isdir = true);
void SetHtmlFile(const wxString &htmlfile);
void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
// Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
%extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
self->SetFonts(normal_face, fixed_face, temp);
if (temp)
delete [] temp;
}
}
// Sets font sizes to be relative to the given size or the system
// default size; use either specified or default font
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxPyEmptyString,
const wxString& fixed_face = wxPyEmptyString);
void SetMargins(float top = 25.2, float bottom = 25.2,
float left = 25.2, float right = 25.2,
float spaces = 5);
// Adds input filter
static void AddFilter(wxHtmlFilter *filter);
// Cleanup
static void CleanUpStatics();
};
MustHaveApp(wxHtmlEasyPrinting);
class wxHtmlEasyPrinting : public wxObject {
public:
wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr,
wxWindow *parentWindow = NULL);
~wxHtmlEasyPrinting();
bool PreviewFile(const wxString &htmlfile);
bool PreviewText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
bool PrintFile(const wxString &htmlfile);
bool PrintText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
// void PrinterSetup();
void PageSetup();
void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
%extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
self->SetFonts(normal_face, fixed_face, temp);
if (temp)
delete [] temp;
}
}
// Sets font sizes to be relative to the given size or the system
// default size; use either specified or default font
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxPyEmptyString,
const wxString& fixed_face = wxPyEmptyString);
wxPrintData *GetPrintData();
wxPageSetupDialogData *GetPageSetupData();
wxWindow* GetParentWindow() const;
void SetParentWindow(wxWindow* window);
const wxString& GetName() const;
void SetName(const wxString& name);
%property(PageSetupData, GetPageSetupData, doc="See `GetPageSetupData`");
%property(PrintData, GetPrintData, doc="See `GetPrintData`");
%property(ParentWindow, GetParentWindow, SetParentWindow);
%property(Name, GetName, SetName);
};
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
%newgroup
class wxHtmlBookRecord {
public:
wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath,
const wxString& title, const wxString& start);
wxString GetBookFile();
wxString GetTitle();
wxString GetStart();
wxString GetBasePath();
void SetContentsRange(int start, int end);
int GetContentsStart();
int GetContentsEnd();
void SetTitle(const wxString& title);
void SetBasePath(const wxString& path);
void SetStart(const wxString& start);
wxString GetFullPath(const wxString &page) const;
%property(BasePath, GetBasePath, SetBasePath, doc="See `GetBasePath` and `SetBasePath`");
%property(BookFile, GetBookFile, doc="See `GetBookFile`");
%property(ContentsEnd, GetContentsEnd, doc="See `GetContentsEnd`");
%property(ContentsStart, GetContentsStart, doc="See `GetContentsStart`");
%property(FullPath, GetFullPath, doc="See `GetFullPath`");
%property(Start, GetStart, SetStart, doc="See `GetStart` and `SetStart`");
%property(Title, GetTitle, SetTitle, doc="See `GetTitle` and `SetTitle`");
};
//---------------------------------------------------------------------------
// WXWIN_COMPATIBILITY_2_4
#if 0
struct wxHtmlContentsItem
{
%extend {
int GetLevel() { return self->m_Level; }
int GetID() { return self->m_ID; }
wxString GetName() { return self->m_Name; }
wxString GetPage() { return self->m_Page; }
wxHtmlBookRecord* GetBook() { return self->m_Book; }
}
};
#endif
//---------------------------------------------------------------------------
class wxHtmlSearchStatus
{
public:
//wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
// const wxString& book = wxPyEmptyString);
bool Search();
bool IsActive();
int GetCurIndex();
int GetMaxIndex();
const wxString& GetName();
%property(CurIndex, GetCurIndex, doc="See `GetCurIndex`");
%property(MaxIndex, GetMaxIndex, doc="See `GetMaxIndex`");
%property(Name, GetName, doc="See `GetName`");
};
//---------------------------------------------------------------------------
class wxHtmlHelpData {
public:
wxHtmlHelpData();
~wxHtmlHelpData();
void SetTempDir(const wxString& path);
bool AddBook(const wxString& book);
// bool AddBookParam(const wxString& title, const wxString& contfile,
// const wxString& indexfile=wxPyEmptyString,
// const wxString& deftopic=wxPyEmptyString,
// const wxString& path=wxPyEmptyString);
wxString FindPageByName(const wxString& page);
wxString FindPageById(int id);
// TODO: this one needs fixed...
const wxHtmlBookRecArray& GetBookRecArray();
%property(BookRecArray, GetBookRecArray, doc="See `GetBookRecArray`");
};
//---------------------------------------------------------------------------
enum {
wxHF_TOOLBAR,
wxHF_CONTENTS,
wxHF_INDEX,
wxHF_SEARCH,
wxHF_BOOKMARKS,
wxHF_OPEN_FILES,
wxHF_PRINT,
wxHF_FLAT_TOOLBAR,
wxHF_MERGE_BOOKS,
wxHF_ICONS_BOOK,
wxHF_ICONS_BOOK_CHAPTER,
wxHF_ICONS_FOLDER,
wxHF_DEFAULT_STYLE,
wxHF_EMBEDDED,
wxHF_DIALOG,
wxHF_FRAME,
wxHF_MODAL,
};
enum {
wxID_HTML_PANEL,
wxID_HTML_BACK,
wxID_HTML_FORWARD,
wxID_HTML_UPNODE,
wxID_HTML_UP,
wxID_HTML_DOWN,
wxID_HTML_PRINT,
wxID_HTML_OPENFILE,
wxID_HTML_OPTIONS,
wxID_HTML_BOOKMARKSLIST,
wxID_HTML_BOOKMARKSADD,
wxID_HTML_BOOKMARKSREMOVE,
wxID_HTML_TREECTRL,
wxID_HTML_INDEXPAGE,
wxID_HTML_INDEXLIST,
wxID_HTML_INDEXTEXT,
wxID_HTML_INDEXBUTTON,
wxID_HTML_INDEXBUTTONALL,
wxID_HTML_NOTEBOOK,
wxID_HTML_SEARCHPAGE,
wxID_HTML_SEARCHTEXT,
wxID_HTML_SEARCHLIST,
wxID_HTML_SEARCHBUTTON,
wxID_HTML_SEARCHCHOICE,
wxID_HTML_COUNTINFO
};
%{
typedef wxTreeCtrl wxPyTreeCtrl;
%}
MustHaveApp(wxHtmlHelpWindow);
class wxHtmlHelpWindow : public wxWindow
{
public:
%pythonAppend wxHtmlHelpWindow "self._setOORInfo(self)"
%pythonAppend wxHtmlHelpWindow() ""
%typemap(out) wxHtmlHelpWindow*; // turn off this typemap
wxHtmlHelpWindow(wxWindow* parent, wxWindowID wxWindowID,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int style = wxTAB_TRAVERSAL|wxNO_BORDER,
int helpStyle = wxHF_DEFAULT_STYLE,
wxHtmlHelpData* data = NULL);
%RenameCtor(PreHtmlHelpWindow, wxHtmlHelpWindow(wxHtmlHelpData* data = NULL));
// Turn it back on again
%typemap(out) wxHtmlHelpWindow* { $result = wxPyMake_wxObject($1, $owner); }
bool Create(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int style = wxTAB_TRAVERSAL|wxNO_BORDER,
int helpStyle = wxHF_DEFAULT_STYLE);
wxHtmlHelpData* GetData();
wxHtmlHelpController* GetController() const;
%disownarg( wxHtmlHelpController* controller );
void SetController(wxHtmlHelpController* controller);
%cleardisown( wxHtmlHelpController* controller );
// Displays page x. If not found it will offect the user a choice of
// searching books.
// Looking for the page runs in these steps:
// 1. try to locate file named x (if x is for example "doc/howto.htm")
// 2. try to open starting page of book x
// 3. try to find x in contents (if x is for example "How To ...")
// 4. try to find x in index (if x is for example "How To ...")
bool Display(const wxString& x);
// Alternative version that works with numeric ID.
// (uses extension to MS format, <param name="ID" value=id>, see docs)
%Rename(DisplayID, bool, Display(int id));
// Displays help window and focuses contents.
bool DisplayContents();
// Displays help window and focuses index.
bool DisplayIndex();
// Searches for keyword. Returns true and display page if found, return
// false otherwise
// Syntax of keyword is Altavista-like:
// * words are separated by spaces
// (but "\"hello world\"" is only one world "hello world")
// * word may be pretended by + or -
// (+ : page must contain the word ; - : page can't contain the word)
// * if there is no + or - before the word, + is default
bool KeywordSearch(const wxString& keyword,
wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
// Saves custom settings into cfg config. it will use the path 'path'
// if given, otherwise it will save info into currently selected path.
// saved values : things set by SetFonts, SetBorders.
void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
// call this to let wxHtmlHelpWindow know page changed
void NotifyPageChanged();
// Refreshes Contents and Index tabs
void RefreshLists();
// Gets the HTML window
wxPyHtmlWindow* GetHtmlWindow() const;
// Gets the splitter window
wxSplitterWindow* GetSplitterWindow();
// Gets the toolbar
wxToolBar* GetToolBar() const;
// Gets the configuration data
wxHtmlHelpFrameCfg& GetCfgData();
// Gets the tree control
wxPyTreeCtrl *GetTreeCtrl() const;
%property(CfgData, GetCfgData, doc="See `GetCfgData`");
%property(Controller, GetController, SetController, doc="See `GetController` and `SetController`");
%property(Data, GetData, doc="See `GetData`");
%property(HtmlWindow, GetHtmlWindow, doc="See `GetHtmlWindow`");
%property(SplitterWindow, GetSplitterWindow, doc="See `GetSplitterWindow`");
%property(ToolBar, GetToolBar, doc="See `GetToolBar`");
%property(TreeCtrl, GetTreeCtrl, doc="See `GetTreeCtrl`");
};
//---------------------------------------------------------------------------
%constant wxEventType wxEVT_COMMAND_HTML_CELL_CLICKED;
%constant wxEventType wxEVT_COMMAND_HTML_CELL_HOVER;
%constant wxEventType wxEVT_COMMAND_HTML_LINK_CLICKED;
class wxHtmlCellEvent : public wxCommandEvent
{
public:
wxHtmlCellEvent(wxEventType commandType, int id,
wxHtmlCell *cell, const wxPoint &pt,
const wxMouseEvent &ev);
wxHtmlCell* GetCell() const;
wxPoint GetPoint() const;
wxMouseEvent GetMouseEvent() const;
void SetLinkClicked(bool linkclicked);
bool GetLinkClicked() const;
};
class wxHtmlLinkEvent : public wxCommandEvent
{
public:
wxHtmlLinkEvent(int id, const wxHtmlLinkInfo &linkinfo);
const wxHtmlLinkInfo &GetLinkInfo() const;
};
%pythoncode {
EVT_HTML_CELL_CLICKED = wx.PyEventBinder( wxEVT_COMMAND_HTML_CELL_CLICKED, 1 )
EVT_HTML_CELL_HOVER = wx.PyEventBinder( wxEVT_COMMAND_HTML_CELL_HOVER, 1 )
EVT_HTML_LINK_CLICKED = wx.PyEventBinder( wxEVT_COMMAND_HTML_LINK_CLICKED, 1 )
}
//---------------------------------------------------------------------------
MustHaveApp(wxHtmlHelpFrame);
class wxHtmlHelpFrame : public wxFrame {
public:
%pythonAppend wxHtmlHelpFrame "self._setOORInfo(self)"
%pythonAppend wxHtmlHelpFrame() ""
%typemap(out) wxHtmlHelpFrame*; // turn off this typemap
wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
const wxString& title = wxPyEmptyString,
int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL,
wxConfigBase *config=NULL,
const wxString& rootpath = wxPyEmptyString);
%RenameCtor(PreHtmlHelpFrame, wxHtmlHelpFrame(wxHtmlHelpData* data = NULL));
// Turn it back on again
%typemap(out) wxHtmlHelpFrame* { $result = wxPyMake_wxObject($1, $owner); }
bool Create(wxWindow* parent, wxWindowID id,
const wxString& title = wxPyEmptyString,
int style = wxHF_DEFAULT_STYLE,
wxConfigBase *config=NULL,
const wxString& rootpath = wxPyEmptyString);
wxHtmlHelpData* GetData();
void SetTitleFormat(const wxString& format);
void AddGrabIfNeeded();
void SetShouldPreventAppExit(bool enable);
/// Returns the help controller associated with the window.
wxHtmlHelpController* GetController() const;
/// Sets the help controller associated with the window.
%disownarg( wxHtmlHelpController* controller );
void SetController(wxHtmlHelpController* controller);
%cleardisown( wxHtmlHelpController* controller );
/// Returns the help window.
wxHtmlHelpWindow* GetHelpWindow() const;
%pythoncode {
%# For compatibility from before the refactor
def Display(self, x):
return self.GetHelpWindow().Display(x)
def DisplayID(self, x):
return self.GetHelpWindow().DisplayID(id)
def DisplayContents(self):
return self.GetHelpWindow().DisplayContents()
def DisplayIndex(self):
return self.GetHelpWindow().DisplayIndex()
def KeywordSearch(self, keyword):
return self.GetHelpWindow().KeywordSearch(keyword)
def UseConfig(self, config, rootpath=""):
return self.GetHelpWindow().UseConfig(config, rootpath)
def ReadCustomization(self, config, rootpath=""):
return self.GetHelpWindow().ReadCustomization(config, rootpath)
def WriteCustomization(self, config, rootpath=""):
return self.GetHelpWindow().WriteCustomization(config, rootpath)
%}
%property(Controller, GetController, SetController, doc="See `GetController` and `SetController`");
%property(Data, GetData, doc="See `GetData`");
%property(HelpWindow, GetHelpWindow, doc="See `GetHelpWindow`");
};
MustHaveApp(wxHtmlHelpDialog);
class wxHtmlHelpDialog : public wxDialog
{
public:
%pythonAppend wxHtmlHelpDialog "self._setOORInfo(self)"
%pythonAppend wxHtmlHelpDialog() ""
%typemap(out) wxHtmlHelpDialog*; // turn off this typemap
wxHtmlHelpDialog(wxWindow* parent, wxWindowID wxWindowID,
const wxString& title = wxPyEmptyString,
int style = wxHF_DEFAULT_STYLE, wxHtmlHelpData* data = NULL);
%RenameCtor(PreHtmlHelpDialog, wxHtmlHelpDialog(wxHtmlHelpData* data = NULL));
// Turn it back on again
%typemap(out) wxHtmlHelpDialog* { $result = wxPyMake_wxObject($1, $owner); }
bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxPyEmptyString,
int style = wxHF_DEFAULT_STYLE);
/// Returns the data associated with this dialog.
wxHtmlHelpData* GetData();
/// Returns the controller that created this dialog.
wxHtmlHelpController* GetController() const;
/// Sets the controller associated with this dialog.
%disownarg( wxHtmlHelpController* controller );
void SetController(wxHtmlHelpController* controller);
%cleardisown( wxHtmlHelpController* controller );
/// Returns the help window.
wxHtmlHelpWindow* GetHelpWindow() const;
// Sets format of title of the frame. Must contain exactly one "%s"
// (for title of displayed HTML page)
void SetTitleFormat(const wxString& format);
// Override to add custom buttons to the toolbar
// virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {};
%property(Controller, GetController, SetController, doc="See `GetController` and `SetController`");
%property(Data, GetData, doc="See `GetData`");
%property(HelpWindow, GetHelpWindow, doc="See `GetHelpWindow`");
};
//---------------------------------------------------------------------------
// TODO: Make virtual methods of this class overridable in Python.
MustHaveApp(wxHelpControllerBase);
class wxHelpControllerBase: public wxObject
{
public:
// wxHelpControllerBase(wxWindow* parentWindow = NULL);
// ~wxHelpControllerBase();
%nokwargs Initialize;
virtual bool Initialize(const wxString& file, int server );
virtual bool Initialize(const wxString& file);
virtual void SetViewer(const wxString& viewer, long flags = 0);
// If file is "", reloads file given in Initialize
virtual bool LoadFile(const wxString& file = wxEmptyString) /* = 0 */;
// Displays the contents
virtual bool DisplayContents(void) /* = 0 */;
%nokwargs DisplaySection;
// Display the given section
virtual bool DisplaySection(int sectionNo) /* = 0 */;
// Display the section using a context id
virtual bool DisplayContextPopup(int contextId);
// Display the text in a popup, if possible
virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos);
// By default, uses KeywordSection to display a topic. Implementations
// may override this for more specific behaviour.
virtual bool DisplaySection(const wxString& section);
virtual bool DisplayBlock(long blockNo) /* = 0 */;
virtual bool KeywordSearch(const wxString& k,
wxHelpSearchMode mode = wxHELP_SEARCH_ALL) /* = 0 */;
/// Allows one to override the default settings for the help frame.
virtual void SetFrameParameters(const wxString& title,
const wxSize& size,
const wxPoint& pos = wxDefaultPosition,
bool newFrameEachTime = false);
/// Obtains the latest settings used by the help frame and the help
/// frame.
// TODO: return a tuple of values
// virtual wxFrame *GetFrameParameters(wxSize *size = NULL,
// wxPoint *pos = NULL,
// bool *newFrameEachTime = NULL);
virtual bool Quit() /* = 0 */;
virtual void OnQuit();
/// Set the window that can optionally be used for the help window's parent.
virtual void SetParentWindow(wxWindow* win);
/// Get the window that can optionally be used for the help window's parent.
virtual wxWindow* GetParentWindow() const;
%property(ParentWindow, GetParentWindow, SetParentWindow, doc="See `GetParentWindow` and `SetParentWindow`");
};
MustHaveApp(wxHtmlHelpController);
class wxHtmlHelpController : public wxHelpControllerBase
{
public:
// %pythonAppend wxHtmlHelpController "self._setOORInfo(self)"
wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE, wxWindow* parentWindow = NULL);
~wxHtmlHelpController();
void SetShouldPreventAppExit(bool enable);
wxHtmlHelpWindow* GetHelpWindow();
void SetHelpWindow(wxHtmlHelpWindow* helpWindow);
wxHtmlHelpFrame* GetFrame();
wxHtmlHelpDialog* GetDialog();
void SetTitleFormat(const wxString& format);
void SetTempDir(const wxString& path);
bool AddBook(const wxString& book, int show_wait_msg = false);
void Display(const wxString& x);
%Rename(DisplayID, void, Display(int id));
void DisplayContents();
void DisplayIndex();
bool KeywordSearch(const wxString& keyword);
void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString);
void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
void MakeModalIfNeeded();
wxWindow* FindTopLevelWindow();
%property(Dialog, GetDialog, doc="See `GetDialog`");
%property(Frame, GetFrame, doc="See `GetFrame`");
%property(HelpWindow, GetHelpWindow, SetHelpWindow, doc="See `GetHelpWindow` and `SetHelpWindow`");
};
/*
* wxHtmlModalHelp
* A convenience class particularly for use on wxMac,
* where you can only show modal dialogs from a modal
* dialog.
*
* Use like this:
*
* wxHtmlModalHelp help(parent, filename, topic);
*
* If topic is empty, the help contents is displayed.
*/
class wxHtmlModalHelp
{
public:
wxHtmlModalHelp(wxWindow* parent, const wxString& helpFile,
const wxString& topic = wxEmptyString,
int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL);
};
//---------------------------------------------------------------------------
%init %{
wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler");
wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow");
wxPyPtrTypeMap_Add("wxHtmlFilter", "wxPyHtmlFilter");
%}
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
|