X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4617be085fb55acce74f4d4687b098918dc9d107..e48f0e09bfec3e53db61a80d6829166e2d73ce47:/wxPython/src/html.i diff --git a/wxPython/src/html.i b/wxPython/src/html.i index 651cfe2767..722f520a9d 100644 --- a/wxPython/src/html.i +++ b/wxPython/src/html.i @@ -50,7 +50,6 @@ MAKE_CONST_WXSTRING2(HtmlPrintingTitleStr, wxT("Printing")) // TODO: Split this file into multiple %included files that coresponds to the // wx/html include files (more or less.) -//--------------------------------------------------------------------------- //--------------------------------------------------------------------------- %newgroup @@ -176,6 +175,11 @@ public: // void AddText(const char* txt) = 0; // void AddTag(const wxHtmlTag& tag); + + + // Returns HTML source inside the element (i.e. between the starting + // and ending tag) + wxString GetInnerSource(const wxHtmlTag& tag); }; @@ -190,6 +194,9 @@ public: int GetCharHeight(); int GetCharWidth(); wxPyHtmlWindow* GetWindow(); + %pythoncode { GetWindow = wx._deprecated(GetWindow) } + + wxHtmlWindowInterface *GetWindowInterface(); // Sets fonts to be used when displaying HTML page. (if size null then default sizes used). %extend { @@ -385,6 +392,10 @@ private: //--------------------------------------------------------------------------- + +%typemap(out) wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); } +%typemap(out) const wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); } + //--------------------------------------------------------------------------- %newgroup @@ -500,7 +511,13 @@ enum class wxHtmlCell : public wxObject { public: + %typemap(out) wxHtmlCell*; // turn off this typemap + wxHtmlCell(); + ~wxHtmlCell(); + + // Turn it back on again + %typemap(out) wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); } int GetPosX(); int GetPosY(); @@ -519,8 +536,12 @@ public: wxHtmlContainerCell* GetParent(); wxHtmlCell* GetFirstChild() const; + // Returns cursor to be used when mouse is over the cell: + virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const; + // Returns cursor to be used when mouse is over the cell: wxCursor GetCursor() const; + %pythoncode { GetCursor = wx._deprecated(GetCursor) } // Formatting cells are not visible on the screen, they only alter // renderer's state. @@ -528,7 +549,11 @@ public: void SetLink(const wxHtmlLinkInfo& link); + + %disownarg(wxHtmlCell*); void SetNext(wxHtmlCell *cell); + %cleardisown(wxHtmlCell*); + void SetParent(wxHtmlContainerCell *p); void SetPos(int x, int y); void Layout(int w); @@ -538,6 +563,11 @@ public: wxHtmlRenderingInfo& info); const wxHtmlCell* Find(int condition, const void* param); + + virtual bool ProcessMouseClick(wxHtmlWindowInterface *window, + const wxPoint& pos, + const wxMouseEvent& event); + bool AdjustPagebreak(int* INOUT); void SetCanLiveOnPagebreak(bool can); @@ -557,7 +587,13 @@ public: unsigned flags = wxHTML_FIND_EXACT) const; // Returns absolute position of the cell on HTML canvas - wxPoint GetAbsPos() const; + // If rootCell is provided, then it's considered to be the root of the + // hierarchy and the returned value is relative to it. + wxPoint GetAbsPos(wxHtmlCell *rootCell = NULL) const; + + // Returns root cell of the hierarchy (i.e. grand-grand-...-parent that + // doesn't have a parent itself) + wxHtmlCell *GetRootCell() 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. @@ -583,6 +619,9 @@ class wxHtmlWordCell : public wxHtmlCell { public: wxHtmlWordCell(const wxString& word, wxDC& dc); + wxString ConvertToText(wxHtmlSelection *sel) const; + bool IsLinebreakAllowed() const; + void SetPreviousWord(wxHtmlWordCell *cell); }; @@ -590,7 +629,10 @@ class wxHtmlContainerCell : public wxHtmlCell { public: wxHtmlContainerCell(wxHtmlContainerCell *parent); + %disownarg(wxHtmlCell*); void InsertCell(wxHtmlCell *cell); + %cleardisown(wxHtmlCell*); + void SetAlignHor(int al); int GetAlignHor(); void SetAlignVer(int al); @@ -704,10 +746,91 @@ public: //--------------------------------------------------------------------------- -// wxHtmlWindow + + +class wxHtmlWindowInterface +{ +public: + /// Ctor + wxHtmlWindowInterface(); + virtual ~wxHtmlWindowInterface(); + + /** + Called by the parser to set window's title to given text. + */ + virtual void SetHTMLWindowTitle(const wxString& title) = 0; + +// /** +// Called when a link is clicked. + +// @param link information about the clicked link +// */ +// virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link) = 0; + +// /** +// Called when the parser needs to open another URL (e.g. an image). + +// @param type Type of the URL request (e.g. image) +// @param url URL the parser wants to open +// @param redirect If the return value is wxHTML_REDIRECT, then the +// URL to redirect to will be stored in this variable +// (the pointer must never be NULL) + +// @return indicator of how to treat the request +// */ +// virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type, +// const wxString& url, +// wxString *redirect) const = 0; + + /** + Converts coordinates @a pos relative to given @a cell to + physical coordinates in the window. + */ + virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell, + const wxPoint& pos) const = 0; + + /// Returns the window used for rendering (may be NULL). + virtual wxWindow* GetHTMLWindow() = 0; + + /// Returns background colour to use by default. + virtual wxColour GetHTMLBackgroundColour() const = 0; + + /// Sets window's background to colour @a clr. + virtual void SetHTMLBackgroundColour(const wxColour& clr) = 0; + + /// Sets window's background to given bitmap. + virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg) = 0; + + /// Sets status bar text. + virtual void SetHTMLStatusText(const wxString& text) = 0; + + /// Type of mouse cursor + enum HTMLCursor + { + /// Standard mouse cursor (typically an arrow) + HTMLCursor_Default, + /// Cursor shown over links + HTMLCursor_Link, + /// Cursor shown over selectable text + HTMLCursor_Text + }; + + /** + Returns mouse cursor of given @a type. + */ +// virtual wxCursor GetHTMLCursor(HTMLCursor type) const = 0; +}; + + +//--------------------------------------------------------------------------- +// wxHtmlWindow //--------------------------------------------------------------------------- %newgroup +// TODO? +// wxHtmlWindowInterface and wxHtmlWindowMouseHelper + + %{ class wxPyHtmlWindow : public wxHtmlWindow { DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow) @@ -730,7 +853,6 @@ public: } void OnLinkClicked(const wxHtmlLinkInfo& link); - void base_OnLinkClicked(const wxHtmlLinkInfo& link); wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type, const wxString& url, @@ -738,14 +860,15 @@ public: DEC_PYCALLBACK__STRING(OnSetTitle); DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover); - DEC_PYCALLBACK__CELLINTINTME(OnCellClicked); + DEC_PYCALLBACK_BOOL_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); +IMP_PYCALLBACK_BOOL_CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked); void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) { @@ -760,9 +883,6 @@ void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) { if (! found) wxHtmlWindow::OnLinkClicked(link); } -void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) { - wxHtmlWindow::OnLinkClicked(link); -} wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, @@ -805,7 +925,10 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, MustHaveApp(wxPyHtmlWindow); %rename(HtmlWindow) wxPyHtmlWindow; -class wxPyHtmlWindow : public wxScrolledWindow { +class wxPyHtmlWindow : public wxScrolledWindow //, + // public wxHtmlWindowInterface //, + // public wxHtmlWindowMouseHelper +{ public: %pythonAppend wxPyHtmlWindow "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)" %pythonAppend wxPyHtmlWindow() "" @@ -939,15 +1062,54 @@ public: // Converts current page to text: wxString ToText(); - void base_OnLinkClicked(const wxHtmlLinkInfo& link); - 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); + void OnLinkClicked(const wxHtmlLinkInfo& link); + void OnSetTitle(const wxString& title); + void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y); + bool OnCellClicked(wxHtmlCell *cell, + wxCoord x, wxCoord y, + const wxMouseEvent& event); + wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type, + const wxString& url, + wxString *redirect) const; + %MAKE_BASE_FUNC(HtmlWindow, OnLinkClicked); + %MAKE_BASE_FUNC(HtmlWindow, OnSetTitle); + %MAKE_BASE_FUNC(HtmlWindow, OnCellMouseHover); + %MAKE_BASE_FUNC(HtmlWindow, OnCellClicked); static wxVisualAttributes GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); + + /// Type of mouse cursor + enum HTMLCursor + { + /// Standard mouse cursor (typically an arrow) + HTMLCursor_Default, + /// Cursor shown over links + HTMLCursor_Link, + /// Cursor shown over selectable text + HTMLCursor_Text + }; + + // Returns standard HTML cursor as used by wxHtmlWindow + static wxCursor GetDefaultHTMLCursor(HTMLCursor type); + + +// private: +// // wxHtmlWindowInterface methods: +// virtual void SetHTMLWindowTitle(const wxString& title); +// virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link); +// virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type, +// const wxString& url, +// wxString *redirect) const; +// virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell, +// const wxPoint& pos) const; +// virtual wxWindow* GetHTMLWindow(); +// virtual wxColour GetHTMLBackgroundColour() const; +// virtual void SetHTMLBackgroundColour(const wxColour& clr); +// virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg); +// virtual void SetHTMLStatusText(const wxString& text); +// virtual wxCursor GetHTMLCursor(HTMLCursor type) const; + }; @@ -1139,10 +1301,6 @@ public: int GetCurIndex(); int GetMaxIndex(); const wxString& GetName(); - // WXWIN_COMPATIBILITY_2_4 -#if 0 - wxHtmlContentsItem* GetContentsItem(); -#endif }; //--------------------------------------------------------------------------- @@ -1165,13 +1323,6 @@ public: // TODO: this one needs fixed... const wxHtmlBookRecArray& GetBookRecArray(); - // WXWIN_COMPATIBILITY_2_4 -#if 0 - wxHtmlContentsItem* GetContents(); - int GetContentsCnt(); - wxHtmlContentsItem* GetIndex(); - int GetIndexCnt(); -#endif }; //--------------------------------------------------------------------------- @@ -1223,7 +1374,7 @@ enum { wxID_HTML_SEARCHBUTTON, wxID_HTML_SEARCHCHOICE, wxID_HTML_COUNTINFO -}; +}; @@ -1243,7 +1394,7 @@ public: int helpStyle = wxHF_DEFAULT_STYLE, wxHtmlHelpData* data = NULL); %RenameCtor(PreHtmlHelpWindow, wxHtmlHelpWindow(wxHtmlHelpData* data = NULL)); - + // Turn it back on again %typemap(out) wxHtmlHelpWindow* { $result = wxPyMake_wxObject($1, $owner); } @@ -1255,7 +1406,10 @@ public: wxHtmlHelpData* GetData(); wxHtmlHelpController* GetController() const; + + %disownarg( wxHtmlHelpController* controller ); void SetController(wxHtmlHelpController* controller); + %cleardisown( wxHtmlHelpController* controller ); // Displays page x. If not found it will offect the user a choice of // searching books. @@ -1346,7 +1500,7 @@ public: // Turn it back on again %typemap(out) wxHtmlHelpFrame* { $result = wxPyMake_wxObject($1, $owner); } - + bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxPyEmptyString, int style = wxHF_DEFAULT_STYLE); @@ -1360,7 +1514,9 @@ public: wxHtmlHelpController* GetController() const; /// Sets the help controller associated with the window. + %disownarg( wxHtmlHelpController* controller ); void SetController(wxHtmlHelpController* controller); + %cleardisown( wxHtmlHelpController* controller ); /// Returns the help window. wxHtmlHelpWindow* GetHelpWindow() const; @@ -1378,7 +1534,7 @@ public: def KeywordSearch(self, keyword): return self.GetHelpWindow().KeywordSearch(keyword) - + def UseConfig(self, config, rootpath=""): return self.GetHelpWindow().UseConfig(config, rootpath) def ReadCustomization(self, config, rootpath=""): @@ -1406,7 +1562,7 @@ public: // Turn it back on again %typemap(out) wxHtmlHelpDialog* { $result = wxPyMake_wxObject($1, $owner); } - + bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxPyEmptyString, int style = wxHF_DEFAULT_STYLE); @@ -1417,7 +1573,9 @@ public: wxHtmlHelpController* GetController() const; /// Sets the controller associated with this dialog. + %disownarg( wxHtmlHelpController* controller ); void SetController(wxHtmlHelpController* controller); + %cleardisown( wxHtmlHelpController* controller ); /// Returns the help window. wxHtmlHelpWindow* GetHelpWindow() const; @@ -1533,8 +1691,6 @@ public: void MakeModalIfNeeded(); wxWindow* FindTopLevelWindow(); - - %pythoncode { def Destroy(self): pass } };