X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..f89fa59caaf9b8c4f8c3ebbcbf08df468c317f99:/wxPython/src/html.i diff --git a/wxPython/src/html.i b/wxPython/src/html.i index 17db361382..eb90578306 100644 --- a/wxPython/src/html.i +++ b/wxPython/src/html.i @@ -14,13 +14,14 @@ %module html %{ -#include "helpers.h" +#include "wxPython.h" #include #include #include #include #include #include +#include #include "printfw.h" %} @@ -37,21 +38,29 @@ %extern controls.i %extern controls2.i %extern printfw.i - %extern utils.i +%extern filesys.i +%extern streams.i + + +%pragma(python) code = "import wx" -//--------------------------------------------------------------------------- + +//---------------------------------------------------------------------- %{ -// #ifdef __WXMSW__ -// wxString wxPyEmptyStr(""); -// wxPoint wxPyDefaultPosition(wxDefaultPosition); -// wxSize wxPyDefaultSize(wxDefaultSize); -// #endif -%} + // Put some wx default wxChar* values into wxStrings. + static const wxChar* wxHtmlWindowNameStr = wxT("htmlWindow"); + DECLARE_DEF_STRING(HtmlWindowNameStr); -%pragma(python) code = "import wx" + static const wxChar* wxHtmlPrintoutTitleStr = wxT("Printout"); + DECLARE_DEF_STRING(HtmlPrintoutTitleStr); + static const wxChar* wxHtmlPrintingTitleStr = wxT("Printing"); + DECLARE_DEF_STRING(HtmlPrintingTitleStr); + + static const wxString wxPyEmptyString(wxT("")); +%} //--------------------------------------------------------------------------- @@ -83,20 +92,46 @@ enum { }; +enum { + wxHW_SCROLLBAR_NEVER, + wxHW_SCROLLBAR_AUTO, + wxHW_NO_SELECTION, + wxHW_DEFAULT_STYLE, +}; + + +// enums for wxHtmlWindow::OnOpeningURL +enum wxHtmlOpeningStatus +{ + wxHTML_OPEN, + wxHTML_BLOCK, + wxHTML_REDIRECT +}; + +enum wxHtmlURLType +{ + wxHTML_URL_PAGE, + wxHTML_URL_IMAGE, + wxHTML_URL_OTHER +}; + //--------------------------------------------------------------------------- -class wxHtmlLinkInfo { +class wxHtmlLinkInfo : public wxObject { public: - wxHtmlLinkInfo(const wxString& href, const wxString& target = wxEmptyString); + wxHtmlLinkInfo(const wxString& href, const wxString& target = wxPyEmptyString); wxString GetHref(); wxString GetTarget(); wxMouseEvent* GetEvent(); wxHtmlCell* GetHtmlCell(); + + void SetEvent(const wxMouseEvent *e); + void SetHtmlCell(const wxHtmlCell * e); }; //--------------------------------------------------------------------------- -class wxHtmlTag { +class wxHtmlTag : public wxObject { public: // Never need to create a new tag from Python... //wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache); @@ -109,7 +144,6 @@ public: //int ScanParam(const wxString& par, const char *format, void* param); wxString GetAllParams(); - bool IsEnding(); bool HasEnding(); int GetBeginPos(); int GetEndPos1(); @@ -119,7 +153,7 @@ public: //--------------------------------------------------------------------------- -class wxHtmlParser { +class wxHtmlParser : public wxObject { public: // wxHtmlParser(); This is an abstract base class... @@ -129,12 +163,15 @@ public: void InitParser(const wxString& source); void DoneParser(); void DoParsing(int begin_pos, int end_pos); + void StopParsing(); // wxObject* GetProduct(); + void AddTagHandler(wxHtmlTagHandler *handler); wxString* GetSource(); void PushTagHandler(wxHtmlTagHandler* handler, wxString tags); void PopTagHandler(); + // virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const; // void AddText(const char* txt) = 0; // void AddTag(const wxHtmlTag& tag); @@ -145,21 +182,21 @@ public: class wxHtmlWinParser : public wxHtmlParser { public: - wxHtmlWinParser(wxWindow *wnd); + wxHtmlWinParser(wxPyHtmlWindow *wnd = NULL); void SetDC(wxDC *dc); wxDC* GetDC(); int GetCharHeight(); int GetCharWidth(); - wxWindow* GetWindow(); - //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST); + wxPyHtmlWindow* GetWindow(); + // Sets fonts to be used when displaying HTML page. (if size null then default sizes used). %addmethods { - void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) { - int* temp = int_LIST_helper(sizes); - if (temp) { - self->SetFonts(normal_face, fixed_face, temp); + void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) { + int* temp = NULL; + if (sizes) temp = int_LIST_helper(sizes); + self->SetFonts(normal_face, fixed_face, temp); + if (temp) delete [] temp; - } } } @@ -180,9 +217,9 @@ public: void SetFontFixed(int x); int GetAlign(); void SetAlign(int a); - const wxColour& GetLinkColor(); + wxColour GetLinkColor(); void SetLinkColor(const wxColour& clr); - const wxColour& GetActualColor(); + wxColour GetActualColor(); void SetActualColor(const wxColour& clr); void SetLink(const wxString& link); wxFont* CreateCurrentFont(); @@ -196,6 +233,7 @@ public: %{ class wxPyHtmlTagHandler : public wxHtmlTagHandler { + DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler); public: wxPyHtmlTagHandler() : wxHtmlTagHandler() {}; @@ -208,17 +246,19 @@ public: PYPRIVATE; }; +IMPLEMENT_DYNAMIC_CLASS(wxPyHtmlTagHandler, wxHtmlTagHandler); + IMP_PYCALLBACK_STRING__pure(wxPyHtmlTagHandler, wxHtmlTagHandler, GetSupportedTags); IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag); %} -%name(wxHtmlTagHandler) class wxPyHtmlTagHandler { +%name(wxHtmlTagHandler) class wxPyHtmlTagHandler : public wxObject { public: wxPyHtmlTagHandler(); - void _setSelf(PyObject* self, PyObject* _class); - %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlTagHandler)" + void _setCallbackInfo(PyObject* self, PyObject* _class); + %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlTagHandler)" void SetParser(wxHtmlParser *parser); wxHtmlParser* GetParser(); @@ -230,6 +270,7 @@ public: %{ class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler { + DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler); public: wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {}; @@ -243,6 +284,8 @@ public: PYPRIVATE; }; +IMPLEMENT_DYNAMIC_CLASS( wxPyHtmlWinTagHandler, wxHtmlWinTagHandler); + IMP_PYCALLBACK_STRING__pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, GetSupportedTags); IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleTag); %} @@ -252,8 +295,8 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleT public: wxPyHtmlWinTagHandler(); - void _setSelf(PyObject* self, PyObject* _class); - %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlWinTagHandler)" + void _setCallbackInfo(PyObject* self, PyObject* _class); + %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWinTagHandler)" void SetParser(wxHtmlParser *parser); wxHtmlWinParser* GetParser(); @@ -275,23 +318,25 @@ public: } void OnExit() { + wxPyBeginBlockThreads(); Py_DECREF(m_tagHandlerClass); m_tagHandlerClass = NULL; for (size_t x=0; x < m_objArray.GetCount(); x++) { PyObject* obj = (PyObject*)m_objArray.Item(x); Py_DECREF(obj); } + wxPyEndBlockThreads(); }; void FillHandlersTable(wxHtmlWinParser *parser) { // Wave our magic wand... (if it works it's a miracle! ;-) // First, make a new instance of the tag handler - bool doSave = wxPyRestoreThread(); + wxPyBeginBlockThreads(); PyObject* arg = Py_BuildValue("()"); PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL); Py_DECREF(arg); - wxPySaveThread(doSave); + wxPyEndBlockThreads(); // now figure out where it's C++ object is... wxPyHtmlWinTagHandler* thPtr; @@ -326,7 +371,113 @@ private: //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- -class wxHtmlCell { + +// wxHtmlSelection is data holder with information about text selection. +// Selection is defined by two positions (beginning and end of the selection) +// and two leaf(!) cells at these positions. +class wxHtmlSelection +{ +public: + wxHtmlSelection(); + ~wxHtmlSelection(); + + void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell, + const wxPoint& toPos, const wxHtmlCell *toCell); + %name(SetCells)void Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell); + + const wxHtmlCell *GetFromCell() const; + const wxHtmlCell *GetToCell() const; + + // these values are in absolute coordinates: + const wxPoint& GetFromPos() const; + const wxPoint& GetToPos() const; + + // these are From/ToCell's private data + const wxPoint& GetFromPrivPos() const; + const wxPoint& GetToPrivPos() const; + void SetFromPrivPos(const wxPoint& pos); + void SetToPrivPos(const wxPoint& pos); + void ClearPrivPos(); + + const bool IsEmpty() const; + +}; + + +enum wxHtmlSelectionState +{ + wxHTML_SEL_OUT, // currently rendered cell is outside the selection + wxHTML_SEL_IN, // ... is inside selection + wxHTML_SEL_CHANGING // ... is the cell on which selection state changes +}; + +// Selection state is passed to wxHtmlCell::Draw so that it can render itself +// differently e.g. when inside text selection or outside it. +class wxHtmlRenderingState +{ +public: + wxHtmlRenderingState(); + ~wxHtmlRenderingState(); + + void SetSelectionState(wxHtmlSelectionState s); + wxHtmlSelectionState GetSelectionState() const; + + void SetFgColour(const wxColour& c); + const wxColour& GetFgColour() const; + void SetBgColour(const wxColour& c); + const wxColour& GetBgColour() const; +}; + + +// HTML rendering customization. This class is used when rendering wxHtmlCells +// as a callback: +class wxHtmlRenderingStyle +{ +public: + virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0; + virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0; +}; + +// Standard style: +class wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle +{ +public: + virtual wxColour GetSelectedTextColour(const wxColour& clr); + virtual wxColour GetSelectedTextBgColour(const wxColour& clr); +}; + + + +// Information given to cells when drawing them. Contains rendering state, +// selection information and rendering style object that can be used to +// customize the output. +class wxHtmlRenderingInfo +{ +public: + wxHtmlRenderingInfo(); + ~wxHtmlRenderingInfo(); + + void SetSelection(wxHtmlSelection *s); + wxHtmlSelection *GetSelection() const; + + void SetStyle(wxHtmlRenderingStyle *style); + wxHtmlRenderingStyle& GetStyle(); + + wxHtmlRenderingState& GetState(); +}; + +//--------------------------------------------------------------------------- + + +enum +{ + wxHTML_FIND_EXACT = 1, + wxHTML_FIND_NEAREST_BEFORE = 2, + wxHTML_FIND_NEAREST_AFTER = 4 +}; + + +class wxHtmlCell : public wxObject { public: wxHtmlCell(); @@ -338,18 +489,72 @@ public: wxHtmlLinkInfo* GetLink(int x = 0, int y = 0); wxHtmlCell* GetNext(); wxHtmlContainerCell* GetParent(); + wxHtmlCell* GetFirstChild() const; + + // Returns cursor to be used when mouse is over the cell: + wxCursor GetCursor() const; + + // Formatting cells are not visible on the screen, they only alter + // renderer's state. + bool IsFormattingCell() const; + + void SetLink(const wxHtmlLinkInfo& link); void SetNext(wxHtmlCell *cell); void SetParent(wxHtmlContainerCell *p); void SetPos(int x, int y); void Layout(int w); - void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); - void DrawInvisible(wxDC& dc, int x, int y); + void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2, + wxHtmlRenderingInfo& info); + void DrawInvisible(wxDC& dc, int x, int y, + wxHtmlRenderingInfo& info); const wxHtmlCell* Find(int condition, const void* param); - bool AdjustPagebreak(int * pagebreak); + bool AdjustPagebreak(int* INOUT); void SetCanLiveOnPagebreak(bool can); + // Can the line be broken before this cell? + bool IsLinebreakAllowed() const; + + // Returns true for simple == terminal cells, i.e. not composite ones. + // This if for internal usage only and may disappear in future versions! + bool IsTerminalCell() const; + + // Find a cell inside this cell positioned at the given coordinates + // (relative to this's positions). Returns NULL if no such cell exists. + // The flag can be used to specify whether to look for terminal or + // nonterminal cells or both. In either case, returned cell is deepest + // cell in cells tree that contains [x,y]. + wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y, + unsigned flags = wxHTML_FIND_EXACT) const; + + // Returns absolute position of the cell on HTML canvas + wxPoint GetAbsPos() const; + + // Returns first (last) terminal cell inside this cell. It may return NULL, + // but it is rare -- only if there are no terminals in the tree. + wxHtmlCell *GetFirstTerminal() const ; + wxHtmlCell *GetLastTerminal() const ; + + // Returns cell's depth, i.e. how far under the root cell it is + // (if it is the root, depth is 0) + unsigned GetDepth() const; + + // Returns true if the cell appears before 'cell' in natural order of + // cells (= as they are read). If cell A is (grand)parent of cell B, + // then both A.IsBefore(B) and B.IsBefore(A) always return true. + bool IsBefore(wxHtmlCell *cell) const; + + // Converts the cell into text representation. If sel != NULL then + // only part of the cell inside the selection is converted. + wxString ConvertToText(wxHtmlSelection *sel) const; +}; + + +class wxHtmlWordCell : public wxHtmlCell +{ +public: + wxHtmlWordCell(const wxString& word, wxDC& dc); }; @@ -370,8 +575,10 @@ public: %name(SetWidthFloatFromTag)void SetWidthFloat(const wxHtmlTag& tag); void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP); void SetBackgroundColour(const wxColour& clr); + wxColour GetBackgroundColour(); void SetBorder(const wxColour& clr1, const wxColour& clr2); - wxHtmlCell* GetFirstCell(); + wxHtmlCell* GetFirstChild(); + %pragma(python) addtoclass = "GetFirstCell = GetFirstChild" }; @@ -383,6 +590,12 @@ public: }; +class wxHtmlFontCell : public wxHtmlCell +{ +public: + wxHtmlFontCell(wxFont *font); +}; + class wxHtmlWidgetCell : public wxHtmlCell { public: @@ -391,57 +604,167 @@ public: }; - -//--------------------------------------------------------------------------- //--------------------------------------------------------------------------- +// wxHtmlFilter //--------------------------------------------------------------------------- -// item of history list -class HtmlHistoryItem { + +%{ // here's the C++ version +class wxPyHtmlFilter : public wxHtmlFilter { + DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter); public: - HtmlHistoryItem(const char* p, const char* a); + wxPyHtmlFilter() : wxHtmlFilter() {} + + // returns TRUE if this filter is able to open&read given file + virtual bool CanRead(const wxFSFile& file) const { + bool rval = FALSE; + bool found; + wxPyBeginBlockThreads(); + if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) { + PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file); // cast away const + rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj)); + Py_DECREF(obj); + } + wxPyEndBlockThreads(); + return rval; + } + - int GetPos(); - void SetPos(int p); - const wxString& GetPage(); - const wxString& GetAnchor(); + // Reads given file and returns HTML document. + // Returns empty string if opening failed + virtual wxString ReadFile(const wxFSFile& file) const { + wxString rval; + bool found; + wxPyBeginBlockThreads(); + if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) { + PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file); // cast away const + PyObject* ro; + ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(O)", obj)); + Py_DECREF(obj); + if (ro) { + rval = Py2wxString(ro); + Py_DECREF(ro); + } + } + wxPyEndBlockThreads(); + return rval; + } + + PYPRIVATE; }; +IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter); +%} + +// And now the version seen by SWIG + +%name(wxHtmlFilter) class wxPyHtmlFilter : public wxObject { +public: + wxPyHtmlFilter(); + + void _setCallbackInfo(PyObject* self, PyObject* _class); + %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlFilter)" +}; + + +// TODO: wxHtmlFilterHTML + + +//--------------------------------------------------------------------------- +// wxHtmlWindow //--------------------------------------------------------------------------- + %{ class wxPyHtmlWindow : public wxHtmlWindow { + DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow); public: wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - long style = wxHW_SCROLLBAR_AUTO, - const wxString& name = "htmlWindow") + long style = wxHW_DEFAULT_STYLE, + const wxString& name = wxPyHtmlWindowNameStr) : wxHtmlWindow(parent, id, pos, size, style, name) {}; + wxPyHtmlWindow() : wxHtmlWindow() {}; + + bool ScrollToAnchor(const wxString& anchor) { + return wxHtmlWindow::ScrollToAnchor(anchor); + } + + bool HasAnchor(const wxString& anchor) { + const wxHtmlCell *c = m_Cell->Find(wxHTML_COND_ISANCHOR, &anchor); + return c!=NULL; + } void OnLinkClicked(const wxHtmlLinkInfo& link); void base_OnLinkClicked(const wxHtmlLinkInfo& link); + wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type, + const wxString& url, + wxString *redirect) const; + DEC_PYCALLBACK__STRING(OnSetTitle); + DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover); + DEC_PYCALLBACK__CELLINTINTME(OnCellClicked); PYPRIVATE; }; - +IMPLEMENT_ABSTRACT_CLASS( wxPyHtmlWindow, wxHtmlWindow ); IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle); +IMP_PYCALLBACK__CELLINTINT(wxPyHtmlWindow, wxHtmlWindow, OnCellMouseHover); +IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked); - void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) { - bool doSave = wxPyRestoreThread(); - if (m_myInst.findCallback("OnLinkClicked")) { - PyObject* obj = wxPyConstructObject((void*)&link, "wxHtmlLinkInfo"); - m_myInst.callCallback(Py_BuildValue("(O)", obj)); + +void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) { + bool found; + wxPyBeginBlockThreads(); + if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) { + PyObject* obj = wxPyConstructObject((void*)&link, wxT("wxHtmlLinkInfo"), 0); + wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj)); + Py_DECREF(obj); } - else + wxPyEndBlockThreads(); + if (! found) wxHtmlWindow::OnLinkClicked(link); - wxPySaveThread(doSave); } void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) { wxHtmlWindow::OnLinkClicked(link); } + + +wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, + const wxString& url, + wxString *redirect) const { + bool found; + wxHtmlOpeningStatus rval; + wxPyBeginBlockThreads(); + if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) { + PyObject* ro; + PyObject* s = wx2PyString(url); + ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iO)", type, s)); + Py_DECREF(s); + if (PyString_Check(ro) +#if PYTHON_API_VERSION >= 1009 + || PyUnicode_Check(ro) +#endif + ) { + *redirect = Py2wxString(ro); + rval = wxHTML_REDIRECT; + } + else { + PyObject* num = PyNumber_Int(ro); + rval = (wxHtmlOpeningStatus)PyInt_AsLong(num); + Py_DECREF(num); + } + Py_DECREF(ro); + } + wxPyEndBlockThreads(); + if (! found) + rval = wxHtmlWindow::OnOpeningURL(type, url, redirect); + return rval; +} + + %} @@ -449,62 +772,125 @@ void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) { %name(wxHtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow { public: wxPyHtmlWindow(wxWindow *parent, int id = -1, - wxPoint& pos = wxPyDefaultPosition, - wxSize& size = wxPyDefaultSize, - int flags=wxHW_SCROLLBAR_AUTO, - char* name = "htmlWindow"); + wxPoint& pos = wxDefaultPosition, + wxSize& size = wxDefaultSize, + int style=wxHW_DEFAULT_STYLE, + const wxString& name = wxPyHtmlWindowNameStr); + %name(wxPreHtmlWindow)wxPyHtmlWindow(); + + bool Create(wxWindow *parent, int id = -1, + wxPoint& pos = wxDefaultPosition, + wxSize& size = wxDefaultSize, + int style=wxHW_SCROLLBAR_AUTO, + const wxString& name = wxPyHtmlWindowNameStr); + + + void _setCallbackInfo(PyObject* self, PyObject* _class); + %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWindow)" + %pragma(python) addtomethod = "__init__:self._setOORInfo(self)" + %pragma(python) addtomethod = "wxPreHtmlWindow:val._setOORInfo(val)" + + // Set HTML page and display it. !! source is HTML document itself, + // it is NOT address/filename of HTML document. If you want to + // specify document location, use LoadPage() istead + // Return value : FALSE if an error occured, TRUE otherwise + bool SetPage(const wxString& source); + + // Load HTML page from given location. Location can be either + // a) /usr/wxGTK2/docs/html/wx.htm + // b) http://www.somewhere.uk/document.htm + // c) ftp://ftp.somesite.cz/pub/something.htm + // In case there is no prefix (http:,ftp:), the method + // will try to find it itself (1. local file, then http or ftp) + // After the page is loaded, the method calls SetPage() to display it. + // Note : you can also use path relative to previously loaded page + // Return value : same as SetPage + bool LoadPage(const wxString& location); + + // Loads HTML page from file + bool LoadFile(const wxString& filename); + + // Append to current page + bool AppendToPage(const wxString& source); + + // Returns full location of opened page + wxString GetOpenedPage(); - void _setSelf(PyObject* self, PyObject* _class); - %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlWindow)" - %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)" - %pragma(python) addtomethod = "__init__:#wx._StdOnScrollCallbacks(self)" + // Returns anchor within opened page + wxString GetOpenedAnchor(); + // Returns of opened page or empty string otherwise + wxString GetOpenedPageTitle(); - bool SetPage(const char* source); - bool LoadPage(const char* location); - wxString GetOpenedPage(); - void SetRelatedFrame(wxFrame* frame, const char* format); + // Sets frame in which page title will be displayed. Format is format of + // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s + void SetRelatedFrame(wxFrame* frame, const wxString& format); wxFrame* GetRelatedFrame(); + + // After(!) calling SetRelatedFrame, this sets statusbar slot where messages + // will be displayed. Default is -1 = no messages. void SetRelatedStatusBar(int bar); - //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST); + // Sets fonts to be used when displaying HTML page. %addmethods { - void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) { - int* temp = int_LIST_helper(sizes); - if (temp) { - self->SetFonts(normal_face, fixed_face, temp); + void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) { + int* temp = NULL; + if (sizes) temp = int_LIST_helper(sizes); + self->SetFonts(normal_face, fixed_face, temp); + if (temp) delete [] temp; - } } } - void SetTitle(const char* title); + void SetTitle(const wxString& title); + + // Sets space between text and window borders. void SetBorders(int b); - void ReadCustomization(wxConfigBase *cfg, char* path = ""); - void WriteCustomization(wxConfigBase *cfg, char* path = ""); + + // Saves custom settings into cfg config. it will use the path 'path' + // if given, otherwise it will save info into currently selected path. + // saved values : things set by SetFonts, SetBorders. + void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); + void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); + + // Goes to previous/next page (in browsing history) + // Returns TRUE if successful, FALSE otherwise bool HistoryBack(); bool HistoryForward(); + bool HistoryCanBack(); + bool HistoryCanForward(); + + // Resets History void HistoryClear(); + + // Returns pointer to conteiners/cells structure. wxHtmlContainerCell* GetInternalRepresentation(); + + // Returns a pointer to the parser. wxHtmlWinParser* GetParser(); + bool ScrollToAnchor(const wxString& anchor); + bool HasAnchor(const wxString& anchor); + + //Adds input filter + static void AddFilter(wxPyHtmlFilter *filter); + + void base_OnLinkClicked(const wxHtmlLinkInfo& link); - void base_OnSetTitle(const char* title); + void base_OnSetTitle(const wxString& title); + void base_OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y); + void base_OnCellClicked(wxHtmlCell *cell, + wxCoord x, wxCoord y, + const wxMouseEvent& event); }; -// Static methods are mapped to stand-alone functions -%inline %{ - void wxHtmlWindow_AddFilter(wxHtmlFilter *filter) { - wxHtmlWindow::AddFilter(filter); - } -%} //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- -class wxHtmlDCRenderer { +class wxHtmlDCRenderer : public wxObject { public: wxHtmlDCRenderer(); ~wxHtmlDCRenderer(); @@ -512,9 +898,22 @@ public: void SetDC(wxDC *dc, int maxwidth); void SetSize(int width, int height); void SetHtmlText(const wxString& html, - const wxString& basepath = wxEmptyString, + const wxString& basepath = wxPyEmptyString, bool isdir = TRUE); - int Render(int x, int y, int from = 0, int dont_render = FALSE); + // Sets fonts to be used when displaying HTML page. (if size null then default sizes used). + %addmethods { + void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) { + int* temp = NULL; + if (sizes) temp = int_LIST_helper(sizes); + self->SetFonts(normal_face, fixed_face, temp); + if (temp) + delete [] temp; + } + } + int Render(int x, int y, int from = 0, int dont_render = FALSE, int to = INT_MAX, + //int *known_pagebreaks = NULL, int number_of_pages = 0 + int* choices=NULL, int LCOUNT = 0 + ); int GetTotalHeight(); // returns total height of the html document // (compare Render's return value with this) @@ -529,44 +928,69 @@ enum { class wxHtmlPrintout : public wxPyPrintout { public: - wxHtmlPrintout(const char* title = "Printout"); - ~wxHtmlPrintout(); + wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr); + //~wxHtmlPrintout(); wxPrintPreview object takes ownership... void SetHtmlText(const wxString& html, - const wxString &basepath = wxEmptyString, + const wxString &basepath = wxPyEmptyString, bool isdir = TRUE); void SetHtmlFile(const wxString &htmlfile); void SetHeader(const wxString& header, int pg = wxPAGE_ALL); void SetFooter(const wxString& footer, int pg = wxPAGE_ALL); + // Sets fonts to be used when displaying HTML page. (if size null then default sizes used). + %addmethods { + void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) { + int* temp = NULL; + if (sizes) temp = int_LIST_helper(sizes); + self->SetFonts(normal_face, fixed_face, temp); + if (temp) + delete [] temp; + } + } void SetMargins(float top = 25.2, float bottom = 25.2, float left = 25.2, float right = 25.2, float spaces = 5); + + // Adds input filter + static void AddFilter(wxHtmlFilter *filter); + + // Cleanup + static void CleanUpStatics(); }; -class wxHtmlEasyPrinting { +class wxHtmlEasyPrinting : public wxObject { public: - wxHtmlEasyPrinting(const char* name = "Printing", - wxFrame *parent_frame = NULL); + wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr, + wxWindow *parentWindow = NULL); ~wxHtmlEasyPrinting(); void PreviewFile(const wxString &htmlfile); - void PreviewText(const wxString &htmltext, const wxString& basepath = wxEmptyString); + void PreviewText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString); void PrintFile(const wxString &htmlfile); - void PrintText(const wxString &htmltext, const wxString& basepath = wxEmptyString); + void PrintText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString); void PrinterSetup(); void PageSetup(); void SetHeader(const wxString& header, int pg = wxPAGE_ALL); void SetFooter(const wxString& footer, int pg = wxPAGE_ALL); + %addmethods { + void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) { + int* temp = NULL; + if (sizes) temp = int_LIST_helper(sizes); + self->SetFonts(normal_face, fixed_face, temp); + if (temp) + delete [] temp; + } + } + wxPrintData *GetPrintData() {return m_PrintData;} wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;} }; - //--------------------------------------------------------------------------- //--------------------------------------------------------------------------- @@ -579,16 +1003,10 @@ public: inithtmlhelpc(); - wxClassInfo::CleanUpClasses(); - wxClassInfo::InitializeClasses(); - - // Until wxFileSystem is wrapped... - #if wxUSE_FS_ZIP - wxFileSystem::AddHandler(new wxZipFSHandler); - #endif - #if wxUSE_FS_INET -// wxFileSystem::AddHandler(new wxInternetFSHandler); - #endif + wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler"); + wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler"); + wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow"); + wxPyPtrTypeMap_Add("wxHtmlFilter", "wxPyHtmlFilter"); %} //---------------------------------------------------------------------- @@ -598,4 +1016,3 @@ public: %pragma(python) include="_htmlextras.py"; //--------------------------------------------------------------------------- -