wxPython/src/html.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        html.i
   3 // Purpose:     SWIG definitions of html classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     25-Nov-1998
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 %define DOCSTRING
  14 "Classes for a simple HTML rendering window, HTML Help Window, etc."
  15 %enddef
  16
  17 %module(package="wx", docstring=DOCSTRING) html
  18
  19 %{
  20 #include "wx/wxPython/wxPython.h"
  21 #include "wx/wxPython/pyclasses.h"
  22 #include "wx/wxPython/pyistream.h"
  23 #include "wx/wxPython/printfw.h"
  24
  25 #include <wx/html/htmlwin.h>
  26 #include <wx/html/htmprint.h>
  27 #include <wx/html/helpctrl.h>
  28
  29 %}
  30
  31
  32 //---------------------------------------------------------------------------
  33
  34 %import windows.i
  35 %pythoncode { wx = _core }
  36 %pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
  37
  38 %include _html_rename.i
  39
  40
  41 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
  42 MAKE_CONST_WXSTRING2(HtmlWindowNameStr,    wxT("htmlWindow"))
  43 MAKE_CONST_WXSTRING2(HtmlPrintoutTitleStr, wxT("Printout"))
  44 MAKE_CONST_WXSTRING2(HtmlPrintingTitleStr, wxT("Printing"))
  45
  46
  47 // TODO: Split this file into multiple %included files that coresponds to the
  48 // wx/html include files (more or less.)
  49
  50 //---------------------------------------------------------------------------
  51 //---------------------------------------------------------------------------
  52 %newgroup
  53
  54
  55 enum {
  56     wxHTML_ALIGN_LEFT,
  57     wxHTML_ALIGN_CENTER,
  58     wxHTML_ALIGN_RIGHT,
  59     wxHTML_ALIGN_BOTTOM,
  60     wxHTML_ALIGN_TOP,
  61
  62     wxHTML_CLR_FOREGROUND,
  63     wxHTML_CLR_BACKGROUND,
  64
  65     wxHTML_UNITS_PIXELS,
  66     wxHTML_UNITS_PERCENT,
  67
  68     wxHTML_INDENT_LEFT,
  69     wxHTML_INDENT_RIGHT,
  70     wxHTML_INDENT_TOP,
  71     wxHTML_INDENT_BOTTOM,
  72
  73     wxHTML_INDENT_HORIZONTAL,
  74     wxHTML_INDENT_VERTICAL,
  75     wxHTML_INDENT_ALL,
  76
  77     wxHTML_COND_ISANCHOR,
  78     wxHTML_COND_ISIMAGEMAP,
  79     wxHTML_COND_USER,
  80
  81
  82     wxHTML_FONT_SIZE_1,
  83     wxHTML_FONT_SIZE_2,
  84     wxHTML_FONT_SIZE_3,
  85     wxHTML_FONT_SIZE_4,
  86     wxHTML_FONT_SIZE_5,
  87     wxHTML_FONT_SIZE_6,
  88     wxHTML_FONT_SIZE_7,
  89 };
  90
  91
  92 enum {
  93     wxHW_SCROLLBAR_NEVER,
  94     wxHW_SCROLLBAR_AUTO,
  95     wxHW_NO_SELECTION,
  96     wxHW_DEFAULT_STYLE,
  97 };
  98
  99
 100 // enums for wxHtmlWindow::OnOpeningURL
 101 enum wxHtmlOpeningStatus
 102 {
 103     wxHTML_OPEN,
 104     wxHTML_BLOCK,
 105     wxHTML_REDIRECT
 106 };
 107
 108 enum wxHtmlURLType
 109 {
 110     wxHTML_URL_PAGE,
 111     wxHTML_URL_IMAGE,
 112     wxHTML_URL_OTHER
 113 };
 114
 115
 116
 117 //---------------------------------------------------------------------------
 118
 119 class wxHtmlLinkInfo : public wxObject {
 120 public:
 121     wxHtmlLinkInfo(const wxString& href, const wxString& target = wxPyEmptyString);
 122     wxString GetHref();
 123     wxString GetTarget();
 124     wxMouseEvent* GetEvent();
 125     wxHtmlCell* GetHtmlCell();
 126
 127     void SetEvent(const wxMouseEvent *e);
 128     void SetHtmlCell(const wxHtmlCell * e);
 129 };
 130
 131 //---------------------------------------------------------------------------
 132
 133 class wxHtmlTag : public wxObject {
 134 public:
 135     // Never need to create a new tag from Python...
 136     //wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache);
 137
 138     wxString GetName();
 139     bool HasParam(const wxString& par);
 140     wxString GetParam(const wxString& par, int with_commas = false);
 141
 142     // Can't do this one as-is, but GetParam should be enough...
 143     //int ScanParam(const wxString& par, const char *format, void* param);
 144
 145     wxString GetAllParams();
 146     bool HasEnding();
 147     int GetBeginPos();
 148     int GetEndPos1();
 149     int GetEndPos2();
 150 };
 151
 152 //---------------------------------------------------------------------------
 153
 154 class wxHtmlParser : public wxObject {
 155 public:
 156     // wxHtmlParser();  This is an abstract base class...
 157
 158     void SetFS(wxFileSystem *fs);
 159     wxFileSystem* GetFS();
 160     wxObject* Parse(const wxString& source);
 161     void InitParser(const wxString& source);
 162     void DoneParser();
 163     void DoParsing(int begin_pos, int end_pos);
 164     void StopParsing();
 165     // wxObject* GetProduct();
 166
 167     void AddTagHandler(wxHtmlTagHandler *handler);
 168     wxString* GetSource();
 169     void PushTagHandler(wxHtmlTagHandler* handler, wxString tags);
 170     void PopTagHandler();
 171
 172     // virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const;
 173
 174     // void AddText(const char* txt) = 0;
 175     // void AddTag(const wxHtmlTag& tag);
 176 };
 177
 178
 179 //---------------------------------------------------------------------------
 180
 181 class wxHtmlWinParser : public wxHtmlParser {
 182 public:
 183     wxHtmlWinParser(wxPyHtmlWindow *wnd = NULL);
 184
 185     void SetDC(wxDC *dc);
 186     wxDC* GetDC();
 187     int GetCharHeight();
 188     int GetCharWidth();
 189     wxPyHtmlWindow* GetWindow();
 190
 191     // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
 192     %extend {
 193         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
 194             int* temp = NULL;
 195             if (sizes) temp = int_LIST_helper(sizes);
 196             self->SetFonts(normal_face, fixed_face, temp);
 197             if (temp)
 198                 delete [] temp;
 199         }
 200     }
 201
 202     // Sets font sizes to be relative to the given size or the system
 203     // default size; use either specified or default font
 204     void SetStandardFonts(int size = -1,
 205                           const wxString& normal_face = wxPyEmptyString,
 206                           const wxString& fixed_face = wxPyEmptyString);
 207
 208
 209     wxHtmlContainerCell* GetContainer();
 210     wxHtmlContainerCell* OpenContainer();
 211     wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);
 212     wxHtmlContainerCell* CloseContainer();
 213
 214     int GetFontSize();
 215     void SetFontSize(int s);
 216     int GetFontBold();
 217     void SetFontBold(int x);
 218     int GetFontItalic();
 219     void SetFontItalic(int x);
 220     int GetFontUnderlined();
 221     void SetFontUnderlined(int x);
 222     int GetFontFixed();
 223     void SetFontFixed(int x);
 224     int GetAlign();
 225     void SetAlign(int a);
 226     wxColour GetLinkColor();
 227     void SetLinkColor(const wxColour& clr);
 228     wxColour GetActualColor();
 229     void SetActualColor(const wxColour& clr);
 230     %pythoncode {
 231         GetActualColour = GetActualColor
 232         SetActualColour = SetActualColor
 233     }
 234     void SetLink(const wxString& link);
 235     wxFont* CreateCurrentFont();
 236     wxHtmlLinkInfo GetLink();
 237
 238 };
 239
 240
 241 //---------------------------------------------------------------------------
 242
 243 %{
 244 class wxPyHtmlTagHandler : public wxHtmlTagHandler {
 245     DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler);
 246 public:
 247     wxPyHtmlTagHandler() : wxHtmlTagHandler() {};
 248
 249     wxHtmlParser* GetParser() { return m_Parser; }
 250     void ParseInner(const wxHtmlTag& tag) { wxHtmlTagHandler::ParseInner(tag); }
 251
 252     DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
 253     DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
 254
 255     PYPRIVATE;
 256 };
 257
 258 IMPLEMENT_DYNAMIC_CLASS(wxPyHtmlTagHandler, wxHtmlTagHandler);
 259
 260 IMP_PYCALLBACK_STRING__pure(wxPyHtmlTagHandler, wxHtmlTagHandler, GetSupportedTags);
 261 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
 262 %}
 263
 264
 265 %rename(HtmlTagHandler) wxPyHtmlTagHandler;
 266 class wxPyHtmlTagHandler : public wxObject {
 267 public:
 268     %pythonAppend wxPyHtmlTagHandler   "self._setCallbackInfo(self, HtmlTagHandler)"
 269     wxPyHtmlTagHandler();
 270
 271     void _setCallbackInfo(PyObject* self, PyObject* _class);
 272
 273     void SetParser(wxHtmlParser *parser);
 274     wxHtmlParser* GetParser();
 275     void ParseInner(const wxHtmlTag& tag);
 276 };
 277
 278
 279 //---------------------------------------------------------------------------
 280
 281 %{
 282 class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler {
 283     DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler);
 284 public:
 285     wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {};
 286
 287     wxHtmlWinParser* GetParser() { return m_WParser; }
 288     void ParseInner(const wxHtmlTag& tag)
 289         { wxHtmlWinTagHandler::ParseInner(tag); }
 290
 291     DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
 292     DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
 293
 294     PYPRIVATE;
 295 };
 296
 297 IMPLEMENT_DYNAMIC_CLASS( wxPyHtmlWinTagHandler, wxHtmlWinTagHandler);
 298
 299 IMP_PYCALLBACK_STRING__pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, GetSupportedTags);
 300 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleTag);
 301 %}
 302
 303
 304 %rename(HtmlWinTagHandler) wxPyHtmlWinTagHandler;
 305 class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
 306 public:
 307     %pythonAppend wxPyHtmlWinTagHandler    "self._setCallbackInfo(self, HtmlWinTagHandler)"
 308     wxPyHtmlWinTagHandler();
 309
 310     void _setCallbackInfo(PyObject* self, PyObject* _class);
 311
 312     void SetParser(wxHtmlParser *parser);
 313     wxHtmlWinParser* GetParser();
 314     void ParseInner(const wxHtmlTag& tag);
 315 };
 316
 317
 318 //---------------------------------------------------------------------------
 319
 320 %{
 321
 322 class wxPyHtmlTagsModule : public wxHtmlTagsModule {
 323 public:
 324     wxPyHtmlTagsModule(PyObject* thc) : wxHtmlTagsModule() {
 325         m_tagHandlerClass = thc;
 326         Py_INCREF(m_tagHandlerClass);
 327         RegisterModule(this);
 328         wxHtmlWinParser::AddModule(this);
 329     }
 330
 331     void OnExit() {
 332         wxPyBlock_t blocked = wxPyBeginBlockThreads();
 333         Py_DECREF(m_tagHandlerClass);
 334         m_tagHandlerClass = NULL;
 335         for (size_t x=0; x < m_objArray.GetCount(); x++) {
 336             PyObject* obj = (PyObject*)m_objArray.Item(x);
 337             Py_DECREF(obj);
 338         }
 339         wxPyEndBlockThreads(blocked);
 340     };
 341
 342     void FillHandlersTable(wxHtmlWinParser *parser) {
 343         // Wave our magic wand...  (if it works it's a miracle!  ;-)
 344
 345         // First, make a new instance of the tag handler
 346         wxPyBlock_t blocked = wxPyBeginBlockThreads();
 347         PyObject* arg = PyTuple_New(0);
 348         PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg);
 349         Py_DECREF(arg);
 350
 351         // now figure out where it's C++ object is...
 352         wxPyHtmlWinTagHandler* thPtr;
 353         if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler"))) {
 354             wxPyEndBlockThreads(blocked);
 355             return;
 356         }
 357         wxPyEndBlockThreads(blocked);
 358
 359         // add it,
 360         parser->AddTagHandler(thPtr);
 361
 362         // and track it.
 363         m_objArray.Add(obj);
 364     }
 365
 366 private:
 367     PyObject*           m_tagHandlerClass;
 368     wxArrayPtrVoid      m_objArray;
 369
 370 };
 371 %}
 372
 373
 374
 375 %inline %{
 376     void wxHtmlWinParser_AddTagHandler(PyObject* tagHandlerClass) {
 377         // Dynamically create a new wxModule.  Refcounts tagHandlerClass
 378         // and adds itself to the wxModules list and to the wxHtmlWinParser.
 379         new wxPyHtmlTagsModule(tagHandlerClass);
 380     }
 381 %}
 382
 383
 384 //---------------------------------------------------------------------------
 385 //---------------------------------------------------------------------------
 386 %newgroup
 387
 388
 389 // wxHtmlSelection is data holder with information about text selection.
 390 // Selection is defined by two positions (beginning and end of the selection)
 391 // and two leaf(!) cells at these positions.
 392 class wxHtmlSelection
 393 {
 394 public:
 395     wxHtmlSelection();
 396     ~wxHtmlSelection();
 397
 398     void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell,
 399              const wxPoint& toPos, const wxHtmlCell *toCell);
 400     %Rename(SetCells, void, Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell));
 401
 402     const wxHtmlCell *GetFromCell() const;
 403     const wxHtmlCell *GetToCell() const;
 404
 405     // these values are in absolute coordinates:
 406     const wxPoint& GetFromPos() const;
 407     const wxPoint& GetToPos() const;
 408
 409     // these are From/ToCell's private data
 410     const wxPoint& GetFromPrivPos() const;
 411     const wxPoint& GetToPrivPos() const;
 412     void SetFromPrivPos(const wxPoint& pos);
 413     void SetToPrivPos(const wxPoint& pos);
 414     void ClearPrivPos();
 415
 416     const bool IsEmpty() const;
 417
 418 };
 419
 420
 421 enum wxHtmlSelectionState
 422 {
 423     wxHTML_SEL_OUT,     // currently rendered cell is outside the selection
 424     wxHTML_SEL_IN,      // ... is inside selection
 425     wxHTML_SEL_CHANGING // ... is the cell on which selection state changes
 426 };
 427
 428
 429
 430 // Selection state is passed to wxHtmlCell::Draw so that it can render itself
 431 // differently e.g. when inside text selection or outside it.
 432 class wxHtmlRenderingState
 433 {
 434 public:
 435     wxHtmlRenderingState();
 436     ~wxHtmlRenderingState();
 437
 438     void SetSelectionState(wxHtmlSelectionState s);
 439     wxHtmlSelectionState GetSelectionState() const;
 440
 441     void SetFgColour(const wxColour& c);
 442     const wxColour& GetFgColour() const;
 443     void SetBgColour(const wxColour& c);
 444     const wxColour& GetBgColour() const;
 445 };
 446
 447
 448
 449 // HTML rendering customization. This class is used when rendering wxHtmlCells
 450 // as a callback:
 451 class wxHtmlRenderingStyle
 452 {
 453 public:
 454     virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
 455     virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
 456 };
 457
 458 // Standard style:
 459 class wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle
 460 {
 461 public:
 462     virtual wxColour GetSelectedTextColour(const wxColour& clr);
 463     virtual wxColour GetSelectedTextBgColour(const wxColour& clr);
 464 };
 465
 466
 467
 468 // Information given to cells when drawing them. Contains rendering state,
 469 // selection information and rendering style object that can be used to
 470 // customize the output.
 471 class wxHtmlRenderingInfo
 472 {
 473 public:
 474     wxHtmlRenderingInfo();
 475     ~wxHtmlRenderingInfo();
 476
 477     void SetSelection(wxHtmlSelection *s);
 478     wxHtmlSelection *GetSelection() const;
 479
 480     void SetStyle(wxHtmlRenderingStyle *style);
 481     wxHtmlRenderingStyle& GetStyle();
 482
 483     wxHtmlRenderingState& GetState();
 484 };
 485
 486 //---------------------------------------------------------------------------
 487 %newgroup
 488
 489
 490 enum
 491 {
 492     wxHTML_FIND_EXACT             = 1,
 493     wxHTML_FIND_NEAREST_BEFORE    = 2,
 494     wxHTML_FIND_NEAREST_AFTER     = 4
 495 };
 496
 497
 498 class wxHtmlCell : public wxObject {
 499 public:
 500     wxHtmlCell();
 501
 502     int GetPosX();
 503     int GetPosY();
 504     int GetWidth();
 505     int GetHeight();
 506     int GetDescent();
 507
 508     // Returns the maximum possible length of the cell.
 509     // Call Layout at least once before using GetMaxTotalWidth()
 510     int GetMaxTotalWidth() const;
 511
 512     const wxString& GetId() const;
 513     void SetId(const wxString& id);
 514     wxHtmlLinkInfo* GetLink(int x = 0, int y = 0);
 515     wxHtmlCell* GetNext();
 516     wxHtmlContainerCell* GetParent();
 517     wxHtmlCell* GetFirstChild() const;
 518
 519     // Returns cursor to be used when mouse is over the cell:
 520     wxCursor GetCursor() const;
 521
 522     // Formatting cells are not visible on the screen, they only alter
 523     // renderer's state.
 524     bool IsFormattingCell() const;
 525
 526
 527     void SetLink(const wxHtmlLinkInfo& link);
 528     void SetNext(wxHtmlCell *cell);
 529     void SetParent(wxHtmlContainerCell *p);
 530     void SetPos(int x, int y);
 531     void Layout(int w);
 532     void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
 533               wxHtmlRenderingInfo& info);
 534     void DrawInvisible(wxDC& dc, int x, int y,
 535               wxHtmlRenderingInfo& info);
 536     const wxHtmlCell* Find(int condition, const void* param);
 537
 538     bool AdjustPagebreak(int* INOUT);
 539     void SetCanLiveOnPagebreak(bool can);
 540
 541     // Can the line be broken before this cell?
 542     bool IsLinebreakAllowed() const;
 543
 544     // Returns True for simple == terminal cells, i.e. not composite ones.
 545     // This if for internal usage only and may disappear in future versions!
 546     bool IsTerminalCell() const;
 547
 548     // Find a cell inside this cell positioned at the given coordinates
 549     // (relative to this's positions). Returns NULL if no such cell exists.
 550     // The flag can be used to specify whether to look for terminal or
 551     // nonterminal cells or both. In either case, returned cell is deepest
 552     // cell in cells tree that contains [x,y].
 553     wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
 554                                   unsigned flags = wxHTML_FIND_EXACT) const;
 555
 556     // Returns absolute position of the cell on HTML canvas
 557     wxPoint GetAbsPos() const;
 558
 559     // Returns first (last) terminal cell inside this cell. It may return NULL,
 560     // but it is rare -- only if there are no terminals in the tree.
 561     wxHtmlCell *GetFirstTerminal() const ;
 562     wxHtmlCell *GetLastTerminal() const ;
 563
 564     // Returns cell's depth, i.e. how far under the root cell it is
 565     // (if it is the root, depth is 0)
 566     unsigned GetDepth() const;
 567
 568     // Returns True if the cell appears before 'cell' in natural order of
 569     // cells (= as they are read). If cell A is (grand)parent of cell B,
 570     // then both A.IsBefore(B) and B.IsBefore(A) always return True.
 571     bool IsBefore(wxHtmlCell *cell) const;
 572
 573     // Converts the cell into text representation. If sel != NULL then
 574     // only part of the cell inside the selection is converted.
 575     wxString ConvertToText(wxHtmlSelection *sel) const;
 576 };
 577
 578
 579 class  wxHtmlWordCell : public wxHtmlCell
 580 {
 581 public:
 582     wxHtmlWordCell(const wxString& word, wxDC& dc);
 583 };
 584
 585
 586 class wxHtmlContainerCell : public wxHtmlCell {
 587 public:
 588     wxHtmlContainerCell(wxHtmlContainerCell *parent);
 589
 590     void InsertCell(wxHtmlCell *cell);
 591     void SetAlignHor(int al);
 592     int GetAlignHor();
 593     void SetAlignVer(int al);
 594     int GetAlignVer();
 595     void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
 596     int GetIndent(int ind);
 597     int GetIndentUnits(int ind);
 598     void SetAlign(const wxHtmlTag& tag);
 599     void SetWidthFloat(int w, int units);
 600     %Rename(SetWidthFloatFromTag, void,  SetWidthFloat(const wxHtmlTag& tag));
 601     void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP);
 602     void SetBackgroundColour(const wxColour& clr);
 603     wxColour GetBackgroundColour();
 604     void SetBorder(const wxColour& clr1, const wxColour& clr2);
 605     wxHtmlCell* GetFirstChild();
 606     %pragma(python) addtoclass = "GetFirstCell = GetFirstChild"
 607 };
 608
 609
 610
 611 class wxHtmlColourCell : public wxHtmlCell {
 612 public:
 613     wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND);
 614
 615 };
 616
 617
 618 class  wxHtmlFontCell : public wxHtmlCell
 619 {
 620 public:
 621     wxHtmlFontCell(wxFont *font);
 622 };
 623
 624
 625 class wxHtmlWidgetCell : public wxHtmlCell {
 626 public:
 627     wxHtmlWidgetCell(wxWindow* wnd, int w = 0);
 628
 629 };
 630
 631
 632
 633
 634 //---------------------------------------------------------------------------
 635 // wxHtmlFilter
 636 //---------------------------------------------------------------------------
 637 %newgroup
 638
 639
 640 %{ // here's the C++ version
 641 class wxPyHtmlFilter : public wxHtmlFilter {
 642     DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter);
 643 public:
 644     wxPyHtmlFilter() : wxHtmlFilter() {}
 645
 646     // returns True if this filter is able to open&read given file
 647     virtual bool CanRead(const wxFSFile& file) const {
 648         bool rval = false;
 649         bool found;
 650         wxPyBlock_t blocked = wxPyBeginBlockThreads();
 651         if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) {
 652             PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false);  // cast away const
 653             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
 654             Py_DECREF(obj);
 655         }
 656         wxPyEndBlockThreads(blocked);
 657         return rval;
 658     }
 659
 660
 661     // Reads given file and returns HTML document.
 662     // Returns empty string if opening failed
 663     virtual wxString ReadFile(const wxFSFile& file) const {
 664         wxString rval;
 665         bool found;
 666         wxPyBlock_t blocked = wxPyBeginBlockThreads();
 667         if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) {
 668             PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false);  // cast away const
 669             PyObject* ro;
 670             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(O)", obj));
 671             Py_DECREF(obj);
 672             if (ro) {
 673                 rval = Py2wxString(ro);
 674                 Py_DECREF(ro);
 675             }
 676         }
 677         wxPyEndBlockThreads(blocked);
 678         return rval;
 679     }
 680
 681     PYPRIVATE;
 682 };
 683
 684 IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter);
 685 %}
 686
 687
 688 // And now the version seen by SWIG
 689
 690 %rename(HtmlFilter) wxPyHtmlFilter;
 691 class wxPyHtmlFilter : public wxObject {
 692 public:
 693     %pythonAppend wxPyHtmlFilter   "self._setCallbackInfo(self, HtmlFilter)"
 694     wxPyHtmlFilter();
 695
 696     void _setCallbackInfo(PyObject* self, PyObject* _class);
 697 };
 698
 699
 700 // TODO: wxHtmlFilterHTML
 701
 702
 703 //---------------------------------------------------------------------------
 704 // wxHtmlWindow
 705 //---------------------------------------------------------------------------
 706 %newgroup
 707
 708 %{
 709 class wxPyHtmlWindow : public wxHtmlWindow {
 710     DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow);
 711 public:
 712     wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1,
 713                    const wxPoint& pos = wxDefaultPosition,
 714                    const wxSize& size = wxDefaultSize,
 715                    long style = wxHW_DEFAULT_STYLE,
 716                    const wxString& name = wxPyHtmlWindowNameStr)
 717         : wxHtmlWindow(parent, id, pos, size, style, name)  {};
 718     wxPyHtmlWindow() : wxHtmlWindow() {};
 719
 720     bool ScrollToAnchor(const wxString& anchor) {
 721         return wxHtmlWindow::ScrollToAnchor(anchor);
 722     }
 723
 724     bool HasAnchor(const wxString& anchor) {
 725         const wxHtmlCell *c = m_Cell->Find(wxHTML_COND_ISANCHOR, &anchor);
 726         return c!=NULL;
 727     }
 728
 729     void OnLinkClicked(const wxHtmlLinkInfo& link);
 730     void base_OnLinkClicked(const wxHtmlLinkInfo& link);
 731
 732     wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
 733                                       const wxString& url,
 734                                       wxString *redirect) const;
 735
 736     DEC_PYCALLBACK__STRING(OnSetTitle);
 737     DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover);
 738     DEC_PYCALLBACK__CELLINTINTME(OnCellClicked);
 739     PYPRIVATE;
 740 };
 741
 742 IMPLEMENT_ABSTRACT_CLASS( wxPyHtmlWindow, wxHtmlWindow );
 743 IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle);
 744 IMP_PYCALLBACK__CELLINTINT(wxPyHtmlWindow, wxHtmlWindow, OnCellMouseHover);
 745 IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked);
 746
 747
 748 void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
 749     bool found;
 750     wxPyBlock_t blocked = wxPyBeginBlockThreads();
 751     if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) {
 752         PyObject* obj = wxPyConstructObject((void*)&link, wxT("wxHtmlLinkInfo"), 0);
 753         wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
 754         Py_DECREF(obj);
 755     }
 756     wxPyEndBlockThreads(blocked);
 757     if (! found)
 758         wxHtmlWindow::OnLinkClicked(link);
 759 }
 760 void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) {
 761     wxHtmlWindow::OnLinkClicked(link);
 762 }
 763
 764
 765 wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
 766                                                  const wxString& url,
 767                                                  wxString *redirect) const {
 768     bool found;
 769     wxHtmlOpeningStatus rval;
 770     wxPyBlock_t blocked = wxPyBeginBlockThreads();
 771     if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
 772         PyObject* ro;
 773         PyObject* s = wx2PyString(url);
 774         ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iO)", type, s));
 775         Py_DECREF(s);
 776         if (PyString_Check(ro)
 777 #if PYTHON_API_VERSION >= 1009
 778             || PyUnicode_Check(ro)
 779 #endif
 780             ) {
 781             *redirect = Py2wxString(ro);
 782             rval = wxHTML_REDIRECT;
 783         }
 784         else {
 785             PyObject* num = PyNumber_Int(ro);
 786             rval = (wxHtmlOpeningStatus)PyInt_AsLong(num);
 787             Py_DECREF(num);
 788         }
 789         Py_DECREF(ro);
 790     }
 791     wxPyEndBlockThreads(blocked);
 792     if (! found)
 793         rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
 794     return rval;
 795 }
 796
 797
 798 %}
 799
 800
 801
 802 MustHaveApp(wxPyHtmlWindow);
 803
 804 %rename(HtmlWindow) wxPyHtmlWindow;
 805 class wxPyHtmlWindow : public wxScrolledWindow {
 806 public:
 807     %pythonAppend wxPyHtmlWindow      "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)"
 808     %pythonAppend wxPyHtmlWindow()    ""
 809     %typemap(out) wxPyHtmlWindow*;    // turn off this typemap
 810
 811     wxPyHtmlWindow(wxWindow *parent, int id = -1,
 812                  const wxPoint& pos = wxDefaultPosition,
 813                  const wxSize& size = wxDefaultSize,
 814                  int style=wxHW_DEFAULT_STYLE,
 815                  const wxString& name = wxPyHtmlWindowNameStr);
 816     %RenameCtor(PreHtmlWindow, wxPyHtmlWindow());
 817
 818     // Turn it back on again
 819     %typemap(out) wxPyHtmlWindow* { $result = wxPyMake_wxObject($1, $owner); }
 820
 821     bool Create(wxWindow *parent, int id = -1,
 822                 const wxPoint& pos = wxDefaultPosition,
 823                 const wxSize& size = wxDefaultSize,
 824                 int style=wxHW_SCROLLBAR_AUTO,
 825                 const wxString& name = wxPyHtmlWindowNameStr);
 826
 827
 828     void _setCallbackInfo(PyObject* self, PyObject* _class);
 829
 830
 831     // Set HTML page and display it. !! source is HTML document itself,
 832     // it is NOT address/filename of HTML document. If you want to
 833     // specify document location, use LoadPage() istead
 834     // Return value : False if an error occurred, True otherwise
 835     bool SetPage(const wxString& source);
 836
 837     // Load HTML page from given location. Location can be either
 838     // a) /usr/wxGTK2/docs/html/wx.htm
 839     // b) http://www.somewhere.uk/document.htm
 840     // c) ftp://ftp.somesite.cz/pub/something.htm
 841     // In case there is no prefix (http:,ftp:), the method
 842     // will try to find it itself (1. local file, then http or ftp)
 843     // After the page is loaded, the method calls SetPage() to display it.
 844     // Note : you can also use path relative to previously loaded page
 845     // Return value : same as SetPage
 846     bool LoadPage(const wxString& location);
 847
 848     // Loads HTML page from file
 849     bool LoadFile(const wxString& filename);
 850
 851     // Append to current page
 852     bool AppendToPage(const wxString& source);
 853
 854      // Returns full location of opened page
 855     wxString GetOpenedPage();
 856
 857     // Returns anchor within opened page
 858     wxString GetOpenedAnchor();
 859
 860     // Returns <TITLE> of opened page or empty string otherwise
 861     wxString GetOpenedPageTitle();
 862
 863     // Sets frame in which page title will  be displayed. Format is format of
 864     // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
 865     void SetRelatedFrame(wxFrame* frame, const wxString& format);
 866     wxFrame* GetRelatedFrame();
 867
 868     // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
 869     // will be displayed. Default is -1 = no messages.
 870     void SetRelatedStatusBar(int bar);
 871
 872     // Sets fonts to be used when displaying HTML page.
 873     %extend {
 874         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
 875             int* temp = NULL;
 876             if (sizes) temp = int_LIST_helper(sizes);
 877             self->SetFonts(normal_face, fixed_face, temp);
 878             if (temp)
 879                 delete [] temp;
 880         }
 881     }
 882
 883     // Sets font sizes to be relative to the given size or the system
 884     // default size; use either specified or default font
 885     void SetStandardFonts(int size = -1,
 886                           const wxString& normal_face = wxPyEmptyString,
 887                           const wxString& fixed_face = wxPyEmptyString);
 888
 889     DocDeclStr(
 890         void, SetTitle(const wxString& title),
 891         "", "");
 892
 893     // Sets space between text and window borders.
 894     void SetBorders(int b);
 895
 896     // Sets the bitmap to use for background (currnetly it will be tiled,
 897     // when/if we have CSS support we could add other possibilities...)
 898     void SetBackgroundImage(const wxBitmap& bmpBg);
 899
 900     // Saves custom settings into cfg config. it will use the path 'path'
 901     // if given, otherwise it will save info into currently selected path.
 902     // saved values : things set by SetFonts, SetBorders.
 903     void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
 904     void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
 905
 906     // Goes to previous/next page (in browsing history)
 907     // Returns True if successful, False otherwise
 908     bool HistoryBack();
 909     bool HistoryForward();
 910     bool HistoryCanBack();
 911     bool HistoryCanForward();
 912
 913     // Resets History
 914     void HistoryClear();
 915
 916     // Returns pointer to conteiners/cells structure.
 917     wxHtmlContainerCell* GetInternalRepresentation();
 918
 919     // Returns a pointer to the parser.
 920     wxHtmlWinParser* GetParser();
 921
 922     bool ScrollToAnchor(const wxString& anchor);
 923     bool HasAnchor(const wxString& anchor);
 924
 925     //Adds input filter
 926     static void AddFilter(wxPyHtmlFilter *filter);
 927
 928     // Helper functions to select parts of page:
 929     void SelectWord(const wxPoint& pos);
 930     void SelectLine(const wxPoint& pos);
 931     void SelectAll();
 932
 933     // Convert selection to text:
 934     wxString SelectionToText();
 935
 936     // Converts current page to text:
 937     wxString ToText();
 938
 939     void base_OnLinkClicked(const wxHtmlLinkInfo& link);
 940     void base_OnSetTitle(const wxString& title);
 941     void base_OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
 942     void base_OnCellClicked(wxHtmlCell *cell,
 943                             wxCoord x, wxCoord y,
 944                             const wxMouseEvent& event);
 945
 946     static wxVisualAttributes
 947     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 948 };
 949
 950
 951
 952
 953 //---------------------------------------------------------------------------
 954 //---------------------------------------------------------------------------
 955 %newgroup
 956
 957
 958 MustHaveApp(wxHtmlDCRenderer);
 959
 960 class wxHtmlDCRenderer : public wxObject {
 961 public:
 962     wxHtmlDCRenderer();
 963     ~wxHtmlDCRenderer();
 964
 965     void SetDC(wxDC *dc, int maxwidth);
 966     void SetSize(int width, int height);
 967     void SetHtmlText(const wxString& html,
 968                      const wxString& basepath = wxPyEmptyString,
 969                      bool isdir = true);
 970     // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
 971     %extend {
 972         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
 973             int* temp = NULL;
 974             if (sizes) temp = int_LIST_helper(sizes);
 975             self->SetFonts(normal_face, fixed_face, temp);
 976             if (temp)
 977                 delete [] temp;
 978         }
 979     }
 980
 981     // Sets font sizes to be relative to the given size or the system
 982     // default size; use either specified or default font
 983     void SetStandardFonts(int size = -1,
 984                           const wxString& normal_face = wxPyEmptyString,
 985                           const wxString& fixed_face = wxPyEmptyString);
 986
 987     int Render(int x, int y, int from = 0, int dont_render = false, int maxHeight = INT_MAX,
 988                //int *known_pagebreaks = NULL, int number_of_pages = 0
 989                int* choices=NULL, int LCOUNT = 0
 990                );
 991     int GetTotalHeight();
 992                 // returns total height of the html document
 993                 // (compare Render's return value with this)
 994 };
 995
 996
 997 enum {
 998     wxPAGE_ODD,
 999     wxPAGE_EVEN,
1000     wxPAGE_ALL
1001 };
1002
1003
1004 MustHaveApp(wxHtmlPrintout);
1005
1006 class wxHtmlPrintout : public wxPyPrintout {
1007 public:
1008     wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr);
1009     //~wxHtmlPrintout();   wxPrintPreview object takes ownership...
1010
1011     void SetHtmlText(const wxString& html,
1012                      const wxString &basepath = wxPyEmptyString,
1013                      bool isdir = true);
1014     void SetHtmlFile(const wxString &htmlfile);
1015     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
1016     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
1017
1018     // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
1019     %extend {
1020         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
1021             int* temp = NULL;
1022             if (sizes) temp = int_LIST_helper(sizes);
1023             self->SetFonts(normal_face, fixed_face, temp);
1024             if (temp)
1025                 delete [] temp;
1026         }
1027     }
1028
1029     // Sets font sizes to be relative to the given size or the system
1030     // default size; use either specified or default font
1031     void SetStandardFonts(int size = -1,
1032                           const wxString& normal_face = wxPyEmptyString,
1033                           const wxString& fixed_face = wxPyEmptyString);
1034
1035     void SetMargins(float top = 25.2, float bottom = 25.2,
1036                     float left = 25.2, float right = 25.2,
1037                     float spaces = 5);
1038
1039     // Adds input filter
1040     static void AddFilter(wxHtmlFilter *filter);
1041
1042     // Cleanup
1043     static void CleanUpStatics();
1044 };
1045
1046
1047
1048 MustHaveApp(wxHtmlEasyPrinting);
1049
1050 class wxHtmlEasyPrinting : public wxObject {
1051 public:
1052     wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr,
1053                        wxWindow *parentWindow = NULL);
1054     ~wxHtmlEasyPrinting();
1055
1056     void PreviewFile(const wxString &htmlfile);
1057     void PreviewText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
1058     void PrintFile(const wxString &htmlfile);
1059     void PrintText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
1060 //    void PrinterSetup();
1061     void PageSetup();
1062     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
1063     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
1064
1065     %extend {
1066         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
1067             int* temp = NULL;
1068             if (sizes) temp = int_LIST_helper(sizes);
1069             self->SetFonts(normal_face, fixed_face, temp);
1070             if (temp)
1071                 delete [] temp;
1072         }
1073     }
1074
1075     // Sets font sizes to be relative to the given size or the system
1076     // default size; use either specified or default font
1077     void SetStandardFonts(int size = -1,
1078                           const wxString& normal_face = wxPyEmptyString,
1079                           const wxString& fixed_face = wxPyEmptyString);
1080
1081     wxPrintData *GetPrintData() {return m_PrintData;}
1082     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
1083
1084 };
1085
1086
1087 //---------------------------------------------------------------------------
1088 //---------------------------------------------------------------------------
1089 %newgroup
1090
1091
1092 class wxHtmlBookRecord {
1093 public:
1094     wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath,
1095                      const wxString& title, const wxString& start);
1096
1097     wxString GetBookFile();
1098     wxString GetTitle();
1099     wxString GetStart();
1100     wxString GetBasePath();
1101
1102     void SetContentsRange(int start, int end);
1103     int GetContentsStart();
1104     int GetContentsEnd();
1105
1106     void SetTitle(const wxString& title);
1107     void SetBasePath(const wxString& path);
1108     void SetStart(const wxString& start);
1109
1110     wxString GetFullPath(const wxString &page) const;
1111 };
1112
1113 //---------------------------------------------------------------------------
1114
1115 struct wxHtmlContentsItem
1116 {
1117     %extend {
1118         int GetLevel() { return self->m_Level; }
1119         int GetID() { return self->m_ID; }
1120         wxString GetName() { return self->m_Name; }
1121         wxString GetPage() { return self->m_Page; }
1122         wxHtmlBookRecord* GetBook() { return self->m_Book; }
1123     }
1124 };
1125
1126 //---------------------------------------------------------------------------
1127
1128 class wxHtmlSearchStatus
1129 {
1130 public:
1131     //wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
1132     //                   const wxString& book = wxPyEmptyString);
1133     bool Search();
1134     bool IsActive();
1135     int GetCurIndex();
1136     int GetMaxIndex();
1137     const wxString& GetName();
1138     wxHtmlContentsItem* GetContentsItem();
1139 };
1140
1141 //---------------------------------------------------------------------------
1142
1143 class wxHtmlHelpData {
1144 public:
1145     wxHtmlHelpData();
1146     ~wxHtmlHelpData();
1147
1148     void SetTempDir(const wxString& path);
1149     bool AddBook(const wxString& book);
1150 //      bool AddBookParam(const wxString& title, const wxString& contfile,
1151 //                    const wxString& indexfile=wxPyEmptyString,
1152 //                    const wxString& deftopic=wxPyEmptyString,
1153 //                    const wxString& path=wxPyEmptyString);
1154
1155     wxString FindPageByName(const wxString& page);
1156     wxString FindPageById(int id);
1157
1158     // TODO: this one needs fixed...
1159     const wxHtmlBookRecArray& GetBookRecArray();
1160
1161     wxHtmlContentsItem* GetContents();
1162     int GetContentsCnt();
1163     wxHtmlContentsItem* GetIndex();
1164     int GetIndexCnt();
1165 };
1166
1167 //---------------------------------------------------------------------------
1168
1169 MustHaveApp(wxHtmlHelpFrame);
1170
1171 class wxHtmlHelpFrame : public wxFrame {
1172 public:
1173     %pythonAppend wxHtmlHelpFrame    "self._setOORInfo(self)"
1174
1175     wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
1176                     const wxString& title = wxPyEmptyString,
1177                     int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL);
1178
1179     wxHtmlHelpData* GetData();
1180     void SetTitleFormat(const wxString& format);
1181     void Display(const wxString& x);
1182     %Rename(DisplayID,  void,  Display(int id));
1183     void DisplayContents();
1184     void DisplayIndex();
1185     bool KeywordSearch(const wxString& keyword);
1186     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString);
1187     void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
1188     void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
1189 };
1190
1191
1192 //---------------------------------------------------------------------------
1193
1194
1195 enum {
1196     wxHF_TOOLBAR,
1197     wxHF_FLATTOOLBAR,
1198     wxHF_CONTENTS,
1199     wxHF_INDEX,
1200     wxHF_SEARCH,
1201     wxHF_BOOKMARKS,
1202     wxHF_OPENFILES,
1203     wxHF_PRINT,
1204     wxHF_DEFAULTSTYLE,
1205 };
1206
1207
1208 MustHaveApp(wxHtmlHelpController);
1209
1210 class wxHtmlHelpController : public wxObject  // wxHelpControllerBase
1211 {
1212 public:
1213 //    %pythonAppend wxHtmlHelpController "self._setOORInfo(self)"
1214
1215     wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
1216     ~wxHtmlHelpController();
1217
1218     void SetTitleFormat(const wxString& format);
1219     void SetTempDir(const wxString& path);
1220     bool AddBook(const wxString& book, int show_wait_msg = false);
1221     void Display(const wxString& x);
1222     %Rename(DisplayID,  void,  Display(int id));
1223     void DisplayContents();
1224     void DisplayIndex();
1225     bool KeywordSearch(const wxString& keyword);
1226     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString);
1227     void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
1228     void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
1229     wxHtmlHelpFrame* GetFrame();
1230
1231     %pythoncode { def Destroy(self): pass }
1232 };
1233
1234
1235
1236
1237 //---------------------------------------------------------------------------
1238 %init %{
1239     wxPyPtrTypeMap_Add("wxHtmlTagHandler",    "wxPyHtmlTagHandler");
1240     wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler");
1241     wxPyPtrTypeMap_Add("wxHtmlWindow",        "wxPyHtmlWindow");
1242     wxPyPtrTypeMap_Add("wxHtmlFilter",        "wxPyHtmlFilter");
1243 %}
1244 //---------------------------------------------------------------------------
1245 //---------------------------------------------------------------------------
1246
1247
1248