X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fb757066dfea26412c518153f7c4af05a8a43dc9..d211a853c520116600acfb562dcb8a6b184de993:/wxPython/src/html.i diff --git a/wxPython/src/html.i b/wxPython/src/html.i index 970911807b..7b36eca332 100644 --- a/wxPython/src/html.i +++ b/wxPython/src/html.i @@ -10,8 +10,11 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +%define DOCSTRING +"Classes for a simple HTML rendering window, HTML Help Window, etc." +%enddef -%module html +%module(package="wx", docstring=DOCSTRING) html %{ #include "wx/wxPython/wxPython.h" @@ -22,30 +25,28 @@ #include #include #include +#include +#include +#include - - DECLARE_DEF_STRING(EmptyString); - static const wxChar* wxHtmlWindowNameStr = wxT("htmlWindow"); - DECLARE_DEF_STRING(HtmlWindowNameStr); - static const wxChar* wxHtmlPrintoutTitleStr = wxT("Printout"); - DECLARE_DEF_STRING(HtmlPrintoutTitleStr); - static const wxChar* wxHtmlPrintingTitleStr = wxT("Printing"); - DECLARE_DEF_STRING(HtmlPrintingTitleStr); - %} + //--------------------------------------------------------------------------- %import windows.i -%pythoncode { wx = core } +%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")) +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 @@ -135,7 +136,7 @@ public: wxString GetName(); bool HasParam(const wxString& par); - wxString GetParam(const wxString& par, int with_commas = False); + wxString GetParam(const wxString& par, int with_commas = false); // Can't do this one as-is, but GetParam should be enough... //int ScanParam(const wxString& par, const char *format, void* param); @@ -171,6 +172,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); }; @@ -185,6 +191,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 { @@ -197,6 +206,13 @@ public: } } + // Sets font sizes to be relative to the given size or the system + // default size; use either specified or default font + void SetStandardFonts(int size = -1, + const wxString& normal_face = wxPyEmptyString, + const wxString& fixed_face = wxPyEmptyString); + + wxHtmlContainerCell* GetContainer(); wxHtmlContainerCell* OpenContainer(); wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c); @@ -218,6 +234,10 @@ public: void SetLinkColor(const wxColour& clr); wxColour GetActualColor(); void SetActualColor(const wxColour& clr); + %pythoncode { + GetActualColour = GetActualColor + SetActualColour = SetActualColor + } void SetLink(const wxString& link); wxFont* CreateCurrentFont(); wxHtmlLinkInfo GetLink(); @@ -229,7 +249,7 @@ public: %{ class wxPyHtmlTagHandler : public wxHtmlTagHandler { - DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler); + DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler) public: wxPyHtmlTagHandler() : wxHtmlTagHandler() {}; @@ -249,9 +269,10 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag); %} -%name(HtmlTagHandler) class wxPyHtmlTagHandler : public wxObject { +%rename(HtmlTagHandler) wxPyHtmlTagHandler; +class wxPyHtmlTagHandler : public wxObject { public: - %addtofunc wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)" + %pythonAppend wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)" wxPyHtmlTagHandler(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -266,7 +287,7 @@ public: %{ class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler { - DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler); + DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler) public: wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {}; @@ -287,9 +308,10 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleT %} -%name(HtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler { +%rename(HtmlWinTagHandler) wxPyHtmlWinTagHandler; +class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler { public: - %addtofunc wxPyHtmlWinTagHandler "self._setCallbackInfo(self, HtmlWinTagHandler)" + %pythonAppend wxPyHtmlWinTagHandler "self._setCallbackInfo(self, HtmlWinTagHandler)" wxPyHtmlWinTagHandler(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -314,32 +336,32 @@ public: } void OnExit() { - wxPyBeginBlockThreads(); + wxPyBlock_t blocked = 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(); + wxPyEndBlockThreads(blocked); }; void FillHandlersTable(wxHtmlWinParser *parser) { // Wave our magic wand... (if it works it's a miracle! ;-) // First, make a new instance of the tag handler - wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); PyObject* arg = PyTuple_New(0); PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg); Py_DECREF(arg); - + // now figure out where it's C++ object is... wxPyHtmlWinTagHandler* thPtr; if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler"))) { - wxPyEndBlockThreads(); + wxPyEndBlockThreads(blocked); return; } - wxPyEndBlockThreads(); + wxPyEndBlockThreads(blocked); // add it, parser->AddTagHandler(thPtr); @@ -367,6 +389,10 @@ private: //--------------------------------------------------------------------------- + +%typemap(out) wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); } +%typemap(out) const wxHtmlCell* { $result = wxPyMake_wxObject($1, $owner); } + //--------------------------------------------------------------------------- %newgroup @@ -382,7 +408,7 @@ public: void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell, const wxPoint& toPos, const wxHtmlCell *toCell); - %name(SetCells)void Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell); + %Rename(SetCells, void, Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell)); const wxHtmlCell *GetFromCell() const; const wxHtmlCell *GetToCell() const; @@ -482,20 +508,37 @@ 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(); int GetWidth(); int GetHeight(); int GetDescent(); + + // Returns the maximum possible length of the cell. + // Call Layout at least once before using GetMaxTotalWidth() + int GetMaxTotalWidth() const; + + const wxString& GetId() const; + void SetId(const wxString& id); 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: + 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. @@ -503,7 +546,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); @@ -513,7 +560,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? @@ -532,7 +585,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. @@ -558,6 +617,9 @@ class wxHtmlWordCell : public wxHtmlCell { public: wxHtmlWordCell(const wxString& word, wxDC& dc); + wxString ConvertToText(wxHtmlSelection *sel) const; + bool IsLinebreakAllowed() const; + void SetPreviousWord(wxHtmlWordCell *cell); }; @@ -565,7 +627,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); @@ -575,7 +640,7 @@ public: int GetIndentUnits(int ind); void SetAlign(const wxHtmlTag& tag); void SetWidthFloat(int w, int units); - %name(SetWidthFloatFromTag)void SetWidthFloat(const wxHtmlTag& tag); + %Rename(SetWidthFloatFromTag, void, SetWidthFloat(const wxHtmlTag& tag)); void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP); void SetBackgroundColour(const wxColour& clr); wxColour GetBackgroundColour(); @@ -588,7 +653,7 @@ public: class wxHtmlColourCell : public wxHtmlCell { public: - wxHtmlColourCell(wxColour clr, int flags = wxHTML_CLR_FOREGROUND); + wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND); }; @@ -617,21 +682,21 @@ public: %{ // here's the C++ version class wxPyHtmlFilter : public wxHtmlFilter { - DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter); + DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter) public: 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 rval = false; bool found; - wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) { - PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file); // cast away const + PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false); // cast away const rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj)); Py_DECREF(obj); } - wxPyEndBlockThreads(); + wxPyEndBlockThreads(blocked); return rval; } @@ -641,9 +706,9 @@ public: virtual wxString ReadFile(const wxFSFile& file) const { wxString rval; bool found; - wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) { - PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file); // cast away const + PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false); // cast away const PyObject* ro; ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(O)", obj)); Py_DECREF(obj); @@ -652,7 +717,7 @@ public: Py_DECREF(ro); } } - wxPyEndBlockThreads(); + wxPyEndBlockThreads(blocked); return rval; } @@ -665,9 +730,10 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter); // And now the version seen by SWIG -%name(HtmlFilter) class wxPyHtmlFilter : public wxObject { +%rename(HtmlFilter) wxPyHtmlFilter; +class wxPyHtmlFilter : public wxObject { public: - %addtofunc wxPyHtmlFilter "self._setCallbackInfo(self, HtmlFilter)" + %pythonAppend wxPyHtmlFilter "self._setCallbackInfo(self, HtmlFilter)" wxPyHtmlFilter(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -678,13 +744,94 @@ 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); + DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow) public: wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, @@ -704,7 +851,6 @@ public: } void OnLinkClicked(const wxHtmlLinkInfo& link); - void base_OnLinkClicked(const wxHtmlLinkInfo& link); wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type, const wxString& url, @@ -712,31 +858,29 @@ 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) { bool found; - wxPyBeginBlockThreads(); + wxPyBlock_t blocked = 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); } - wxPyEndBlockThreads(); + wxPyEndBlockThreads(blocked); if (! found) wxHtmlWindow::OnLinkClicked(link); } -void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) { - wxHtmlWindow::OnLinkClicked(link); -} wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, @@ -744,7 +888,7 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, wxString *redirect) const { bool found; wxHtmlOpeningStatus rval; - wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) { PyObject* ro; PyObject* s = wx2PyString(url); @@ -765,7 +909,7 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, } Py_DECREF(ro); } - wxPyEndBlockThreads(); + wxPyEndBlockThreads(blocked); if (! found) rval = wxHtmlWindow::OnOpeningURL(type, url, redirect); return rval; @@ -776,17 +920,27 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, -%name(HtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow { +MustHaveApp(wxPyHtmlWindow); + +%rename(HtmlWindow) wxPyHtmlWindow; +class wxPyHtmlWindow : public wxScrolledWindow //, + // public wxHtmlWindowInterface //, + // public wxHtmlWindowMouseHelper +{ public: - %addtofunc wxPyHtmlWindow "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)" - %addtofunc wxPyHtmlWindow() "" - + %pythonAppend wxPyHtmlWindow "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)" + %pythonAppend wxPyHtmlWindow() "" + %typemap(out) wxPyHtmlWindow*; // turn off this typemap + wxPyHtmlWindow(wxWindow *parent, int id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, int style=wxHW_DEFAULT_STYLE, const wxString& name = wxPyHtmlWindowNameStr); - %name(PreHtmlWindow)wxPyHtmlWindow(); + %RenameCtor(PreHtmlWindow, wxPyHtmlWindow()); + + // Turn it back on again + %typemap(out) wxPyHtmlWindow* { $result = wxPyMake_wxObject($1, $owner); } bool Create(wxWindow *parent, int id = -1, const wxPoint& pos = wxDefaultPosition, @@ -797,11 +951,11 @@ public: void _setCallbackInfo(PyObject* self, PyObject* _class); - + // 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 + // Return value : False if an error occurred, True otherwise bool SetPage(const wxString& source); // Load HTML page from given location. Location can be either @@ -850,11 +1004,23 @@ public: } } - void SetTitle(const wxString& title); + // Sets font sizes to be relative to the given size or the system + // default size; use either specified or default font + void SetStandardFonts(int size = -1, + const wxString& normal_face = wxPyEmptyString, + const wxString& fixed_face = wxPyEmptyString); + + DocDeclStr( + void, SetLabel(const wxString& title), + "", ""); // Sets space between text and window borders. void SetBorders(int b); + // Sets the bitmap to use for background (currnetly it will be tiled, + // when/if we have CSS support we could add other possibilities...) + void SetBackgroundImage(const wxBitmap& bmpBg); + // 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. @@ -883,13 +1049,65 @@ public: //Adds input filter static void AddFilter(wxPyHtmlFilter *filter); + // Helper functions to select parts of page: + void SelectWord(const wxPoint& pos); + void SelectLine(const wxPoint& pos); + void SelectAll(); + + // Convert selection to text: + wxString SelectionToText(); + + // Converts current page to text: + wxString ToText(); + + 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 + }; - 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); + // 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; + }; @@ -900,6 +1118,8 @@ public: %newgroup +MustHaveApp(wxHtmlDCRenderer); + class wxHtmlDCRenderer : public wxObject { public: wxHtmlDCRenderer(); @@ -909,7 +1129,7 @@ public: void SetSize(int width, int height); void SetHtmlText(const wxString& html, const wxString& basepath = wxPyEmptyString, - bool isdir = True); + bool isdir = true); // Sets fonts to be used when displaying HTML page. (if size null then default sizes used). %extend { void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) { @@ -920,10 +1140,15 @@ public: 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 - ); + + // Sets font sizes to be relative to the given size or the system + // default size; use either specified or default font + void SetStandardFonts(int size = -1, + const wxString& normal_face = wxPyEmptyString, + const wxString& fixed_face = wxPyEmptyString); + + 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) @@ -937,6 +1162,8 @@ enum { }; +MustHaveApp(wxHtmlPrintout); + class wxHtmlPrintout : public wxPyPrintout { public: wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr); @@ -944,11 +1171,11 @@ public: void SetHtmlText(const wxString& html, const wxString &basepath = wxPyEmptyString, - bool isdir = True); + 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). %extend { void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) { @@ -959,6 +1186,13 @@ public: delete [] temp; } } + + // Sets font sizes to be relative to the given size or the system + // default size; use either specified or default font + void SetStandardFonts(int size = -1, + const wxString& normal_face = wxPyEmptyString, + const wxString& fixed_face = wxPyEmptyString); + void SetMargins(float top = 25.2, float bottom = 25.2, float left = 25.2, float right = 25.2, float spaces = 5); @@ -972,6 +1206,8 @@ public: +MustHaveApp(wxHtmlEasyPrinting); + class wxHtmlEasyPrinting : public wxObject { public: wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr, @@ -982,7 +1218,7 @@ public: void PreviewText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString); void PrintFile(const wxString &htmlfile); void PrintText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString); - void PrinterSetup(); +// void PrinterSetup(); void PageSetup(); void SetHeader(const wxString& header, int pg = wxPAGE_ALL); void SetFooter(const wxString& footer, int pg = wxPAGE_ALL); @@ -997,6 +1233,12 @@ public: } } + // Sets font sizes to be relative to the given size or the system + // default size; use either specified or default font + void SetStandardFonts(int size = -1, + const wxString& normal_face = wxPyEmptyString, + const wxString& fixed_face = wxPyEmptyString); + wxPrintData *GetPrintData() {return m_PrintData;} wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;} @@ -1030,7 +1272,8 @@ public: }; //--------------------------------------------------------------------------- - +// WXWIN_COMPATIBILITY_2_4 +#if 0 struct wxHtmlContentsItem { %extend { @@ -1041,7 +1284,7 @@ struct wxHtmlContentsItem wxHtmlBookRecord* GetBook() { return self->m_Book; } } }; - +#endif //--------------------------------------------------------------------------- class wxHtmlSearchStatus @@ -1054,7 +1297,6 @@ public: int GetCurIndex(); int GetMaxIndex(); const wxString& GetName(); - wxHtmlContentsItem* GetContentsItem(); }; //--------------------------------------------------------------------------- @@ -1077,73 +1319,397 @@ public: // TODO: this one needs fixed... const wxHtmlBookRecArray& GetBookRecArray(); - wxHtmlContentsItem* GetContents(); - int GetContentsCnt(); - wxHtmlContentsItem* GetIndex(); - int GetIndexCnt(); }; //--------------------------------------------------------------------------- +enum { + wxHF_TOOLBAR, + wxHF_CONTENTS, + wxHF_INDEX, + wxHF_SEARCH, + wxHF_BOOKMARKS, + wxHF_OPEN_FILES, + wxHF_PRINT, + wxHF_FLAT_TOOLBAR, + wxHF_MERGE_BOOKS, + wxHF_ICONS_BOOK, + wxHF_ICONS_BOOK_CHAPTER, + wxHF_ICONS_FOLDER, + wxHF_DEFAULT_STYLE, + + wxHF_EMBEDDED, + wxHF_DIALOG, + wxHF_FRAME, + wxHF_MODAL, +}; + +enum { + wxID_HTML_PANEL, + wxID_HTML_BACK, + wxID_HTML_FORWARD, + wxID_HTML_UPNODE, + wxID_HTML_UP, + wxID_HTML_DOWN, + wxID_HTML_PRINT, + wxID_HTML_OPENFILE, + wxID_HTML_OPTIONS, + wxID_HTML_BOOKMARKSLIST, + wxID_HTML_BOOKMARKSADD, + wxID_HTML_BOOKMARKSREMOVE, + wxID_HTML_TREECTRL, + wxID_HTML_INDEXPAGE, + wxID_HTML_INDEXLIST, + wxID_HTML_INDEXTEXT, + wxID_HTML_INDEXBUTTON, + wxID_HTML_INDEXBUTTONALL, + wxID_HTML_NOTEBOOK, + wxID_HTML_SEARCHPAGE, + wxID_HTML_SEARCHTEXT, + wxID_HTML_SEARCHLIST, + wxID_HTML_SEARCHBUTTON, + wxID_HTML_SEARCHCHOICE, + wxID_HTML_COUNTINFO +}; + + + +MustHaveApp(wxHtmlHelpWindow); + +class wxHtmlHelpWindow : public wxWindow +{ +public: + %pythonAppend wxHtmlHelpWindow "self._setOORInfo(self)" + %pythonAppend wxHtmlHelpWindow() "" + %typemap(out) wxHtmlHelpWindow*; // turn off this typemap + + wxHtmlHelpWindow(wxWindow* parent, wxWindowID wxWindowID, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int style = wxTAB_TRAVERSAL|wxNO_BORDER, + 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); } + + bool Create(wxWindow* parent, wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int style = wxTAB_TRAVERSAL|wxNO_BORDER, + int helpStyle = wxHF_DEFAULT_STYLE); + + 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. + // Looking for the page runs in these steps: + // 1. try to locate file named x (if x is for example "doc/howto.htm") + // 2. try to open starting page of book x + // 3. try to find x in contents (if x is for example "How To ...") + // 4. try to find x in index (if x is for example "How To ...") + bool Display(const wxString& x); + + // Alternative version that works with numeric ID. + // (uses extension to MS format, , see docs) + %Rename(DisplayID, bool, Display(int id)); + + // Displays help window and focuses contents. + bool DisplayContents(); + + // Displays help window and focuses index. + bool DisplayIndex(); + + // Searches for keyword. Returns true and display page if found, return + // false otherwise + // Syntax of keyword is Altavista-like: + // * words are separated by spaces + // (but "\"hello world\"" is only one world "hello world") + // * word may be pretended by + or - + // (+ : page must contain the word ; - : page can't contain the word) + // * if there is no + or - before the word, + is default + bool KeywordSearch(const wxString& keyword, + wxHelpSearchMode mode = wxHELP_SEARCH_ALL); + + void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString); + + // 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, const wxString& path = wxEmptyString); + void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); + + // call this to let wxHtmlHelpWindow know page changed + void NotifyPageChanged(); + + // Refreshes Contents and Index tabs + void RefreshLists(); + + // Gets the HTML window + wxHtmlWindow* GetHtmlWindow() const; + + // Gets the splitter window + wxSplitterWindow* GetSplitterWindow(); + + // Gets the toolbar + wxToolBar* GetToolBar() const; + + // Gets the configuration data + wxHtmlHelpFrameCfg& GetCfgData(); + + // Gets the tree control + wxTreeCtrl *GetTreeCtrl() const; + +}; + + +class wxHtmlWindowEvent: public wxNotifyEvent +{ +public: + wxHtmlWindowEvent(wxEventType commandType = wxEVT_NULL, int id = 0): + wxNotifyEvent(commandType, id); + + void SetURL(const wxString& url); + const wxString& GetURL() const; +}; + + + +MustHaveApp(wxHtmlHelpFrame); + class wxHtmlHelpFrame : public wxFrame { public: - %addtofunc wxHtmlHelpFrame "self._setOORInfo(self)" - + %pythonAppend wxHtmlHelpFrame "self._setOORInfo(self)" + %pythonAppend wxHtmlHelpFrame() "" + %typemap(out) wxHtmlHelpFrame*; // turn off this typemap + wxHtmlHelpFrame(wxWindow* parent, int wxWindowID, const wxString& title = wxPyEmptyString, int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL); + %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); wxHtmlHelpData* GetData(); void SetTitleFormat(const wxString& format); - void Display(const wxString& x); - %name(DisplayID) void Display(int id); - void DisplayContents(); - void DisplayIndex(); - bool KeywordSearch(const wxString& keyword); - void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString); - void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); - void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); + + void AddGrabIfNeeded(); + + /// Returns the help controller associated with the window. + 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; + + %pythoncode { + %# For compatibility from before the refactor + def Display(self, x): + return self.GetHelpWindow().Display(x) + def DisplayID(self, x): + return self.GetHelpWindow().DisplayID(id) + def DisplayContents(self): + return self.GetHelpWindow().DisplayContents() + def DisplayIndex(self): + return self.GetHelpWindow().DisplayIndex() + + 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=""): + return self.GetHelpWindow().ReadCustomization(config, rootpath) + def WriteCustomization(self, config, rootpath=""): + return self.GetHelpWindow().WriteCustomization(config, rootpath) + %} +}; + + + +MustHaveApp(wxHtmlHelpDialog); + +class wxHtmlHelpDialog : public wxDialog +{ +public: + %pythonAppend wxHtmlHelpDialog "self._setOORInfo(self)" + %pythonAppend wxHtmlHelpDialog() "" + %typemap(out) wxHtmlHelpDialog*; // turn off this typemap + + wxHtmlHelpDialog(wxWindow* parent, wxWindowID wxWindowID, + const wxString& title = wxPyEmptyString, + int style = wxHF_DEFAULT_STYLE, wxHtmlHelpData* data = NULL); + %RenameCtor(PreHtmlHelpDialog, wxHtmlHelpDialog(wxHtmlHelpData* data = NULL)); + + // 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); + + /// Returns the data associated with this dialog. + wxHtmlHelpData* GetData(); + + /// Returns the controller that created this dialog. + 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; + + // Sets format of title of the frame. Must contain exactly one "%s" + // (for title of displayed HTML page) + void SetTitleFormat(const wxString& format); + + // Override to add custom buttons to the toolbar +// virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {}; + }; //--------------------------------------------------------------------------- -enum { - wxHF_TOOLBAR, - wxHF_FLATTOOLBAR, - wxHF_CONTENTS, - wxHF_INDEX, - wxHF_SEARCH, - wxHF_BOOKMARKS, - wxHF_OPENFILES, - wxHF_PRINT, - wxHF_DEFAULTSTYLE, +// TODO: Make virtual methods of this class overridable in Python. + +MustHaveApp(wxHelpControllerBase); + +class wxHelpControllerBase: public wxObject +{ +public: +// wxHelpControllerBase(wxWindow* parentWindow = NULL); +// ~wxHelpControllerBase(); + + %nokwargs Initialize; + virtual bool Initialize(const wxString& file, int server ); + virtual bool Initialize(const wxString& file); + + virtual void SetViewer(const wxString& viewer, long flags = 0); + + // If file is "", reloads file given in Initialize + virtual bool LoadFile(const wxString& file = wxEmptyString) /* = 0 */; + + // Displays the contents + virtual bool DisplayContents(void) /* = 0 */; + + %nokwargs DisplaySection; + + // Display the given section + virtual bool DisplaySection(int sectionNo) /* = 0 */; + + // Display the section using a context id + virtual bool DisplayContextPopup(int contextId); + + // Display the text in a popup, if possible + virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos); + + // By default, uses KeywordSection to display a topic. Implementations + // may override this for more specific behaviour. + virtual bool DisplaySection(const wxString& section); + + virtual bool DisplayBlock(long blockNo) /* = 0 */; + virtual bool KeywordSearch(const wxString& k, + wxHelpSearchMode mode = wxHELP_SEARCH_ALL) /* = 0 */; + + /// Allows one to override the default settings for the help frame. + virtual void SetFrameParameters(const wxString& title, + const wxSize& size, + const wxPoint& pos = wxDefaultPosition, + bool newFrameEachTime = false); + + /// Obtains the latest settings used by the help frame and the help + /// frame. + virtual wxFrame *GetFrameParameters(wxSize *size = NULL, + wxPoint *pos = NULL, + bool *newFrameEachTime = NULL); + + virtual bool Quit() /* = 0 */; + + virtual void OnQuit(); + + /// Set the window that can optionally be used for the help window's parent. + virtual void SetParentWindow(wxWindow* win); + + /// Get the window that can optionally be used for the help window's parent. + virtual wxWindow* GetParentWindow() const; + }; -class wxHtmlHelpController : public wxEvtHandler { + + +MustHaveApp(wxHtmlHelpController); + +class wxHtmlHelpController : public wxHelpControllerBase +{ public: - %addtofunc wxHtmlHelpController "self._setOORInfo(self)" - - wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE); +// %pythonAppend wxHtmlHelpController "self._setOORInfo(self)" + + wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE, wxWindow* parentWindow = NULL); ~wxHtmlHelpController(); + wxHtmlHelpWindow* GetHelpWindow(); + void SetHelpWindow(wxHtmlHelpWindow* helpWindow); + + wxHtmlHelpFrame* GetFrame(); + wxHtmlHelpDialog* GetDialog(); + void SetTitleFormat(const wxString& format); void SetTempDir(const wxString& path); - bool AddBook(const wxString& book, int show_wait_msg = False); + bool AddBook(const wxString& book, int show_wait_msg = false); void Display(const wxString& x); - %name(DisplayID) void Display(int id); + %Rename(DisplayID, void, Display(int id)); void DisplayContents(); void DisplayIndex(); bool KeywordSearch(const wxString& keyword); void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString); void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); - wxHtmlHelpFrame* GetFrame(); + + void MakeModalIfNeeded(); + wxWindow* FindTopLevelWindow(); }; +/* + * wxHtmlModalHelp + * A convenience class particularly for use on wxMac, + * where you can only show modal dialogs from a modal + * dialog. + * + * Use like this: + * + * wxHtmlModalHelp help(parent, filename, topic); + * + * If topic is empty, the help contents is displayed. + */ + +class wxHtmlModalHelp +{ +public: + wxHtmlModalHelp(wxWindow* parent, const wxString& helpFile, + const wxString& topic = wxEmptyString, + int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL); +}; //---------------------------------------------------------------------------