X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/80667df3944ff09dccd9007cabc6a27c11561226..f7a50432401c62a3300b0b9faa7e99d7ffe3d4e8:/wxPython/src/html.i diff --git a/wxPython/src/html.i b/wxPython/src/html.i index 8bccd1305e..28afc3d5fb 100644 --- a/wxPython/src/html.i +++ b/wxPython/src/html.i @@ -38,9 +38,6 @@ %pythoncode { wx = _core } %pythoncode { __docfilter__ = wx.__DocFilter(globals()) } -%include _html_rename.i - - MAKE_CONST_WXSTRING_NOSWIG(EmptyString); MAKE_CONST_WXSTRING2(HtmlWindowNameStr, wxT("htmlWindow")) MAKE_CONST_WXSTRING2(HtmlPrintoutTitleStr, wxT("Printout")) @@ -50,7 +47,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 @@ -81,14 +77,6 @@ enum { wxHTML_COND_ISIMAGEMAP, wxHTML_COND_USER, - - wxHTML_FONT_SIZE_1, - wxHTML_FONT_SIZE_2, - wxHTML_FONT_SIZE_3, - wxHTML_FONT_SIZE_4, - wxHTML_FONT_SIZE_5, - wxHTML_FONT_SIZE_6, - wxHTML_FONT_SIZE_7, }; @@ -129,6 +117,11 @@ public: void SetEvent(const wxMouseEvent *e); void SetHtmlCell(const wxHtmlCell * e); + + %property(Event, GetEvent, SetEvent, doc="See `GetEvent` and `SetEvent`"); + %property(Href, GetHref, doc="See `GetHref`"); + %property(HtmlCell, GetHtmlCell, SetHtmlCell, doc="See `GetHtmlCell` and `SetHtmlCell`"); + %property(Target, GetTarget, doc="See `GetTarget`"); }; //--------------------------------------------------------------------------- @@ -150,6 +143,12 @@ public: int GetBeginPos(); int GetEndPos1(); int GetEndPos2(); + + %property(AllParams, GetAllParams, doc="See `GetAllParams`"); + %property(BeginPos, GetBeginPos, doc="See `GetBeginPos`"); + %property(EndPos1, GetEndPos1, doc="See `GetEndPos1`"); + %property(EndPos2, GetEndPos2, doc="See `GetEndPos2`"); + %property(Name, GetName, doc="See `GetName`"); }; //--------------------------------------------------------------------------- @@ -176,6 +175,14 @@ 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); + + %property(FS, GetFS, SetFS, doc="See `GetFS` and `SetFS`"); + %property(Source, GetSource, doc="See `GetSource`"); }; @@ -190,6 +197,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 { @@ -238,6 +248,21 @@ public: wxFont* CreateCurrentFont(); wxHtmlLinkInfo GetLink(); + %property(ActualColor, GetActualColor, SetActualColor, doc="See `GetActualColor` and `SetActualColor`"); + %property(ActualColour, GetActualColour, SetActualColour, doc="See `GetActualColour` and `SetActualColour`"); + %property(Align, GetAlign, SetAlign, doc="See `GetAlign` and `SetAlign`"); + %property(CharHeight, GetCharHeight, doc="See `GetCharHeight`"); + %property(CharWidth, GetCharWidth, doc="See `GetCharWidth`"); + %property(Container, GetContainer, SetContainer, doc="See `GetContainer` and `SetContainer`"); + %property(DC, GetDC, SetDC, doc="See `GetDC` and `SetDC`"); + %property(FontBold, GetFontBold, SetFontBold, doc="See `GetFontBold` and `SetFontBold`"); + %property(FontFixed, GetFontFixed, SetFontFixed, doc="See `GetFontFixed` and `SetFontFixed`"); + %property(FontItalic, GetFontItalic, SetFontItalic, doc="See `GetFontItalic` and `SetFontItalic`"); + %property(FontSize, GetFontSize, SetFontSize, doc="See `GetFontSize` and `SetFontSize`"); + %property(FontUnderlined, GetFontUnderlined, SetFontUnderlined, doc="See `GetFontUnderlined` and `SetFontUnderlined`"); + %property(Link, GetLink, SetLink, doc="See `GetLink` and `SetLink`"); + %property(LinkColor, GetLinkColor, SetLinkColor, doc="See `GetLinkColor` and `SetLinkColor`"); + %property(WindowInterface, GetWindowInterface, doc="See `GetWindowInterface`"); }; @@ -245,7 +270,7 @@ public: %{ class wxPyHtmlTagHandler : public wxHtmlTagHandler { - DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler); + DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler) public: wxPyHtmlTagHandler() : wxHtmlTagHandler() {}; @@ -268,7 +293,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag); %rename(HtmlTagHandler) wxPyHtmlTagHandler; class wxPyHtmlTagHandler : public wxObject { public: - %pythonAppend wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)" + %pythonAppend wxPyHtmlTagHandler setCallbackInfo(HtmlTagHandler) wxPyHtmlTagHandler(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -276,6 +301,8 @@ public: void SetParser(wxHtmlParser *parser); wxHtmlParser* GetParser(); void ParseInner(const wxHtmlTag& tag); + + %property(Parser, GetParser, SetParser, doc="See `GetParser` and `SetParser`"); }; @@ -283,7 +310,7 @@ public: %{ class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler { - DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler); + DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler) public: wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {}; @@ -307,7 +334,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleT %rename(HtmlWinTagHandler) wxPyHtmlWinTagHandler; class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler { public: - %pythonAppend wxPyHtmlWinTagHandler "self._setCallbackInfo(self, HtmlWinTagHandler)" + %pythonAppend wxPyHtmlWinTagHandler setCallbackInfo(HtmlWinTagHandler) wxPyHtmlWinTagHandler(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -315,6 +342,8 @@ public: void SetParser(wxHtmlParser *parser); wxHtmlWinParser* GetParser(); void ParseInner(const wxHtmlTag& tag); + + %property(Parser, GetParser, SetParser, doc="See `GetParser` and `SetParser`"); }; @@ -385,6 +414,10 @@ private: //--------------------------------------------------------------------------- + +%typemap(out) wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); } +%typemap(out) const wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); } + //--------------------------------------------------------------------------- %newgroup @@ -418,6 +451,12 @@ public: const bool IsEmpty() const; + %property(FromCell, GetFromCell, doc="See `GetFromCell`"); + %property(FromPos, GetFromPos, doc="See `GetFromPos`"); + %property(FromPrivPos, GetFromPrivPos, SetFromPrivPos, doc="See `GetFromPrivPos` and `SetFromPrivPos`"); + %property(ToCell, GetToCell, doc="See `GetToCell`"); + %property(ToPos, GetToPos, doc="See `GetToPos`"); + %property(ToPrivPos, GetToPrivPos, SetToPrivPos, doc="See `GetToPrivPos` and `SetToPrivPos`"); }; @@ -445,6 +484,10 @@ public: const wxColour& GetFgColour() const; void SetBgColour(const wxColour& c); const wxColour& GetBgColour() const; + + %property(BgColour, GetBgColour, SetBgColour, doc="See `GetBgColour` and `SetBgColour`"); + %property(FgColour, GetFgColour, SetFgColour, doc="See `GetFgColour` and `SetFgColour`"); + %property(SelectionState, GetSelectionState, SetSelectionState, doc="See `GetSelectionState` and `SetSelectionState`"); }; @@ -456,14 +499,15 @@ class wxHtmlRenderingStyle public: virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0; virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0; + + %property(SelectedTextBgColour, GetSelectedTextBgColour, doc="See `GetSelectedTextBgColour`"); + %property(SelectedTextColour, GetSelectedTextColour, doc="See `GetSelectedTextColour`"); }; // Standard style: class wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle { public: - virtual wxColour GetSelectedTextColour(const wxColour& clr); - virtual wxColour GetSelectedTextBgColour(const wxColour& clr); }; @@ -484,6 +528,10 @@ public: wxHtmlRenderingStyle& GetStyle(); wxHtmlRenderingState& GetState(); + + %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`"); + %property(State, GetState, doc="See `GetState`"); + %property(Style, GetStyle, SetStyle, doc="See `GetStyle` and `SetStyle`"); }; //--------------------------------------------------------------------------- @@ -500,7 +548,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 +573,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 +586,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,7 +600,13 @@ public: wxHtmlRenderingInfo& info); const wxHtmlCell* Find(int condition, const void* param); - bool AdjustPagebreak(int* INOUT); + + virtual bool ProcessMouseClick(wxHtmlWindowInterface *window, + const wxPoint& pos, + const wxMouseEvent& event); + +// TODO: bool AdjustPagebreak(int* INOUT, +// wxArrayInt& known_pagebreaks); void SetCanLiveOnPagebreak(bool can); // Can the line be broken before this cell? @@ -557,7 +625,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. @@ -576,6 +650,24 @@ public: // 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; + + %property(Cursor, GetCursor, doc="See `GetCursor`"); + %property(Depth, GetDepth, doc="See `GetDepth`"); + %property(Descent, GetDescent, doc="See `GetDescent`"); + %property(FirstChild, GetFirstChild, doc="See `GetFirstChild`"); + %property(FirstTerminal, GetFirstTerminal, doc="See `GetFirstTerminal`"); + %property(Height, GetHeight, doc="See `GetHeight`"); + %property(Id, GetId, SetId, doc="See `GetId` and `SetId`"); + %property(LastTerminal, GetLastTerminal, doc="See `GetLastTerminal`"); + %property(Link, GetLink, SetLink, doc="See `GetLink` and `SetLink`"); + %property(MaxTotalWidth, GetMaxTotalWidth, doc="See `GetMaxTotalWidth`"); + %property(MouseCursor, GetMouseCursor, doc="See `GetMouseCursor`"); + %property(Next, GetNext, SetNext, doc="See `GetNext` and `SetNext`"); + %property(Parent, GetParent, SetParent, doc="See `GetParent` and `SetParent`"); + %property(PosX, GetPosX, doc="See `GetPosX`"); + %property(PosY, GetPosY, doc="See `GetPosY`"); + %property(RootCell, GetRootCell, doc="See `GetRootCell`"); + %property(Width, GetWidth, doc="See `GetWidth`"); }; @@ -583,6 +675,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 +685,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); @@ -607,6 +705,13 @@ public: void SetBorder(const wxColour& clr1, const wxColour& clr2); wxHtmlCell* GetFirstChild(); %pragma(python) addtoclass = "GetFirstCell = GetFirstChild" + + %property(AlignHor, GetAlignHor, SetAlignHor, doc="See `GetAlignHor` and `SetAlignHor`"); + %property(AlignVer, GetAlignVer, SetAlignVer, doc="See `GetAlignVer` and `SetAlignVer`"); + %property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`"); + %property(FirstChild, GetFirstChild, doc="See `GetFirstChild`"); + %property(Indent, GetIndent, SetIndent, doc="See `GetIndent` and `SetIndent`"); + %property(IndentUnits, GetIndentUnits, doc="See `GetIndentUnits`"); }; @@ -642,7 +747,7 @@ public: %{ // here's the C++ version class wxPyHtmlFilter : public wxHtmlFilter { - DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter); + DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter) public: wxPyHtmlFilter() : wxHtmlFilter() {} @@ -693,7 +798,7 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter); %rename(HtmlFilter) wxPyHtmlFilter; class wxPyHtmlFilter : public wxObject { public: - %pythonAppend wxPyHtmlFilter "self._setCallbackInfo(self, HtmlFilter)" + %pythonAppend wxPyHtmlFilter setCallbackInfo(HtmlFilter) wxPyHtmlFilter(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -704,13 +809,97 @@ 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; + + %property(HTMLBackgroundColour, GetHTMLBackgroundColour, SetHTMLBackgroundColour, doc="See `GetHTMLBackgroundColour` and `SetHTMLBackgroundColour`"); + %property(HTMLWindow, GetHTMLWindow, doc="See `GetHTMLWindow`"); +}; + + +//--------------------------------------------------------------------------- +// wxHtmlWindow //--------------------------------------------------------------------------- %newgroup +// TODO? +// wxHtmlWindowInterface and wxHtmlWindowMouseHelper + + %{ class wxPyHtmlWindow : public wxHtmlWindow { - DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow); + DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow) public: wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, @@ -730,7 +919,6 @@ public: } void OnLinkClicked(const wxHtmlLinkInfo& link); - void base_OnLinkClicked(const wxHtmlLinkInfo& link); wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type, const wxString& url, @@ -738,14 +926,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 +949,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,9 +991,12 @@ 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 "self._setOORInfo(self);" setCallbackInfo(HtmlWindow) %pythonAppend wxPyHtmlWindow() "" %typemap(out) wxPyHtmlWindow*; // turn off this typemap @@ -833,7 +1022,7 @@ public: // 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 + // specify document location, use LoadPage() instead // Return value : False if an error occurred, True otherwise bool SetPage(const wxString& source); @@ -939,15 +1128,60 @@ 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; + + %property(InternalRepresentation, GetInternalRepresentation, doc="See `GetInternalRepresentation`"); + %property(OpenedAnchor, GetOpenedAnchor, doc="See `GetOpenedAnchor`"); + %property(OpenedPage, GetOpenedPage, doc="See `GetOpenedPage`"); + %property(OpenedPageTitle, GetOpenedPageTitle, doc="See `GetOpenedPageTitle`"); + %property(Parser, GetParser, doc="See `GetParser`"); + %property(RelatedFrame, GetRelatedFrame, doc="See `GetRelatedFrame`"); }; @@ -987,13 +1221,13 @@ public: const wxString& normal_face = wxPyEmptyString, const wxString& fixed_face = wxPyEmptyString); - int Render(int x, int y, int from = 0, int dont_render = false, int maxHeight = INT_MAX, - //int *known_pagebreaks = NULL, int number_of_pages = 0 - int* choices=NULL, int LCOUNT = 0 - ); + int Render(int x, int y, wxArrayInt& known_pagebreaks, int from = 0, + int dont_render = FALSE, int to = INT_MAX); int GetTotalHeight(); // returns total height of the html document // (compare Render's return value with this) + + %property(TotalHeight, GetTotalHeight, doc="See `GetTotalHeight`"); }; @@ -1084,6 +1318,8 @@ public: wxPrintData *GetPrintData() {return m_PrintData;} wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;} + %property(PageSetupData, GetPageSetupData, doc="See `GetPageSetupData`"); + %property(PrintData, GetPrintData, doc="See `GetPrintData`"); }; @@ -1111,6 +1347,14 @@ public: void SetStart(const wxString& start); wxString GetFullPath(const wxString &page) const; + + %property(BasePath, GetBasePath, SetBasePath, doc="See `GetBasePath` and `SetBasePath`"); + %property(BookFile, GetBookFile, doc="See `GetBookFile`"); + %property(ContentsEnd, GetContentsEnd, doc="See `GetContentsEnd`"); + %property(ContentsStart, GetContentsStart, doc="See `GetContentsStart`"); + %property(FullPath, GetFullPath, doc="See `GetFullPath`"); + %property(Start, GetStart, SetStart, doc="See `GetStart` and `SetStart`"); + %property(Title, GetTitle, SetTitle, doc="See `GetTitle` and `SetTitle`"); }; //--------------------------------------------------------------------------- @@ -1139,10 +1383,10 @@ public: int GetCurIndex(); int GetMaxIndex(); const wxString& GetName(); - // WXWIN_COMPATIBILITY_2_4 -#if 0 - wxHtmlContentsItem* GetContentsItem(); -#endif + + %property(CurIndex, GetCurIndex, doc="See `GetCurIndex`"); + %property(MaxIndex, GetMaxIndex, doc="See `GetMaxIndex`"); + %property(Name, GetName, doc="See `GetName`"); }; //--------------------------------------------------------------------------- @@ -1165,13 +1409,7 @@ public: // TODO: this one needs fixed... const wxHtmlBookRecArray& GetBookRecArray(); - // WXWIN_COMPATIBILITY_2_4 -#if 0 - wxHtmlContentsItem* GetContents(); - int GetContentsCnt(); - wxHtmlContentsItem* GetIndex(); - int GetIndexCnt(); -#endif + %property(BookRecArray, GetBookRecArray, doc="See `GetBookRecArray`"); }; //--------------------------------------------------------------------------- @@ -1223,9 +1461,12 @@ enum { wxID_HTML_SEARCHBUTTON, wxID_HTML_SEARCHCHOICE, wxID_HTML_COUNTINFO -}; +}; +%{ + typedef wxTreeCtrl wxPyTreeCtrl; +%} MustHaveApp(wxHtmlHelpWindow); @@ -1243,7 +1484,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 +1496,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. @@ -1302,7 +1546,7 @@ public: void RefreshLists(); // Gets the HTML window - wxHtmlWindow* GetHtmlWindow() const; + wxPyHtmlWindow* GetHtmlWindow() const; // Gets the splitter window wxSplitterWindow* GetSplitterWindow(); @@ -1314,22 +1558,58 @@ public: wxHtmlHelpFrameCfg& GetCfgData(); // Gets the tree control - wxTreeCtrl *GetTreeCtrl() const; - + wxPyTreeCtrl *GetTreeCtrl() const; + + %property(CfgData, GetCfgData, doc="See `GetCfgData`"); + %property(Controller, GetController, SetController, doc="See `GetController` and `SetController`"); + %property(Data, GetData, doc="See `GetData`"); + %property(HtmlWindow, GetHtmlWindow, doc="See `GetHtmlWindow`"); + %property(SplitterWindow, GetSplitterWindow, doc="See `GetSplitterWindow`"); + %property(ToolBar, GetToolBar, doc="See `GetToolBar`"); + %property(TreeCtrl, GetTreeCtrl, doc="See `GetTreeCtrl`"); }; +//--------------------------------------------------------------------------- + -class wxHtmlWindowEvent: public wxNotifyEvent +%constant wxEventType wxEVT_COMMAND_HTML_CELL_CLICKED; +%constant wxEventType wxEVT_COMMAND_HTML_CELL_HOVER; +%constant wxEventType wxEVT_COMMAND_HTML_LINK_CLICKED; + + +class wxHtmlCellEvent : public wxCommandEvent { public: - wxHtmlWindowEvent(wxEventType commandType = wxEVT_NULL, int id = 0): - wxNotifyEvent(commandType, id); + wxHtmlCellEvent(wxEventType commandType, int id, + wxHtmlCell *cell, const wxPoint &pt, + const wxMouseEvent &ev); + + wxHtmlCell* GetCell() const; + wxPoint GetPoint() const; + wxMouseEvent GetMouseEvent() const; - void SetURL(const wxString& url); - const wxString& GetURL() const; + void SetLinkClicked(bool linkclicked); + bool GetLinkClicked() const; +}; + + +class wxHtmlLinkEvent : public wxCommandEvent +{ +public: + wxHtmlLinkEvent(int id, const wxHtmlLinkInfo &linkinfo); + + const wxHtmlLinkInfo &GetLinkInfo() const; }; +%pythoncode { + EVT_HTML_CELL_CLICKED = wx.PyEventBinder( wxEVT_COMMAND_HTML_CELL_CLICKED, 1 ) + EVT_HTML_CELL_HOVER = wx.PyEventBinder( wxEVT_COMMAND_HTML_CELL_HOVER, 1 ) + EVT_HTML_LINK_CLICKED = wx.PyEventBinder( wxEVT_COMMAND_HTML_LINK_CLICKED, 1 ) +} + +//--------------------------------------------------------------------------- + MustHaveApp(wxHtmlHelpFrame); @@ -1341,15 +1621,19 @@ public: wxHtmlHelpFrame(wxWindow* parent, int wxWindowID, const wxString& title = wxPyEmptyString, - int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL); + int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL, + wxConfigBase *config=NULL, + const wxString& rootpath = wxPyEmptyString); %RenameCtor(PreHtmlHelpFrame, wxHtmlHelpFrame(wxHtmlHelpData* data = NULL)); // 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); + int style = wxHF_DEFAULT_STYLE, + wxConfigBase *config=NULL, + const wxString& rootpath = wxPyEmptyString); wxHtmlHelpData* GetData(); void SetTitleFormat(const wxString& format); @@ -1360,7 +1644,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 +1664,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=""): @@ -1386,6 +1672,10 @@ public: def WriteCustomization(self, config, rootpath=""): return self.GetHelpWindow().WriteCustomization(config, rootpath) %} + + %property(Controller, GetController, SetController, doc="See `GetController` and `SetController`"); + %property(Data, GetData, doc="See `GetData`"); + %property(HelpWindow, GetHelpWindow, doc="See `GetHelpWindow`"); }; @@ -1406,7 +1696,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 +1707,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; @@ -1429,6 +1721,9 @@ public: // Override to add custom buttons to the toolbar // virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {}; + %property(Controller, GetController, SetController, doc="See `GetController` and `SetController`"); + %property(Data, GetData, doc="See `GetData`"); + %property(HelpWindow, GetHelpWindow, doc="See `GetHelpWindow`"); }; @@ -1498,6 +1793,7 @@ public: /// Get the window that can optionally be used for the help window's parent. virtual wxWindow* GetParentWindow() const; + %property(ParentWindow, GetParentWindow, SetParentWindow, doc="See `GetParentWindow` and `SetParentWindow`"); }; @@ -1534,7 +1830,9 @@ public: void MakeModalIfNeeded(); wxWindow* FindTopLevelWindow(); - %pythoncode { def Destroy(self): pass } + %property(Dialog, GetDialog, doc="See `GetDialog`"); + %property(Frame, GetFrame, doc="See `GetFrame`"); + %property(HelpWindow, GetHelpWindow, SetHelpWindow, doc="See `GetHelpWindow` and `SetHelpWindow`"); };