1 /////////////////////////////////////////////////////////////////////////////
 
   3 // Purpose:     SWIG definitions of html classes
 
   7 // Created:     25-nov-1998
 
   9 // Copyright:   (c) 1998 by Total Control Software
 
  10 // Licence:     wxWindows license
 
  11 /////////////////////////////////////////////////////////////////////////////
 
  18 #include <wx/html/htmlwin.h>
 
  19 #include <wx/html/htmprint.h>
 
  21 #include <wx/fs_zip.h>
 
  22 #include <wx/fs_inet.h>
 
  23 #include <wx/wfstream.h>
 
  28 //---------------------------------------------------------------------------
 
  31 %include my_typemaps.i
 
  43 %pragma(python) code = "import wx"
 
  46 //----------------------------------------------------------------------
 
  49     // Put some wx default wxChar* values into wxStrings.
 
  50     static const wxChar* wxHtmlWindowNameStr = wxT("htmlWindow");
 
  51     DECLARE_DEF_STRING(HtmlWindowNameStr);
 
  53     static const wxChar* wxHtmlPrintoutTitleStr = wxT("Printout");
 
  54     DECLARE_DEF_STRING(HtmlPrintoutTitleStr);
 
  56     static const wxChar* wxHtmlPrintingTitleStr = wxT("Printing");
 
  57     DECLARE_DEF_STRING(HtmlPrintingTitleStr);
 
  59     static const wxString wxPyEmptyString(wxT(""));
 
  62 //---------------------------------------------------------------------------
 
  71     wxHTML_CLR_FOREGROUND,
 
  72     wxHTML_CLR_BACKGROUND,
 
  82     wxHTML_INDENT_HORIZONTAL,
 
  83     wxHTML_INDENT_VERTICAL,
 
  87     wxHTML_COND_ISIMAGEMAP,
 
  98 // enums for wxHtmlWindow::OnOpeningURL
 
  99 enum wxHtmlOpeningStatus
 
 113 //---------------------------------------------------------------------------
 
 115 class wxHtmlLinkInfo : public wxObject {
 
 117     wxHtmlLinkInfo(const wxString& href, const wxString& target = wxPyEmptyString);
 
 119     wxString GetTarget();
 
 120     wxMouseEvent* GetEvent();
 
 121     wxHtmlCell* GetHtmlCell();
 
 123     void SetEvent(const wxMouseEvent *e);
 
 124     void SetHtmlCell(const wxHtmlCell * e);
 
 127 //---------------------------------------------------------------------------
 
 129 class wxHtmlTag : public wxObject {
 
 131     // Never need to create a new tag from Python...
 
 132     //wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache);
 
 135     bool HasParam(const wxString& par);
 
 136     wxString GetParam(const wxString& par, int with_commas = FALSE);
 
 138     // Can't do this one as-is, but GetParam should be enough...
 
 139     //int ScanParam(const wxString& par, const char *format, void* param);
 
 141     wxString GetAllParams();
 
 149 //---------------------------------------------------------------------------
 
 151 class wxHtmlParser : public wxObject {
 
 153     // wxHtmlParser();  This is an abstract base class...
 
 155     void SetFS(wxFileSystem *fs);
 
 156     wxFileSystem* GetFS();
 
 157     wxObject* Parse(const wxString& source);
 
 158     void InitParser(const wxString& source);
 
 160     void DoParsing(int begin_pos, int end_pos);
 
 161     // wxObject* GetProduct();
 
 162     void AddTagHandler(wxHtmlTagHandler *handler);
 
 163     wxString* GetSource();
 
 164     void PushTagHandler(wxHtmlTagHandler* handler, wxString tags);
 
 165     void PopTagHandler();
 
 167     // virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const;
 
 169     // void AddText(const char* txt) = 0;
 
 170     // void AddTag(const wxHtmlTag& tag);
 
 174 //---------------------------------------------------------------------------
 
 176 class wxHtmlWinParser : public wxHtmlParser {
 
 178     wxHtmlWinParser(wxHtmlWindow *wnd = NULL);
 
 180     void SetDC(wxDC *dc);
 
 184     wxHtmlWindow* GetWindow();
 
 185     //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
 
 187         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
 
 188             int* temp = int_LIST_helper(sizes);
 
 190                 self->SetFonts(normal_face, fixed_face, temp);
 
 196     wxHtmlContainerCell* GetContainer();
 
 197     wxHtmlContainerCell* OpenContainer();
 
 198     wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);
 
 199     wxHtmlContainerCell* CloseContainer();
 
 202     void SetFontSize(int s);
 
 204     void SetFontBold(int x);
 
 206     void SetFontItalic(int x);
 
 207     int GetFontUnderlined();
 
 208     void SetFontUnderlined(int x);
 
 210     void SetFontFixed(int x);
 
 212     void SetAlign(int a);
 
 213     wxColour GetLinkColor();
 
 214     void SetLinkColor(const wxColour& clr);
 
 215     wxColour GetActualColor();
 
 216     void SetActualColor(const wxColour& clr);
 
 217     void SetLink(const wxString& link);
 
 218     wxFont* CreateCurrentFont();
 
 219     wxHtmlLinkInfo GetLink();
 
 225 //---------------------------------------------------------------------------
 
 228 class wxPyHtmlTagHandler : public wxHtmlTagHandler {
 
 229     DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler);
 
 231     wxPyHtmlTagHandler() : wxHtmlTagHandler() {};
 
 233     wxHtmlParser* GetParser() { return m_Parser; }
 
 234     void ParseInner(const wxHtmlTag& tag) { wxHtmlTagHandler::ParseInner(tag); }
 
 236     DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
 
 237     DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
 
 242 IMPLEMENT_DYNAMIC_CLASS(wxPyHtmlTagHandler, wxHtmlTagHandler);
 
 244 IMP_PYCALLBACK_STRING__pure(wxPyHtmlTagHandler, wxHtmlTagHandler, GetSupportedTags);
 
 245 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
 
 249 %name(wxHtmlTagHandler) class wxPyHtmlTagHandler : public wxObject {
 
 251     wxPyHtmlTagHandler();
 
 253     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 254     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlTagHandler)"
 
 256     void SetParser(wxHtmlParser *parser);
 
 257     wxHtmlParser* GetParser();
 
 258     void ParseInner(const wxHtmlTag& tag);
 
 262 //---------------------------------------------------------------------------
 
 265 class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler {
 
 266     DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler);
 
 268     wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {};
 
 270     wxHtmlWinParser* GetParser() { return m_WParser; }
 
 271     void ParseInner(const wxHtmlTag& tag)
 
 272         { wxHtmlWinTagHandler::ParseInner(tag); }
 
 274     DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
 
 275     DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
 
 280 IMPLEMENT_DYNAMIC_CLASS( wxPyHtmlWinTagHandler, wxHtmlWinTagHandler);
 
 282 IMP_PYCALLBACK_STRING__pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, GetSupportedTags);
 
 283 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleTag);
 
 287 %name(wxHtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
 
 289     wxPyHtmlWinTagHandler();
 
 291     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 292     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWinTagHandler)"
 
 294     void SetParser(wxHtmlParser *parser);
 
 295     wxHtmlWinParser* GetParser();
 
 296     void ParseInner(const wxHtmlTag& tag);
 
 300 //---------------------------------------------------------------------------
 
 304 class wxPyHtmlTagsModule : public wxHtmlTagsModule {
 
 306     wxPyHtmlTagsModule(PyObject* thc) : wxHtmlTagsModule() {
 
 307         m_tagHandlerClass = thc;
 
 308         Py_INCREF(m_tagHandlerClass);
 
 309         RegisterModule(this);
 
 310         wxHtmlWinParser::AddModule(this);
 
 314         wxPyBeginBlockThreads();
 
 315         Py_DECREF(m_tagHandlerClass);
 
 316         m_tagHandlerClass = NULL;
 
 317         for (size_t x=0; x < m_objArray.GetCount(); x++) {
 
 318             PyObject* obj = (PyObject*)m_objArray.Item(x);
 
 321         wxPyEndBlockThreads();
 
 324     void FillHandlersTable(wxHtmlWinParser *parser) {
 
 325         // Wave our magic wand...  (if it works it's a miracle!  ;-)
 
 327         // First, make a new instance of the tag handler
 
 328         wxPyBeginBlockThreads();
 
 329         PyObject* arg = Py_BuildValue("()");
 
 330         PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL);
 
 332         wxPyEndBlockThreads();
 
 334         // now figure out where it's C++ object is...
 
 335         wxPyHtmlWinTagHandler* thPtr;
 
 336         if (SWIG_GetPtrObj(obj, (void **)&thPtr, "_wxPyHtmlWinTagHandler_p"))
 
 340         parser->AddTagHandler(thPtr);
 
 347     PyObject*           m_tagHandlerClass;
 
 348     wxArrayPtrVoid      m_objArray;
 
 356     void wxHtmlWinParser_AddTagHandler(PyObject* tagHandlerClass) {
 
 357         // Dynamically create a new wxModule.  Refcounts tagHandlerClass
 
 358         // and adds itself to the wxModules list and to the wxHtmlWinParser.
 
 359         new wxPyHtmlTagsModule(tagHandlerClass);
 
 364 //---------------------------------------------------------------------------
 
 365 //---------------------------------------------------------------------------
 
 367 class wxHtmlCell : public wxObject {
 
 376     wxHtmlLinkInfo* GetLink(int x = 0, int y = 0);
 
 377     wxHtmlCell* GetNext();
 
 378     wxHtmlContainerCell* GetParent();
 
 379     void SetLink(const wxHtmlLinkInfo& link);
 
 380     void SetNext(wxHtmlCell *cell);
 
 381     void SetParent(wxHtmlContainerCell *p);
 
 382     void SetPos(int x, int y);
 
 384     void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
 
 385     void DrawInvisible(wxDC& dc, int x, int y);
 
 386     const wxHtmlCell* Find(int condition, const void* param);
 
 388     bool AdjustPagebreak(int * pagebreak);
 
 389     void SetCanLiveOnPagebreak(bool can);
 
 394 class  wxHtmlWordCell : public wxHtmlCell
 
 397     wxHtmlWordCell(const wxString& word, wxDC& dc);
 
 401 class wxHtmlContainerCell : public wxHtmlCell {
 
 403     wxHtmlContainerCell(wxHtmlContainerCell *parent);
 
 405     void InsertCell(wxHtmlCell *cell);
 
 406     void SetAlignHor(int al);
 
 408     void SetAlignVer(int al);
 
 410     void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
 
 411     int GetIndent(int ind);
 
 412     int GetIndentUnits(int ind);
 
 413     void SetAlign(const wxHtmlTag& tag);
 
 414     void SetWidthFloat(int w, int units);
 
 415     %name(SetWidthFloatFromTag)void SetWidthFloat(const wxHtmlTag& tag);
 
 416     void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP);
 
 417     void SetBackgroundColour(const wxColour& clr);
 
 418     void SetBorder(const wxColour& clr1, const wxColour& clr2);
 
 419     wxHtmlCell* GetFirstCell();
 
 424 class wxHtmlColourCell : public wxHtmlCell {
 
 426     wxHtmlColourCell(wxColour clr, int flags = wxHTML_CLR_FOREGROUND);
 
 431 class  wxHtmlFontCell : public wxHtmlCell
 
 434     wxHtmlFontCell(wxFont *font);
 
 438 class wxHtmlWidgetCell : public wxHtmlCell {
 
 440     wxHtmlWidgetCell(wxWindow* wnd, int w = 0);
 
 446 //---------------------------------------------------------------------------
 
 447 //---------------------------------------------------------------------------
 
 448 //---------------------------------------------------------------------------
 
 451 class wxPyHtmlWindow : public wxHtmlWindow {
 
 452     DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow);
 
 454     wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1,
 
 455                    const wxPoint& pos = wxDefaultPosition,
 
 456                    const wxSize& size = wxDefaultSize,
 
 457                    long style = wxHW_SCROLLBAR_AUTO,
 
 458                    const wxString& name = "htmlWindow")
 
 459         : wxHtmlWindow(parent, id, pos, size, style, name)  {};
 
 460     wxPyHtmlWindow() : wxHtmlWindow() {};
 
 462     bool ScrollToAnchor(const wxString& anchor) {
 
 463         return wxHtmlWindow::ScrollToAnchor(anchor);
 
 466     bool HasAnchor(const wxString& anchor) {
 
 467         const wxHtmlCell *c = m_Cell->Find(wxHTML_COND_ISANCHOR, &anchor);
 
 471     void OnLinkClicked(const wxHtmlLinkInfo& link);
 
 472     void base_OnLinkClicked(const wxHtmlLinkInfo& link);
 
 474     wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
 
 476                                       wxString *redirect) const;
 
 478     DEC_PYCALLBACK__STRING(OnSetTitle);
 
 479     DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover);
 
 480     DEC_PYCALLBACK__CELLINTINTME(OnCellClicked);
 
 481 //     DEC_PYCALLBACK_BOOL_STRING(OnOpeningURL);
 
 485 IMPLEMENT_ABSTRACT_CLASS( wxPyHtmlWindow, wxHtmlWindow );
 
 486 IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle);
 
 487 IMP_PYCALLBACK__CELLINTINT(wxPyHtmlWindow, wxHtmlWindow, OnCellMouseHover);
 
 488 IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked);
 
 489 // IMP_PYCALLBACK_BOOL_STRING(wxPyHtmlWindow, wxHtmlWindow, OnOpeningURL);
 
 492 void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
 
 494     wxPyBeginBlockThreads();
 
 495     if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) {
 
 496         PyObject* obj = wxPyConstructObject((void*)&link, "wxHtmlLinkInfo", 0);
 
 497         wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
 
 500     wxPyEndBlockThreads();
 
 502         wxHtmlWindow::OnLinkClicked(link);
 
 504 void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) {
 
 505     wxHtmlWindow::OnLinkClicked(link);
 
 509 wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
 
 511                                                  wxString *redirect) const {
 
 513     wxHtmlOpeningStatus rval;
 
 514     wxPyBeginBlockThreads();
 
 515     if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
 
 517         ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iO)", type, wx2PyString(url)));
 
 518         if (PyString_Check(ro)
 
 519 #if PYTHON_API_VERSION >= 1009
 
 520             || PyUnicode_Check(ro)
 
 523             *redirect = Py2wxString(ro);
 
 524             rval = wxHTML_REDIRECT;
 
 527             PyObject* num = PyNumber_Int(ro);
 
 528             rval = (wxHtmlOpeningStatus)PyInt_AsLong(num);
 
 533     wxPyEndBlockThreads();
 
 535         rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
 
 544 %name(wxHtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
 
 546     wxPyHtmlWindow(wxWindow *parent, int id = -1,
 
 547                  wxPoint& pos = wxDefaultPosition,
 
 548                  wxSize& size = wxDefaultSize,
 
 549                  int style=wxHW_SCROLLBAR_AUTO,
 
 550                  const wxString& name = wxPyHtmlWindowNameStr);
 
 551     %name(wxPreHtmlWindow)wxPyHtmlWindow();
 
 553     bool Create(wxWindow *parent, int id = -1,
 
 554                 wxPoint& pos = wxDefaultPosition,
 
 555                 wxSize& size = wxDefaultSize,
 
 556                 int style=wxHW_SCROLLBAR_AUTO,
 
 557                 const wxString& name = wxPyHtmlWindowNameStr);
 
 560     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 561     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWindow)"
 
 562     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 
 563     %pragma(python) addtomethod = "wxPreHtmlWindow:val._setOORInfo(val)"
 
 565     bool SetPage(const wxString& source);
 
 566     bool LoadPage(const wxString& location);
 
 567     bool AppendToPage(const wxString& source);
 
 568     wxString GetOpenedPage();
 
 569     wxString GetOpenedAnchor();
 
 570     wxString GetOpenedPageTitle();
 
 572     void SetRelatedFrame(wxFrame* frame, const wxString& format);
 
 573     wxFrame* GetRelatedFrame();
 
 574     void SetRelatedStatusBar(int bar);
 
 576     //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
 
 578         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
 
 579             int* temp = int_LIST_helper(sizes);
 
 581                 self->SetFonts(normal_face, fixed_face, temp);
 
 587     void SetTitle(const wxString& title);
 
 588     void SetBorders(int b);
 
 589     void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
 
 590     void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
 
 592     bool HistoryForward();
 
 593     bool HistoryCanBack();
 
 594     bool HistoryCanForward();
 
 596     wxHtmlContainerCell* GetInternalRepresentation();
 
 597     wxHtmlWinParser* GetParser();
 
 599     bool ScrollToAnchor(const wxString& anchor);
 
 600     bool HasAnchor(const wxString& anchor);
 
 602     void base_OnLinkClicked(const wxHtmlLinkInfo& link);
 
 603     void base_OnSetTitle(const wxString& title);
 
 604     void base_OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
 
 605     void base_OnCellClicked(wxHtmlCell *cell,
 
 606                             wxCoord x, wxCoord y,
 
 607                             const wxMouseEvent& event);
 
 610 // Static methods are mapped to stand-alone functions
 
 612     void wxHtmlWindow_AddFilter(wxHtmlFilter *filter) {
 
 613         wxHtmlWindow::AddFilter(filter);
 
 618 //---------------------------------------------------------------------------
 
 619 //---------------------------------------------------------------------------
 
 622 class wxHtmlDCRenderer : public wxObject {
 
 627     void SetDC(wxDC *dc, int maxwidth);
 
 628     void SetSize(int width, int height);
 
 629     void SetHtmlText(const wxString& html,
 
 630                      const wxString& basepath = wxPyEmptyString,
 
 632     int Render(int x, int y, int from = 0, int dont_render = FALSE);
 
 633     int GetTotalHeight();
 
 634                 // returns total height of the html document
 
 635                 // (compare Render's return value with this)
 
 645 class wxHtmlPrintout : public wxPyPrintout {
 
 647     wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr);
 
 648     //~wxHtmlPrintout();   wxPrintPreview object takes ownership...
 
 650     void SetHtmlText(const wxString& html,
 
 651                      const wxString &basepath = wxPyEmptyString,
 
 653     void SetHtmlFile(const wxString &htmlfile);
 
 654     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 
 655     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 
 656     void SetMargins(float top = 25.2, float bottom = 25.2,
 
 657                     float left = 25.2, float right = 25.2,
 
 663 class wxHtmlEasyPrinting : public wxObject {
 
 665     wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr,
 
 666                        wxFrame *parent_frame = NULL);
 
 667     ~wxHtmlEasyPrinting();
 
 669     void PreviewFile(const wxString &htmlfile);
 
 670     void PreviewText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
 
 671     void PrintFile(const wxString &htmlfile);
 
 672     void PrintText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
 
 675     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 
 676     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 
 678     wxPrintData *GetPrintData() {return m_PrintData;}
 
 679     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
 
 685 //---------------------------------------------------------------------------
 
 686 //---------------------------------------------------------------------------
 
 689     extern "C" SWIGEXPORT(void) inithtmlhelpc();
 
 697     wxClassInfo::CleanUpClasses();
 
 698     wxClassInfo::InitializeClasses();
 
 700     wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
 
 701     wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler");
 
 702     wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow");
 
 705 //----------------------------------------------------------------------
 
 706 // And this gets appended to the shadow class file.
 
 707 //----------------------------------------------------------------------
 
 709 %pragma(python) include="_htmlextras.py";
 
 711 //---------------------------------------------------------------------------