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