X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/089142a562148d69dbccfba669b66eff78a7f5b5..5f24651b5c1f73881e89de9f67ecfad696af8d4b:/wxPython/src/html.i diff --git a/wxPython/src/html.i b/wxPython/src/html.i index 5c2e764a1f..e667d46e98 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" @@ -29,7 +32,8 @@ //--------------------------------------------------------------------------- %import windows.i -%pythoncode { wx = core } +%pythoncode { wx = _core } +%pythoncode { __docfilter__ = wx.__DocFilter(globals()) } %include _html_rename.i @@ -133,7 +137,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); @@ -195,6 +199,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); @@ -249,7 +260,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag); %name(HtmlTagHandler) class wxPyHtmlTagHandler : public wxObject { public: - %addtofunc wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)" + %pythonAppend wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)" wxPyHtmlTagHandler(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -287,7 +298,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleT %name(HtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler { public: - %addtofunc wxPyHtmlWinTagHandler "self._setCallbackInfo(self, HtmlWinTagHandler)" + %pythonAppend wxPyHtmlWinTagHandler "self._setCallbackInfo(self, HtmlWinTagHandler)" wxPyHtmlWinTagHandler(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -312,21 +323,21 @@ public: } void OnExit() { - wxPyBeginBlockThreads(); + bool 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(); + bool blocked = wxPyBeginBlockThreads(); PyObject* arg = PyTuple_New(0); PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg); Py_DECREF(arg); @@ -334,10 +345,10 @@ public: // 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); @@ -487,6 +498,11 @@ public: 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); @@ -623,15 +639,15 @@ public: // 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(); + bool 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 +657,9 @@ public: virtual wxString ReadFile(const wxFSFile& file) const { wxString rval; bool found; - wxPyBeginBlockThreads(); + bool 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 +668,7 @@ public: Py_DECREF(ro); } } - wxPyEndBlockThreads(); + wxPyEndBlockThreads(blocked); return rval; } @@ -667,7 +683,7 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter); %name(HtmlFilter) class wxPyHtmlFilter : public wxObject { public: - %addtofunc wxPyHtmlFilter "self._setCallbackInfo(self, HtmlFilter)" + %pythonAppend wxPyHtmlFilter "self._setCallbackInfo(self, HtmlFilter)" wxPyHtmlFilter(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -724,13 +740,13 @@ IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked); void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) { bool found; - wxPyBeginBlockThreads(); + bool 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); } @@ -744,7 +760,7 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, wxString *redirect) const { bool found; wxHtmlOpeningStatus rval; - wxPyBeginBlockThreads(); + bool blocked = wxPyBeginBlockThreads(); if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) { PyObject* ro; PyObject* s = wx2PyString(url); @@ -765,7 +781,7 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, } Py_DECREF(ro); } - wxPyEndBlockThreads(); + wxPyEndBlockThreads(blocked); if (! found) rval = wxHtmlWindow::OnOpeningURL(type, url, redirect); return rval; @@ -776,10 +792,13 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, +MustHaveApp(wxPyHtmlWindow); + %name(HtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow { 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, @@ -788,6 +807,9 @@ public: const wxString& name = wxPyHtmlWindowNameStr); %name(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, const wxSize& size = wxDefaultSize, @@ -850,7 +872,15 @@ 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, SetTitle(const wxString& title), + "", ""); // Sets space between text and window borders. void SetBorders(int b); @@ -883,13 +913,26 @@ 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 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); + + static wxVisualAttributes + GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); }; @@ -900,6 +943,8 @@ public: %newgroup +MustHaveApp(wxHtmlDCRenderer); + class wxHtmlDCRenderer : public wxObject { public: wxHtmlDCRenderer(); @@ -909,7 +954,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,7 +965,14 @@ public: delete [] temp; } } - int Render(int x, int y, int from = 0, int dont_render = False, int to = INT_MAX, + + // 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, 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 ); @@ -937,6 +989,8 @@ enum { }; +MustHaveApp(wxHtmlPrintout); + class wxHtmlPrintout : public wxPyPrintout { public: wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr); @@ -944,7 +998,7 @@ 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); @@ -959,6 +1013,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 +1033,8 @@ public: +MustHaveApp(wxHtmlEasyPrinting); + class wxHtmlEasyPrinting : public wxObject { public: wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr, @@ -997,6 +1060,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;} @@ -1085,9 +1154,11 @@ public: //--------------------------------------------------------------------------- +MustHaveApp(wxHtmlHelpFrame); + class wxHtmlHelpFrame : public wxFrame { public: - %addtofunc wxHtmlHelpFrame "self._setOORInfo(self)" + %pythonAppend wxHtmlHelpFrame "self._setOORInfo(self)" wxHtmlHelpFrame(wxWindow* parent, int wxWindowID, const wxString& title = wxPyEmptyString, @@ -1122,16 +1193,18 @@ enum { }; +MustHaveApp(wxHtmlHelpController); + class wxHtmlHelpController : public wxEvtHandler { public: - %addtofunc wxHtmlHelpController "self._setOORInfo(self)" + %pythonAppend wxHtmlHelpController "self._setOORInfo(self)" wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE); ~wxHtmlHelpController(); 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); void DisplayContents();