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 //---------------------------------------------------------------------------
55 wxHTML_CLR_FOREGROUND,
56 wxHTML_CLR_BACKGROUND,
66 wxHTML_INDENT_HORIZONTAL,
67 wxHTML_INDENT_VERTICAL,
71 wxHTML_COND_ISIMAGEMAP,
82 // enums for wxHtmlWindow::OnOpeningURL
83 enum wxHtmlOpeningStatus
97 //---------------------------------------------------------------------------
99 class wxHtmlLinkInfo : public wxObject {
101 wxHtmlLinkInfo(const wxString& href, const wxString& target = wxEmptyString);
103 wxString GetTarget();
104 wxMouseEvent* GetEvent();
105 wxHtmlCell* GetHtmlCell();
107 void SetEvent(const wxMouseEvent *e);
108 void SetHtmlCell(const wxHtmlCell * e);
111 //---------------------------------------------------------------------------
113 class wxHtmlTag : public wxObject {
115 // Never need to create a new tag from Python...
116 //wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache);
119 bool HasParam(const wxString& par);
120 wxString GetParam(const wxString& par, int with_commas = FALSE);
122 // Can't do this one as-is, but GetParam should be enough...
123 //int ScanParam(const wxString& par, const char *format, void* param);
125 wxString GetAllParams();
133 //---------------------------------------------------------------------------
135 class wxHtmlParser : public wxObject {
137 // wxHtmlParser(); This is an abstract base class...
139 void SetFS(wxFileSystem *fs);
140 wxFileSystem* GetFS();
141 wxObject* Parse(const wxString& source);
142 void InitParser(const wxString& source);
144 void DoParsing(int begin_pos, int end_pos);
145 // wxObject* GetProduct();
146 void AddTagHandler(wxHtmlTagHandler *handler);
147 wxString* GetSource();
148 void PushTagHandler(wxHtmlTagHandler* handler, wxString tags);
149 void PopTagHandler();
151 // virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const;
153 // void AddText(const char* txt) = 0;
154 // void AddTag(const wxHtmlTag& tag);
158 //---------------------------------------------------------------------------
160 class wxHtmlWinParser : public wxHtmlParser {
162 wxHtmlWinParser(wxHtmlWindow *wnd = NULL);
164 void SetDC(wxDC *dc);
168 wxHtmlWindow* GetWindow();
169 //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
171 void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
172 int* temp = int_LIST_helper(sizes);
174 self->SetFonts(normal_face, fixed_face, temp);
180 wxHtmlContainerCell* GetContainer();
181 wxHtmlContainerCell* OpenContainer();
182 wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);
183 wxHtmlContainerCell* CloseContainer();
186 void SetFontSize(int s);
188 void SetFontBold(int x);
190 void SetFontItalic(int x);
191 int GetFontUnderlined();
192 void SetFontUnderlined(int x);
194 void SetFontFixed(int x);
196 void SetAlign(int a);
197 wxColour GetLinkColor();
198 void SetLinkColor(const wxColour& clr);
199 wxColour GetActualColor();
200 void SetActualColor(const wxColour& clr);
201 void SetLink(const wxString& link);
202 wxFont* CreateCurrentFont();
203 wxHtmlLinkInfo GetLink();
209 //---------------------------------------------------------------------------
212 class wxPyHtmlTagHandler : public wxHtmlTagHandler {
213 DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler);
215 wxPyHtmlTagHandler() : wxHtmlTagHandler() {};
217 wxHtmlParser* GetParser() { return m_Parser; }
218 void ParseInner(const wxHtmlTag& tag) { wxHtmlTagHandler::ParseInner(tag); }
220 DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
221 DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
226 IMPLEMENT_DYNAMIC_CLASS(wxPyHtmlTagHandler, wxHtmlTagHandler);
228 IMP_PYCALLBACK_STRING__pure(wxPyHtmlTagHandler, wxHtmlTagHandler, GetSupportedTags);
229 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
233 %name(wxHtmlTagHandler) class wxPyHtmlTagHandler : public wxObject {
235 wxPyHtmlTagHandler();
237 void _setCallbackInfo(PyObject* self, PyObject* _class);
238 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlTagHandler)"
240 void SetParser(wxHtmlParser *parser);
241 wxHtmlParser* GetParser();
242 void ParseInner(const wxHtmlTag& tag);
246 //---------------------------------------------------------------------------
249 class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler {
250 DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler);
252 wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {};
254 wxHtmlWinParser* GetParser() { return m_WParser; }
255 void ParseInner(const wxHtmlTag& tag)
256 { wxHtmlWinTagHandler::ParseInner(tag); }
258 DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
259 DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
264 IMPLEMENT_DYNAMIC_CLASS( wxPyHtmlWinTagHandler, wxHtmlWinTagHandler);
266 IMP_PYCALLBACK_STRING__pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, GetSupportedTags);
267 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleTag);
271 %name(wxHtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
273 wxPyHtmlWinTagHandler();
275 void _setCallbackInfo(PyObject* self, PyObject* _class);
276 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWinTagHandler)"
278 void SetParser(wxHtmlParser *parser);
279 wxHtmlWinParser* GetParser();
280 void ParseInner(const wxHtmlTag& tag);
284 //---------------------------------------------------------------------------
288 class wxPyHtmlTagsModule : public wxHtmlTagsModule {
290 wxPyHtmlTagsModule(PyObject* thc) : wxHtmlTagsModule() {
291 m_tagHandlerClass = thc;
292 Py_INCREF(m_tagHandlerClass);
293 RegisterModule(this);
294 wxHtmlWinParser::AddModule(this);
298 wxPyBeginBlockThreads();
299 Py_DECREF(m_tagHandlerClass);
300 m_tagHandlerClass = NULL;
301 for (size_t x=0; x < m_objArray.GetCount(); x++) {
302 PyObject* obj = (PyObject*)m_objArray.Item(x);
305 wxPyEndBlockThreads();
308 void FillHandlersTable(wxHtmlWinParser *parser) {
309 // Wave our magic wand... (if it works it's a miracle! ;-)
311 // First, make a new instance of the tag handler
312 wxPyBeginBlockThreads();
313 PyObject* arg = Py_BuildValue("()");
314 PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL);
316 wxPyEndBlockThreads();
318 // now figure out where it's C++ object is...
319 wxPyHtmlWinTagHandler* thPtr;
320 if (SWIG_GetPtrObj(obj, (void **)&thPtr, "_wxPyHtmlWinTagHandler_p"))
324 parser->AddTagHandler(thPtr);
331 PyObject* m_tagHandlerClass;
332 wxArrayPtrVoid m_objArray;
340 void wxHtmlWinParser_AddTagHandler(PyObject* tagHandlerClass) {
341 // Dynamically create a new wxModule. Refcounts tagHandlerClass
342 // and adds itself to the wxModules list and to the wxHtmlWinParser.
343 new wxPyHtmlTagsModule(tagHandlerClass);
348 //---------------------------------------------------------------------------
349 //---------------------------------------------------------------------------
351 class wxHtmlCell : public wxObject {
360 wxHtmlLinkInfo* GetLink(int x = 0, int y = 0);
361 wxHtmlCell* GetNext();
362 wxHtmlContainerCell* GetParent();
363 void SetLink(const wxHtmlLinkInfo& link);
364 void SetNext(wxHtmlCell *cell);
365 void SetParent(wxHtmlContainerCell *p);
366 void SetPos(int x, int y);
368 void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
369 void DrawInvisible(wxDC& dc, int x, int y);
370 const wxHtmlCell* Find(int condition, const void* param);
372 bool AdjustPagebreak(int * pagebreak);
373 void SetCanLiveOnPagebreak(bool can);
378 class wxHtmlWordCell : public wxHtmlCell
381 wxHtmlWordCell(const wxString& word, wxDC& dc);
385 class wxHtmlContainerCell : public wxHtmlCell {
387 wxHtmlContainerCell(wxHtmlContainerCell *parent);
389 void InsertCell(wxHtmlCell *cell);
390 void SetAlignHor(int al);
392 void SetAlignVer(int al);
394 void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
395 int GetIndent(int ind);
396 int GetIndentUnits(int ind);
397 void SetAlign(const wxHtmlTag& tag);
398 void SetWidthFloat(int w, int units);
399 %name(SetWidthFloatFromTag)void SetWidthFloat(const wxHtmlTag& tag);
400 void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP);
401 void SetBackgroundColour(const wxColour& clr);
402 void SetBorder(const wxColour& clr1, const wxColour& clr2);
403 wxHtmlCell* GetFirstCell();
408 class wxHtmlColourCell : public wxHtmlCell {
410 wxHtmlColourCell(wxColour clr, int flags = wxHTML_CLR_FOREGROUND);
415 class wxHtmlFontCell : public wxHtmlCell
418 wxHtmlFontCell(wxFont *font);
422 class wxHtmlWidgetCell : public wxHtmlCell {
424 wxHtmlWidgetCell(wxWindow* wnd, int w = 0);
430 //---------------------------------------------------------------------------
431 //---------------------------------------------------------------------------
432 //---------------------------------------------------------------------------
435 class wxPyHtmlWindow : public wxHtmlWindow {
436 DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow);
438 wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1,
439 const wxPoint& pos = wxDefaultPosition,
440 const wxSize& size = wxDefaultSize,
441 long style = wxHW_SCROLLBAR_AUTO,
442 const wxString& name = "htmlWindow")
443 : wxHtmlWindow(parent, id, pos, size, style, name) {};
444 wxPyHtmlWindow() : wxHtmlWindow() {};
446 bool ScrollToAnchor(const wxString& anchor) {
447 return wxHtmlWindow::ScrollToAnchor(anchor);
450 bool HasAnchor(const wxString& anchor) {
451 const wxHtmlCell *c = m_Cell->Find(wxHTML_COND_ISANCHOR, &anchor);
455 void OnLinkClicked(const wxHtmlLinkInfo& link);
456 void base_OnLinkClicked(const wxHtmlLinkInfo& link);
458 wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
460 wxString *redirect) const;
462 DEC_PYCALLBACK__STRING(OnSetTitle);
463 DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover);
464 DEC_PYCALLBACK__CELLINTINTME(OnCellClicked);
465 // DEC_PYCALLBACK_BOOL_STRING(OnOpeningURL);
469 IMPLEMENT_ABSTRACT_CLASS( wxPyHtmlWindow, wxHtmlWindow );
470 IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle);
471 IMP_PYCALLBACK__CELLINTINT(wxPyHtmlWindow, wxHtmlWindow, OnCellMouseHover);
472 IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked);
473 // IMP_PYCALLBACK_BOOL_STRING(wxPyHtmlWindow, wxHtmlWindow, OnOpeningURL);
476 void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
478 wxPyBeginBlockThreads();
479 if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) {
480 PyObject* obj = wxPyConstructObject((void*)&link, "wxHtmlLinkInfo", 0);
481 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
484 wxPyEndBlockThreads();
486 wxHtmlWindow::OnLinkClicked(link);
488 void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) {
489 wxHtmlWindow::OnLinkClicked(link);
493 wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
495 wxString *redirect) const {
497 wxHtmlOpeningStatus rval;
498 wxPyBeginBlockThreads();
499 if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
501 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iO)", type, wx2PyString(url)));
502 if (PyString_Check(ro)
503 #if PYTHON_API_VERSION >= 1009
504 || PyUnicode_Check(ro)
507 *redirect = Py2wxString(ro);
508 rval = wxHTML_REDIRECT;
511 PyObject* num = PyNumber_Int(ro);
512 rval = (wxHtmlOpeningStatus)PyInt_AsLong(num);
517 wxPyEndBlockThreads();
519 rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
528 %name(wxHtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
530 wxPyHtmlWindow(wxWindow *parent, int id = -1,
531 wxPoint& pos = wxDefaultPosition,
532 wxSize& size = wxDefaultSize,
533 int flags=wxHW_SCROLLBAR_AUTO,
534 char* name = "htmlWindow");
535 %name(wxPreHtmlWindow)wxPyHtmlWindow();
537 bool Create(wxWindow *parent, int id = -1,
538 wxPoint& pos = wxDefaultPosition,
539 wxSize& size = wxDefaultSize,
540 int flags=wxHW_SCROLLBAR_AUTO,
541 char* name = "htmlWindow");
544 void _setCallbackInfo(PyObject* self, PyObject* _class);
545 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWindow)"
546 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
547 %pragma(python) addtomethod = "wxPreHtmlWindow:val._setOORInfo(val)"
549 bool SetPage(const wxString& source);
550 bool LoadPage(const wxString& location);
551 bool AppendToPage(const wxString& source);
552 wxString GetOpenedPage();
553 wxString GetOpenedAnchor();
554 wxString GetOpenedPageTitle();
556 void SetRelatedFrame(wxFrame* frame, const char* format);
557 wxFrame* GetRelatedFrame();
558 void SetRelatedStatusBar(int bar);
560 //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
562 void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
563 int* temp = int_LIST_helper(sizes);
565 self->SetFonts(normal_face, fixed_face, temp);
571 void SetTitle(const wxString& title);
572 void SetBorders(int b);
573 void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
574 void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
576 bool HistoryForward();
577 bool HistoryCanBack();
578 bool HistoryCanForward();
580 wxHtmlContainerCell* GetInternalRepresentation();
581 wxHtmlWinParser* GetParser();
583 bool ScrollToAnchor(const wxString& anchor);
584 bool HasAnchor(const wxString& anchor);
586 void base_OnLinkClicked(const wxHtmlLinkInfo& link);
587 void base_OnSetTitle(const char* title);
588 void base_OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
589 void base_OnCellClicked(wxHtmlCell *cell,
590 wxCoord x, wxCoord y,
591 const wxMouseEvent& event);
594 // Static methods are mapped to stand-alone functions
596 void wxHtmlWindow_AddFilter(wxHtmlFilter *filter) {
597 wxHtmlWindow::AddFilter(filter);
602 //---------------------------------------------------------------------------
603 //---------------------------------------------------------------------------
606 class wxHtmlDCRenderer : public wxObject {
611 void SetDC(wxDC *dc, int maxwidth);
612 void SetSize(int width, int height);
613 void SetHtmlText(const wxString& html,
614 const wxString& basepath = wxEmptyString,
616 int Render(int x, int y, int from = 0, int dont_render = FALSE);
617 int GetTotalHeight();
618 // returns total height of the html document
619 // (compare Render's return value with this)
629 class wxHtmlPrintout : public wxPyPrintout {
631 wxHtmlPrintout(const char* title = "Printout");
632 //~wxHtmlPrintout(); wxPrintPreview object takes ownership...
634 void SetHtmlText(const wxString& html,
635 const wxString &basepath = wxEmptyString,
637 void SetHtmlFile(const wxString &htmlfile);
638 void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
639 void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
640 void SetMargins(float top = 25.2, float bottom = 25.2,
641 float left = 25.2, float right = 25.2,
647 class wxHtmlEasyPrinting : public wxObject {
649 wxHtmlEasyPrinting(const char* name = "Printing",
650 wxFrame *parent_frame = NULL);
651 ~wxHtmlEasyPrinting();
653 void PreviewFile(const wxString &htmlfile);
654 void PreviewText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
655 void PrintFile(const wxString &htmlfile);
656 void PrintText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
659 void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
660 void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
662 wxPrintData *GetPrintData() {return m_PrintData;}
663 wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
669 //---------------------------------------------------------------------------
670 //---------------------------------------------------------------------------
673 extern "C" SWIGEXPORT(void) inithtmlhelpc();
681 wxClassInfo::CleanUpClasses();
682 wxClassInfo::InitializeClasses();
684 wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
685 wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler");
686 wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow");
689 //----------------------------------------------------------------------
690 // And this gets appended to the shadow class file.
691 //----------------------------------------------------------------------
693 %pragma(python) include="_htmlextras.py";
695 //---------------------------------------------------------------------------