]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/html.i
Removed deprecation warnings in OGL and Gizmos
[wxWidgets.git] / wxPython / src / html.i
CommitLineData
4b123bb9
HH
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) 1998 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
13
14%module html
15
16%{
6e2129f9 17#include "wxPython.h"
4b123bb9 18#include <wx/html/htmlwin.h>
dc2f8a65 19#include <wx/html/htmprint.h>
4b123bb9
HH
20#include <wx/image.h>
21#include <wx/fs_zip.h>
22#include <wx/fs_inet.h>
5ca24bf4 23#include <wx/wfstream.h>
1e4a197e 24#include <wx/filesys.h>
dc2f8a65
RD
25
26#include "printfw.h"
4b123bb9
HH
27%}
28
29//---------------------------------------------------------------------------
30
31%include typemaps.i
32%include my_typemaps.i
33
34%extern wx.i
35%extern windows.i
36%extern _defs.i
37%extern events.i
5ca24bf4
HH
38%extern controls.i
39%extern controls2.i
dc2f8a65 40%extern printfw.i
0f66a9f3 41%extern utils.i
1e4a197e
RD
42%extern filesys.i
43%extern streams.i
44
0f66a9f3 45
2f90df85 46%pragma(python) code = "import wx"
4b123bb9 47
4b123bb9 48
137b5242
RD
49//----------------------------------------------------------------------
50
51%{
52 // Put some wx default wxChar* values into wxStrings.
53 static const wxChar* wxHtmlWindowNameStr = wxT("htmlWindow");
54 DECLARE_DEF_STRING(HtmlWindowNameStr);
55
56 static const wxChar* wxHtmlPrintoutTitleStr = wxT("Printout");
57 DECLARE_DEF_STRING(HtmlPrintoutTitleStr);
58
59 static const wxChar* wxHtmlPrintingTitleStr = wxT("Printing");
60 DECLARE_DEF_STRING(HtmlPrintingTitleStr);
61
62 static const wxString wxPyEmptyString(wxT(""));
63%}
64
0f66a9f3 65//---------------------------------------------------------------------------
e166644c
RD
66
67enum {
9d8bd15f
RD
68 wxHTML_ALIGN_LEFT,
69 wxHTML_ALIGN_CENTER,
70 wxHTML_ALIGN_RIGHT,
71 wxHTML_ALIGN_BOTTOM,
72 wxHTML_ALIGN_TOP,
73
74 wxHTML_CLR_FOREGROUND,
75 wxHTML_CLR_BACKGROUND,
76
77 wxHTML_UNITS_PIXELS,
78 wxHTML_UNITS_PERCENT,
79
80 wxHTML_INDENT_LEFT,
81 wxHTML_INDENT_RIGHT,
82 wxHTML_INDENT_TOP,
83 wxHTML_INDENT_BOTTOM,
84
85 wxHTML_INDENT_HORIZONTAL,
86 wxHTML_INDENT_VERTICAL,
87 wxHTML_INDENT_ALL,
88
89 wxHTML_COND_ISANCHOR,
90 wxHTML_COND_ISIMAGEMAP,
91 wxHTML_COND_USER,
e166644c
RD
92};
93
94
c6c593e8
RD
95enum {
96 wxHW_SCROLLBAR_NEVER,
97 wxHW_SCROLLBAR_AUTO,
98};
99
100
101// enums for wxHtmlWindow::OnOpeningURL
102enum wxHtmlOpeningStatus
103{
104 wxHTML_OPEN,
105 wxHTML_BLOCK,
106 wxHTML_REDIRECT
107};
108
109enum wxHtmlURLType
110{
111 wxHTML_URL_PAGE,
112 wxHTML_URL_IMAGE,
113 wxHTML_URL_OTHER
114};
115
9c00cfa3
RD
116//---------------------------------------------------------------------------
117
9416aa89 118class wxHtmlLinkInfo : public wxObject {
9c00cfa3 119public:
137b5242 120 wxHtmlLinkInfo(const wxString& href, const wxString& target = wxPyEmptyString);
9c00cfa3
RD
121 wxString GetHref();
122 wxString GetTarget();
c8bc03c3
RD
123 wxMouseEvent* GetEvent();
124 wxHtmlCell* GetHtmlCell();
7a446686
RD
125
126 void SetEvent(const wxMouseEvent *e);
127 void SetHtmlCell(const wxHtmlCell * e);
9c00cfa3
RD
128};
129
0f66a9f3
RD
130//---------------------------------------------------------------------------
131
9416aa89 132class wxHtmlTag : public wxObject {
0f66a9f3 133public:
e166644c 134 // Never need to create a new tag from Python...
0f66a9f3
RD
135 //wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache);
136
137 wxString GetName();
138 bool HasParam(const wxString& par);
139 wxString GetParam(const wxString& par, int with_commas = FALSE);
140
141 // Can't do this one as-is, but GetParam should be enough...
142 //int ScanParam(const wxString& par, const char *format, void* param);
143
144 wxString GetAllParams();
0f66a9f3
RD
145 bool HasEnding();
146 int GetBeginPos();
147 int GetEndPos1();
148 int GetEndPos2();
149};
150
151
152//---------------------------------------------------------------------------
153
9416aa89 154class wxHtmlParser : public wxObject {
0f66a9f3
RD
155public:
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);
1e4a197e 164 void StopParsing();
0f66a9f3 165 // wxObject* GetProduct();
1e4a197e 166
0f66a9f3
RD
167 void AddTagHandler(wxHtmlTagHandler *handler);
168 wxString* GetSource();
dc2f8a65
RD
169 void PushTagHandler(wxHtmlTagHandler* handler, wxString tags);
170 void PopTagHandler();
0f66a9f3 171
c6c593e8 172 // virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const;
0f66a9f3
RD
173
174 // void AddText(const char* txt) = 0;
175 // void AddTag(const wxHtmlTag& tag);
176};
177
178
179//---------------------------------------------------------------------------
180
181class wxHtmlWinParser : public wxHtmlParser {
182public:
ce914f73 183 wxHtmlWinParser(wxHtmlWindow *wnd = NULL);
0f66a9f3
RD
184
185 void SetDC(wxDC *dc);
186 wxDC* GetDC();
187 int GetCharHeight();
188 int GetCharWidth();
6c5ae2d2 189 wxHtmlWindow* GetWindow();
f6bcfd97
BP
190 //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
191 %addmethods {
192 void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
193 int* temp = int_LIST_helper(sizes);
194 if (temp) {
195 self->SetFonts(normal_face, fixed_face, temp);
196 delete [] temp;
197 }
198 }
199 }
0f66a9f3
RD
200
201 wxHtmlContainerCell* GetContainer();
202 wxHtmlContainerCell* OpenContainer();
dc2f8a65 203 wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);
0f66a9f3 204 wxHtmlContainerCell* CloseContainer();
dc2f8a65 205
0f66a9f3
RD
206 int GetFontSize();
207 void SetFontSize(int s);
208 int GetFontBold();
209 void SetFontBold(int x);
210 int GetFontItalic();
211 void SetFontItalic(int x);
212 int GetFontUnderlined();
213 void SetFontUnderlined(int x);
214 int GetFontFixed();
215 void SetFontFixed(int x);
216 int GetAlign();
217 void SetAlign(int a);
c5943253 218 wxColour GetLinkColor();
0f66a9f3 219 void SetLinkColor(const wxColour& clr);
c5943253 220 wxColour GetActualColor();
0f66a9f3 221 void SetActualColor(const wxColour& clr);
0f66a9f3
RD
222 void SetLink(const wxString& link);
223 wxFont* CreateCurrentFont();
9c00cfa3
RD
224 wxHtmlLinkInfo GetLink();
225
0f66a9f3
RD
226};
227
228
229
230//---------------------------------------------------------------------------
231
232%{
233class wxPyHtmlTagHandler : public wxHtmlTagHandler {
9416aa89 234 DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler);
0f66a9f3
RD
235public:
236 wxPyHtmlTagHandler() : wxHtmlTagHandler() {};
237
238 wxHtmlParser* GetParser() { return m_Parser; }
239 void ParseInner(const wxHtmlTag& tag) { wxHtmlTagHandler::ParseInner(tag); }
240
241 DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
242 DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
243
244 PYPRIVATE;
245};
246
9416aa89
RD
247IMPLEMENT_DYNAMIC_CLASS(wxPyHtmlTagHandler, wxHtmlTagHandler);
248
0f66a9f3
RD
249IMP_PYCALLBACK_STRING__pure(wxPyHtmlTagHandler, wxHtmlTagHandler, GetSupportedTags);
250IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
0f66a9f3
RD
251%}
252
253
9416aa89 254%name(wxHtmlTagHandler) class wxPyHtmlTagHandler : public wxObject {
0f66a9f3
RD
255public:
256 wxPyHtmlTagHandler();
257
0122b7e3
RD
258 void _setCallbackInfo(PyObject* self, PyObject* _class);
259 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlTagHandler)"
0f66a9f3
RD
260
261 void SetParser(wxHtmlParser *parser);
262 wxHtmlParser* GetParser();
263 void ParseInner(const wxHtmlTag& tag);
264};
265
266
267//---------------------------------------------------------------------------
268
269%{
270class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler {
9416aa89 271 DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler);
0f66a9f3
RD
272public:
273 wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {};
274
275 wxHtmlWinParser* GetParser() { return m_WParser; }
276 void ParseInner(const wxHtmlTag& tag)
277 { wxHtmlWinTagHandler::ParseInner(tag); }
278
279 DEC_PYCALLBACK_STRING__pure(GetSupportedTags);
280 DEC_PYCALLBACK_BOOL_TAG_pure(HandleTag);
281
282 PYPRIVATE;
283};
284
9416aa89
RD
285IMPLEMENT_DYNAMIC_CLASS( wxPyHtmlWinTagHandler, wxHtmlWinTagHandler);
286
0f66a9f3
RD
287IMP_PYCALLBACK_STRING__pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, GetSupportedTags);
288IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleTag);
0f66a9f3
RD
289%}
290
291
292%name(wxHtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
293public:
294 wxPyHtmlWinTagHandler();
295
0122b7e3
RD
296 void _setCallbackInfo(PyObject* self, PyObject* _class);
297 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWinTagHandler)"
0f66a9f3
RD
298
299 void SetParser(wxHtmlParser *parser);
300 wxHtmlWinParser* GetParser();
301 void ParseInner(const wxHtmlTag& tag);
302};
303
304
305//---------------------------------------------------------------------------
306
307%{
308
309class wxPyHtmlTagsModule : public wxHtmlTagsModule {
310public:
311 wxPyHtmlTagsModule(PyObject* thc) : wxHtmlTagsModule() {
312 m_tagHandlerClass = thc;
313 Py_INCREF(m_tagHandlerClass);
314 RegisterModule(this);
315 wxHtmlWinParser::AddModule(this);
316 }
317
318 void OnExit() {
4268f798 319 wxPyBeginBlockThreads();
0f66a9f3
RD
320 Py_DECREF(m_tagHandlerClass);
321 m_tagHandlerClass = NULL;
dc2f8a65 322 for (size_t x=0; x < m_objArray.GetCount(); x++) {
0f66a9f3
RD
323 PyObject* obj = (PyObject*)m_objArray.Item(x);
324 Py_DECREF(obj);
325 }
4268f798 326 wxPyEndBlockThreads();
0f66a9f3
RD
327 };
328
329 void FillHandlersTable(wxHtmlWinParser *parser) {
330 // Wave our magic wand... (if it works it's a miracle! ;-)
331
332 // First, make a new instance of the tag handler
4268f798 333 wxPyBeginBlockThreads();
0f66a9f3
RD
334 PyObject* arg = Py_BuildValue("()");
335 PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL);
336 Py_DECREF(arg);
4268f798 337 wxPyEndBlockThreads();
0f66a9f3
RD
338
339 // now figure out where it's C++ object is...
340 wxPyHtmlWinTagHandler* thPtr;
341 if (SWIG_GetPtrObj(obj, (void **)&thPtr, "_wxPyHtmlWinTagHandler_p"))
342 return;
343
344 // add it,
345 parser->AddTagHandler(thPtr);
346
347 // and track it.
348 m_objArray.Add(obj);
349 }
350
351private:
352 PyObject* m_tagHandlerClass;
353 wxArrayPtrVoid m_objArray;
354
355};
356%}
357
358
359
360%inline %{
361 void wxHtmlWinParser_AddTagHandler(PyObject* tagHandlerClass) {
362 // Dynamically create a new wxModule. Refcounts tagHandlerClass
363 // and adds itself to the wxModules list and to the wxHtmlWinParser.
364 new wxPyHtmlTagsModule(tagHandlerClass);
365 }
366%}
367
dc2f8a65 368
e166644c
RD
369//---------------------------------------------------------------------------
370//---------------------------------------------------------------------------
371
9416aa89 372class wxHtmlCell : public wxObject {
e166644c
RD
373public:
374 wxHtmlCell();
375
e166644c
RD
376 int GetPosX();
377 int GetPosY();
378 int GetWidth();
379 int GetHeight();
380 int GetDescent();
9c00cfa3 381 wxHtmlLinkInfo* GetLink(int x = 0, int y = 0);
e166644c 382 wxHtmlCell* GetNext();
9c00cfa3
RD
383 wxHtmlContainerCell* GetParent();
384 void SetLink(const wxHtmlLinkInfo& link);
e166644c 385 void SetNext(wxHtmlCell *cell);
9c00cfa3
RD
386 void SetParent(wxHtmlContainerCell *p);
387 void SetPos(int x, int y);
e166644c
RD
388 void Layout(int w);
389 void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
390 void DrawInvisible(wxDC& dc, int x, int y);
391 const wxHtmlCell* Find(int condition, const void* param);
dc2f8a65
RD
392
393 bool AdjustPagebreak(int * pagebreak);
394 void SetCanLiveOnPagebreak(bool can);
9c00cfa3 395
e166644c
RD
396};
397
398
9416aa89
RD
399class wxHtmlWordCell : public wxHtmlCell
400{
401public:
402 wxHtmlWordCell(const wxString& word, wxDC& dc);
403};
404
405
e166644c
RD
406class wxHtmlContainerCell : public wxHtmlCell {
407public:
408 wxHtmlContainerCell(wxHtmlContainerCell *parent);
409
410 void InsertCell(wxHtmlCell *cell);
411 void SetAlignHor(int al);
412 int GetAlignHor();
413 void SetAlignVer(int al);
414 int GetAlignVer();
9d8bd15f 415 void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
e166644c
RD
416 int GetIndent(int ind);
417 int GetIndentUnits(int ind);
418 void SetAlign(const wxHtmlTag& tag);
419 void SetWidthFloat(int w, int units);
420 %name(SetWidthFloatFromTag)void SetWidthFloat(const wxHtmlTag& tag);
9d8bd15f 421 void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP);
e166644c 422 void SetBackgroundColour(const wxColour& clr);
1e4a197e 423 wxColour GetBackgroundColour();
e166644c
RD
424 void SetBorder(const wxColour& clr1, const wxColour& clr2);
425 wxHtmlCell* GetFirstCell();
426};
427
428
429
9c00cfa3
RD
430class wxHtmlColourCell : public wxHtmlCell {
431public:
432 wxHtmlColourCell(wxColour clr, int flags = wxHTML_CLR_FOREGROUND);
433
434};
435
436
9416aa89
RD
437class wxHtmlFontCell : public wxHtmlCell
438{
439public:
440 wxHtmlFontCell(wxFont *font);
441};
442
e166644c
RD
443
444class wxHtmlWidgetCell : public wxHtmlCell {
445public:
446 wxHtmlWidgetCell(wxWindow* wnd, int w = 0);
447
448};
449
0f66a9f3 450
0f66a9f3 451//---------------------------------------------------------------------------
1e4a197e
RD
452// wxHtmlFilter
453//---------------------------------------------------------------------------
454
455
456%{ // here's the C++ version
457class wxPyHtmlFilter : public wxHtmlFilter {
458 DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter);
459public:
460 wxPyHtmlFilter() : wxHtmlFilter() {}
461
462 // returns TRUE if this filter is able to open&read given file
463 virtual bool CanRead(const wxFSFile& file) const {
464 bool rval = FALSE;
465 bool found;
466 wxPyBeginBlockThreads();
467 if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) {
468 PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file); // cast away const
469 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
470 Py_DECREF(obj);
471 }
472 wxPyEndBlockThreads();
473 return rval;
474 }
475
476
477 // Reads given file and returns HTML document.
478 // Returns empty string if opening failed
479 virtual wxString ReadFile(const wxFSFile& file) const {
480 wxString rval;
481 bool found;
482 wxPyBeginBlockThreads();
483 if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) {
484 PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file); // cast away const
485 PyObject* ro;
486 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(O)", obj));
487 Py_DECREF(obj);
488 if (ro) {
489 rval = Py2wxString(ro);
490 Py_DECREF(ro);
491 }
492 }
493 wxPyEndBlockThreads();
494 return rval;
495 }
496
497 PYPRIVATE;
498};
499
500IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter);
501%}
502
503
504// And now the version seen by SWIG
505
506%name(wxHtmlFilter) class wxPyHtmlFilter : public wxObject {
507public:
508 wxPyHtmlFilter();
509
510 void _setCallbackInfo(PyObject* self, PyObject* _class);
511 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlFilter)"
512};
513
514
515// TODO: wxHtmlFilterHTML
516
517
0f66a9f3 518//---------------------------------------------------------------------------
1e4a197e 519// wxHtmlWindow
4b123bb9
HH
520//---------------------------------------------------------------------------
521
0f66a9f3
RD
522%{
523class wxPyHtmlWindow : public wxHtmlWindow {
cdf14688 524 DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow);
0f66a9f3
RD
525public:
526 wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1,
527 const wxPoint& pos = wxDefaultPosition,
528 const wxSize& size = wxDefaultSize,
529 long style = wxHW_SCROLLBAR_AUTO,
1e4a197e 530 const wxString& name = wxPyHtmlWindowNameStr)
0f66a9f3 531 : wxHtmlWindow(parent, id, pos, size, style, name) {};
7b7ac0ab 532 wxPyHtmlWindow() : wxHtmlWindow() {};
0f66a9f3 533
e5d41db0
RD
534 bool ScrollToAnchor(const wxString& anchor) {
535 return wxHtmlWindow::ScrollToAnchor(anchor);
536 }
537
538 bool HasAnchor(const wxString& anchor) {
539 const wxHtmlCell *c = m_Cell->Find(wxHTML_COND_ISANCHOR, &anchor);
540 return c!=NULL;
541 }
542
c8bc03c3
RD
543 void OnLinkClicked(const wxHtmlLinkInfo& link);
544 void base_OnLinkClicked(const wxHtmlLinkInfo& link);
9c00cfa3 545
e5d41db0 546 wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
c6c593e8
RD
547 const wxString& url,
548 wxString *redirect) const;
549
9c00cfa3 550 DEC_PYCALLBACK__STRING(OnSetTitle);
0122b7e3
RD
551 DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover);
552 DEC_PYCALLBACK__CELLINTINTME(OnCellClicked);
0f66a9f3
RD
553 PYPRIVATE;
554};
555
cdf14688 556IMPLEMENT_ABSTRACT_CLASS( wxPyHtmlWindow, wxHtmlWindow );
9c00cfa3 557IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle);
0122b7e3
RD
558IMP_PYCALLBACK__CELLINTINT(wxPyHtmlWindow, wxHtmlWindow, OnCellMouseHover);
559IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked);
560
0f66a9f3 561
9416aa89 562void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
19a97bd6 563 bool found;
4268f798 564 wxPyBeginBlockThreads();
0122b7e3 565 if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) {
1e4a197e 566 PyObject* obj = wxPyConstructObject((void*)&link, wxT("wxHtmlLinkInfo"), 0);
1e7ecb7b 567 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
de20db99 568 Py_DECREF(obj);
9c00cfa3 569 }
4268f798 570 wxPyEndBlockThreads();
19a97bd6 571 if (! found)
9c00cfa3 572 wxHtmlWindow::OnLinkClicked(link);
9c00cfa3 573}
c8bc03c3 574void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) {
9c00cfa3
RD
575 wxHtmlWindow::OnLinkClicked(link);
576}
0122b7e3 577
c6c593e8
RD
578
579wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
580 const wxString& url,
581 wxString *redirect) const {
582 bool found;
583 wxHtmlOpeningStatus rval;
584 wxPyBeginBlockThreads();
585 if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
586 PyObject* ro;
a66212dc
RD
587 PyObject* s = wx2PyString(url);
588 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iO)", type, s));
589 Py_DECREF(s);
c6c593e8
RD
590 if (PyString_Check(ro)
591#if PYTHON_API_VERSION >= 1009
592 || PyUnicode_Check(ro)
593#endif
594 ) {
a541c325 595 *redirect = Py2wxString(ro);
c6c593e8
RD
596 rval = wxHTML_REDIRECT;
597 }
598 else {
599 PyObject* num = PyNumber_Int(ro);
600 rval = (wxHtmlOpeningStatus)PyInt_AsLong(num);
601 Py_DECREF(num);
602 }
603 Py_DECREF(ro);
604 }
605 wxPyEndBlockThreads();
606 if (! found)
607 rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
608 return rval;
609}
610
611
0f66a9f3
RD
612%}
613
614
95837b4d 615
0f66a9f3
RD
616%name(wxHtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
617public:
618 wxPyHtmlWindow(wxWindow *parent, int id = -1,
1e7ecb7b
RD
619 wxPoint& pos = wxDefaultPosition,
620 wxSize& size = wxDefaultSize,
fc51b8c3 621 int style=wxHW_SCROLLBAR_AUTO,
137b5242 622 const wxString& name = wxPyHtmlWindowNameStr);
7b7ac0ab
RD
623 %name(wxPreHtmlWindow)wxPyHtmlWindow();
624
625 bool Create(wxWindow *parent, int id = -1,
626 wxPoint& pos = wxDefaultPosition,
627 wxSize& size = wxDefaultSize,
fc51b8c3 628 int style=wxHW_SCROLLBAR_AUTO,
137b5242 629 const wxString& name = wxPyHtmlWindowNameStr);
7b7ac0ab 630
0f66a9f3 631
0122b7e3
RD
632 void _setCallbackInfo(PyObject* self, PyObject* _class);
633 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWindow)"
0122b7e3 634 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
7b7ac0ab 635 %pragma(python) addtomethod = "wxPreHtmlWindow:val._setOORInfo(val)"
0f66a9f3 636
1e4a197e
RD
637 // Set HTML page and display it. !! source is HTML document itself,
638 // it is NOT address/filename of HTML document. If you want to
639 // specify document location, use LoadPage() istead
640 // Return value : FALSE if an error occured, TRUE otherwise
7a446686 641 bool SetPage(const wxString& source);
1e4a197e
RD
642
643 // Load HTML page from given location. Location can be either
644 // a) /usr/wxGTK2/docs/html/wx.htm
645 // b) http://www.somewhere.uk/document.htm
646 // c) ftp://ftp.somesite.cz/pub/something.htm
647 // In case there is no prefix (http:,ftp:), the method
648 // will try to find it itself (1. local file, then http or ftp)
649 // After the page is loaded, the method calls SetPage() to display it.
650 // Note : you can also use path relative to previously loaded page
651 // Return value : same as SetPage
7a446686 652 bool LoadPage(const wxString& location);
1e4a197e
RD
653
654 // Append to current page
de112a55 655 bool AppendToPage(const wxString& source);
1e4a197e
RD
656
657 // Returns full location of opened page
0f66a9f3 658 wxString GetOpenedPage();
1e4a197e
RD
659
660 // Returns anchor within opened page
7a446686 661 wxString GetOpenedAnchor();
1e4a197e
RD
662
663 // Returns <TITLE> of opened page or empty string otherwise
7a446686
RD
664 wxString GetOpenedPageTitle();
665
1e4a197e
RD
666 // Sets frame in which page title will be displayed. Format is format of
667 // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
137b5242 668 void SetRelatedFrame(wxFrame* frame, const wxString& format);
0f66a9f3 669 wxFrame* GetRelatedFrame();
1e4a197e
RD
670
671 // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
672 // will be displayed. Default is -1 = no messages.
0f66a9f3 673 void SetRelatedStatusBar(int bar);
f6bcfd97 674
1e4a197e 675 // Sets fonts to be used when displaying HTML page.
f6bcfd97
BP
676 %addmethods {
677 void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
678 int* temp = int_LIST_helper(sizes);
679 if (temp) {
680 self->SetFonts(normal_face, fixed_face, temp);
681 delete [] temp;
682 }
683 }
684 }
685
7a446686 686 void SetTitle(const wxString& title);
1e4a197e
RD
687
688 // Sets space between text and window borders.
0f66a9f3 689 void SetBorders(int b);
1e4a197e
RD
690
691 // Saves custom settings into cfg config. it will use the path 'path'
692 // if given, otherwise it will save info into currently selected path.
693 // saved values : things set by SetFonts, SetBorders.
137b5242
RD
694 void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
695 void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
1e4a197e
RD
696
697 // Goes to previous/next page (in browsing history)
698 // Returns TRUE if successful, FALSE otherwise
0f66a9f3
RD
699 bool HistoryBack();
700 bool HistoryForward();
7a446686
RD
701 bool HistoryCanBack();
702 bool HistoryCanForward();
1e4a197e
RD
703
704 // Resets History
0f66a9f3 705 void HistoryClear();
1e4a197e
RD
706
707 // Returns pointer to conteiners/cells structure.
a65c6e14 708 wxHtmlContainerCell* GetInternalRepresentation();
1e4a197e
RD
709
710 // Returns a pointer to the parser.
e166644c
RD
711 wxHtmlWinParser* GetParser();
712
e5d41db0
RD
713 bool ScrollToAnchor(const wxString& anchor);
714 bool HasAnchor(const wxString& anchor);
715
1e4a197e
RD
716 //Adds input filter
717 static void AddFilter(wxPyHtmlFilter *filter);
718
719
c8bc03c3 720 void base_OnLinkClicked(const wxHtmlLinkInfo& link);
137b5242 721 void base_OnSetTitle(const wxString& title);
0122b7e3
RD
722 void base_OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
723 void base_OnCellClicked(wxHtmlCell *cell,
724 wxCoord x, wxCoord y,
725 const wxMouseEvent& event);
4b123bb9
HH
726};
727
5ca24bf4 728
5ca24bf4 729
dc2f8a65
RD
730//---------------------------------------------------------------------------
731//---------------------------------------------------------------------------
732
733
9416aa89 734class wxHtmlDCRenderer : public wxObject {
dc2f8a65
RD
735public:
736 wxHtmlDCRenderer();
737 ~wxHtmlDCRenderer();
738
739 void SetDC(wxDC *dc, int maxwidth);
740 void SetSize(int width, int height);
741 void SetHtmlText(const wxString& html,
137b5242 742 const wxString& basepath = wxPyEmptyString,
dc2f8a65
RD
743 bool isdir = TRUE);
744 int Render(int x, int y, int from = 0, int dont_render = FALSE);
745 int GetTotalHeight();
746 // returns total height of the html document
747 // (compare Render's return value with this)
748};
749
750enum {
751 wxPAGE_ODD,
752 wxPAGE_EVEN,
753 wxPAGE_ALL
754};
755
756
757class wxHtmlPrintout : public wxPyPrintout {
758public:
137b5242 759 wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr);
f3d9dc1d 760 //~wxHtmlPrintout(); wxPrintPreview object takes ownership...
dc2f8a65
RD
761
762 void SetHtmlText(const wxString& html,
137b5242 763 const wxString &basepath = wxPyEmptyString,
dc2f8a65
RD
764 bool isdir = TRUE);
765 void SetHtmlFile(const wxString &htmlfile);
766 void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
767 void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
768 void SetMargins(float top = 25.2, float bottom = 25.2,
769 float left = 25.2, float right = 25.2,
770 float spaces = 5);
771};
772
773
774
9416aa89 775class wxHtmlEasyPrinting : public wxObject {
dc2f8a65 776public:
137b5242 777 wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr,
dc2f8a65
RD
778 wxFrame *parent_frame = NULL);
779 ~wxHtmlEasyPrinting();
780
781 void PreviewFile(const wxString &htmlfile);
137b5242 782 void PreviewText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
dc2f8a65 783 void PrintFile(const wxString &htmlfile);
137b5242 784 void PrintText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
dc2f8a65
RD
785 void PrinterSetup();
786 void PageSetup();
787 void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
788 void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
789
790 wxPrintData *GetPrintData() {return m_PrintData;}
791 wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
792
793};
794
795
796
0f66a9f3
RD
797//---------------------------------------------------------------------------
798//---------------------------------------------------------------------------
5ca24bf4 799
0f66a9f3
RD
800%{
801 extern "C" SWIGEXPORT(void) inithtmlhelpc();
802%}
4b123bb9 803
4b123bb9
HH
804
805%init %{
806
2f90df85 807 inithtmlhelpc();
0f66a9f3 808
e508a2b6
RD
809 wxClassInfo::CleanUpClasses();
810 wxClassInfo::InitializeClasses();
9416aa89
RD
811
812 wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
813 wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler");
814 wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow");
1e4a197e 815 wxPyPtrTypeMap_Add("wxHtmlFilter", "wxPyHtmlFilter");
4b123bb9
HH
816%}
817
e166644c
RD
818//----------------------------------------------------------------------
819// And this gets appended to the shadow class file.
820//----------------------------------------------------------------------
821
f6bcfd97 822%pragma(python) include="_htmlextras.py";
e166644c 823
4b123bb9 824//---------------------------------------------------------------------------