applied doc patch for wxPostEvent().

[wxWidgets.git] / wxPython / src / html.i

diff --git a/wxPython/src/html.i b/wxPython/src/html.i
index 91c2f78b700ef7c96020c4be5c8446b1f48e8065..59e6dc9c33be1c7786854fc05148ef9c036a02de 100644 (file)
--- a/wxPython/src/html.i
+++ b/wxPython/src/html.i
@@ -73,9 +73,30 @@ enum {
 };
 
 
 };
 
 

+enum {
+    wxHW_SCROLLBAR_NEVER,
+    wxHW_SCROLLBAR_AUTO,
+};
+
+
+// enums for wxHtmlWindow::OnOpeningURL
+enum wxHtmlOpeningStatus
+{
+    wxHTML_OPEN,
+    wxHTML_BLOCK,
+    wxHTML_REDIRECT
+};
+
+enum wxHtmlURLType
+{
+    wxHTML_URL_PAGE,
+    wxHTML_URL_IMAGE,
+    wxHTML_URL_OTHER
+};
+

 //---------------------------------------------------------------------------
 
 //---------------------------------------------------------------------------
 

-class wxHtmlLinkInfo {
+class wxHtmlLinkInfo : public wxObject {

 public:
     wxHtmlLinkInfo(const wxString& href, const wxString& target = wxEmptyString);
     wxString GetHref();
 public:
     wxHtmlLinkInfo(const wxString& href, const wxString& target = wxEmptyString);
     wxString GetHref();


@@ -89,7 +110,7 @@ public:
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

-class wxHtmlTag {
+class wxHtmlTag : public wxObject {

 public:
     // Never need to create a new tag from Python...
     //wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache);
 public:
     // Never need to create a new tag from Python...
     //wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache);


@@ -102,7 +123,6 @@ public:
     //int ScanParam(const wxString& par, const char *format, void* param);
 
     wxString GetAllParams();
     //int ScanParam(const wxString& par, const char *format, void* param);
 
     wxString GetAllParams();

-    bool IsEnding();

     bool HasEnding();
     int GetBeginPos();
     int GetEndPos1();
     bool HasEnding();
     int GetBeginPos();
     int GetEndPos1();


@@ -112,7 +132,7 @@ public:
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

-class wxHtmlParser {
+class wxHtmlParser : public wxObject {

 public:
     // wxHtmlParser();  This is an abstract base class...
 
 public:
     // wxHtmlParser();  This is an abstract base class...
 


@@ -128,6 +148,7 @@ public:
     void PushTagHandler(wxHtmlTagHandler* handler, wxString tags);
     void PopTagHandler();
 
     void PushTagHandler(wxHtmlTagHandler* handler, wxString tags);
     void PopTagHandler();
 

+    // virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const;

 
     // void AddText(const char* txt) = 0;
     // void AddTag(const wxHtmlTag& tag);
 
     // void AddText(const char* txt) = 0;
     // void AddTag(const wxHtmlTag& tag);


@@ -138,13 +159,13 @@ public:
 
 class wxHtmlWinParser : public wxHtmlParser {
 public:
 
 class wxHtmlWinParser : public wxHtmlParser {
 public:

-    wxHtmlWinParser(wxWindow *wnd);
+    wxHtmlWinParser(wxHtmlWindow *wnd = NULL);

 
     void SetDC(wxDC *dc);
     wxDC* GetDC();
     int GetCharHeight();
     int GetCharWidth();
 
     void SetDC(wxDC *dc);
     wxDC* GetDC();
     int GetCharHeight();
     int GetCharWidth();

-    wxWindow* GetWindow();
+    wxHtmlWindow* GetWindow();

     //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
     %addmethods {
         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
     //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
     %addmethods {
         void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {


@@ -173,9 +194,9 @@ public:
     void SetFontFixed(int x);
     int GetAlign();
     void SetAlign(int a);
     void SetFontFixed(int x);
     int GetAlign();
     void SetAlign(int a);

-    const wxColour& GetLinkColor();
+    wxColour GetLinkColor();

     void SetLinkColor(const wxColour& clr);
     void SetLinkColor(const wxColour& clr);

-    const wxColour& GetActualColor();
+    wxColour GetActualColor();

     void SetActualColor(const wxColour& clr);
     void SetLink(const wxString& link);
     wxFont* CreateCurrentFont();
     void SetActualColor(const wxColour& clr);
     void SetLink(const wxString& link);
     wxFont* CreateCurrentFont();


@@ -189,6 +210,7 @@ public:
 
 %{
 class wxPyHtmlTagHandler : public wxHtmlTagHandler {
 
 %{
 class wxPyHtmlTagHandler : public wxHtmlTagHandler {

+    DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler);

 public:
     wxPyHtmlTagHandler() : wxHtmlTagHandler() {};
 
 public:
     wxPyHtmlTagHandler() : wxHtmlTagHandler() {};
 


@@ -201,17 +223,19 @@ public:
     PYPRIVATE;
 };
 
     PYPRIVATE;
 };
 

+IMPLEMENT_DYNAMIC_CLASS(wxPyHtmlTagHandler, wxHtmlTagHandler);
+

 IMP_PYCALLBACK_STRING__pure(wxPyHtmlTagHandler, wxHtmlTagHandler, GetSupportedTags);
 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
 %}
 
 
 IMP_PYCALLBACK_STRING__pure(wxPyHtmlTagHandler, wxHtmlTagHandler, GetSupportedTags);
 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
 %}
 
 

-%name(wxHtmlTagHandler) class wxPyHtmlTagHandler {
+%name(wxHtmlTagHandler) class wxPyHtmlTagHandler : public wxObject {

 public:
     wxPyHtmlTagHandler();
 
 public:
     wxPyHtmlTagHandler();
 

-    void _setSelf(PyObject* self, PyObject* _class);
-    %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlTagHandler)"
+    void _setCallbackInfo(PyObject* self, PyObject* _class);
+    %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlTagHandler)"

 
     void SetParser(wxHtmlParser *parser);
     wxHtmlParser* GetParser();
 
     void SetParser(wxHtmlParser *parser);
     wxHtmlParser* GetParser();


@@ -223,6 +247,7 @@ public:
 
 %{
 class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler {
 
 %{
 class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler {

+    DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler);

 public:
     wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {};
 
 public:
     wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {};
 


@@ -236,6 +261,8 @@ public:
     PYPRIVATE;
 };
 
     PYPRIVATE;
 };
 

+IMPLEMENT_DYNAMIC_CLASS( wxPyHtmlWinTagHandler, wxHtmlWinTagHandler);
+

 IMP_PYCALLBACK_STRING__pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, GetSupportedTags);
 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleTag);
 %}
 IMP_PYCALLBACK_STRING__pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, GetSupportedTags);
 IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleTag);
 %}


@@ -245,8 +272,8 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleT
 public:
     wxPyHtmlWinTagHandler();
 
 public:
     wxPyHtmlWinTagHandler();
 

-    void _setSelf(PyObject* self, PyObject* _class);
-    %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlWinTagHandler)"
+    void _setCallbackInfo(PyObject* self, PyObject* _class);
+    %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWinTagHandler)"

 
     void SetParser(wxHtmlParser *parser);
     wxHtmlWinParser* GetParser();
 
     void SetParser(wxHtmlParser *parser);
     wxHtmlWinParser* GetParser();


@@ -268,25 +295,25 @@ public:
     }
 
     void OnExit() {
     }
 
     void OnExit() {

-        bool doSave = wxPyRestoreThread();
+        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);
         }
         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);
         }

-        wxPySaveThread(doSave);
+        wxPyEndBlockThreads();

     };
 
     void FillHandlersTable(wxHtmlWinParser *parser) {
         // Wave our magic wand...  (if it works it's a miracle!  ;-)
 
         // First, make a new instance of the tag handler
     };
 
     void FillHandlersTable(wxHtmlWinParser *parser) {
         // Wave our magic wand...  (if it works it's a miracle!  ;-)
 
         // First, make a new instance of the tag handler

-        bool doSave = wxPyRestoreThread();
+        wxPyBeginBlockThreads();

         PyObject* arg = Py_BuildValue("()");
         PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL);
         Py_DECREF(arg);
         PyObject* arg = Py_BuildValue("()");
         PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL);
         Py_DECREF(arg);

-        wxPySaveThread(doSave);
+        wxPyEndBlockThreads();

 
         // now figure out where it's C++ object is...
         wxPyHtmlWinTagHandler* thPtr;
 
         // now figure out where it's C++ object is...
         wxPyHtmlWinTagHandler* thPtr;


@@ -321,7 +348,7 @@ private:
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 

-class wxHtmlCell {
+class wxHtmlCell : public wxObject {

 public:
     wxHtmlCell();
 
 public:
     wxHtmlCell();
 


@@ -348,6 +375,13 @@ public:
 };
 
 
 };
 
 

+class  wxHtmlWordCell : public wxHtmlCell
+{
+public:
+    wxHtmlWordCell(const wxString& word, wxDC& dc);
+};
+
+

 class wxHtmlContainerCell : public wxHtmlCell {
 public:
     wxHtmlContainerCell(wxHtmlContainerCell *parent);
 class wxHtmlContainerCell : public wxHtmlCell {
 public:
     wxHtmlContainerCell(wxHtmlContainerCell *parent);


@@ -378,6 +412,12 @@ public:
 };
 
 
 };
 
 

+class  wxHtmlFontCell : public wxHtmlCell
+{
+public:
+    wxHtmlFontCell(wxFont *font);
+};
+

 
 class wxHtmlWidgetCell : public wxHtmlCell {
 public:
 
 class wxHtmlWidgetCell : public wxHtmlCell {
 public:


@@ -393,6 +433,7 @@ public:
 
 %{
 class wxPyHtmlWindow : public wxHtmlWindow {
 
 %{
 class wxPyHtmlWindow : public wxHtmlWindow {

+    DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow);

 public:
     wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1,
                    const wxPoint& pos = wxDefaultPosition,
 public:
     wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1,
                    const wxPoint& pos = wxDefaultPosition,


@@ -400,31 +441,79 @@ public:
                    long style = wxHW_SCROLLBAR_AUTO,
                    const wxString& name = "htmlWindow")
         : wxHtmlWindow(parent, id, pos, size, style, name)  {};
                    long style = wxHW_SCROLLBAR_AUTO,
                    const wxString& name = "htmlWindow")
         : wxHtmlWindow(parent, id, pos, size, style, name)  {};

+    wxPyHtmlWindow() : wxHtmlWindow() {};

 
     void OnLinkClicked(const wxHtmlLinkInfo& link);
     void base_OnLinkClicked(const wxHtmlLinkInfo& link);
 
 
     void OnLinkClicked(const wxHtmlLinkInfo& link);
     void base_OnLinkClicked(const wxHtmlLinkInfo& link);
 

+     wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
+                                      const wxString& url,
+                                      wxString *redirect) const;
+

     DEC_PYCALLBACK__STRING(OnSetTitle);
     DEC_PYCALLBACK__STRING(OnSetTitle);

+    DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover);
+    DEC_PYCALLBACK__CELLINTINTME(OnCellClicked);
+//     DEC_PYCALLBACK_BOOL_STRING(OnOpeningURL);

     PYPRIVATE;
 };
 
     PYPRIVATE;
 };
 

-
+IMPLEMENT_ABSTRACT_CLASS( wxPyHtmlWindow, wxHtmlWindow );

 IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle);
 IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle);

+IMP_PYCALLBACK__CELLINTINT(wxPyHtmlWindow, wxHtmlWindow, OnCellMouseHover);
+IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked);
+// IMP_PYCALLBACK_BOOL_STRING(wxPyHtmlWindow, wxHtmlWindow, OnOpeningURL);

 
 

- void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
-    bool doSave = wxPyRestoreThread();
-    if (wxPyCBH_findCallback(m_myInst, "OnLinkClicked")) {
+
+void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
+    bool found;
+    wxPyBeginBlockThreads();
+    if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) {

         PyObject* obj = wxPyConstructObject((void*)&link, "wxHtmlLinkInfo", 0);
         wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
         Py_DECREF(obj);
     }
         PyObject* obj = wxPyConstructObject((void*)&link, "wxHtmlLinkInfo", 0);
         wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
         Py_DECREF(obj);
     }

-    else
+    wxPyEndBlockThreads();
+    if (! found)

         wxHtmlWindow::OnLinkClicked(link);
         wxHtmlWindow::OnLinkClicked(link);

-    wxPySaveThread(doSave);

 }
 void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) {
     wxHtmlWindow::OnLinkClicked(link);
 }
 }
 void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) {
     wxHtmlWindow::OnLinkClicked(link);
 }

+
+
+wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
+                                                 const wxString& url,
+                                                 wxString *redirect) const {
+    bool found;
+    wxHtmlOpeningStatus rval;
+    wxPyBeginBlockThreads();
+    if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
+        PyObject* ro;
+        ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(is)", type, url.c_str()));
+        if (PyString_Check(ro)
+#if PYTHON_API_VERSION >= 1009
+            || PyUnicode_Check(ro)
+#endif
+            ) {
+            PyObject* str = PyObject_Str(ro);
+            *redirect = PyString_AsString(str);
+            Py_DECREF(str);
+            rval = wxHTML_REDIRECT;
+        }
+        else {
+            PyObject* num = PyNumber_Int(ro);
+            rval = (wxHtmlOpeningStatus)PyInt_AsLong(num);
+            Py_DECREF(num);
+        }
+        Py_DECREF(ro);
+    }
+    wxPyEndBlockThreads();
+    if (! found)
+        rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
+    return rval;
+}
+
+

 %}
 
 
 %}
 
 


@@ -436,15 +525,23 @@ public:
                  wxSize& size = wxDefaultSize,
                  int flags=wxHW_SCROLLBAR_AUTO,
                  char* name = "htmlWindow");
                  wxSize& size = wxDefaultSize,
                  int flags=wxHW_SCROLLBAR_AUTO,
                  char* name = "htmlWindow");

+    %name(wxPreHtmlWindow)wxPyHtmlWindow();
+
+    bool Create(wxWindow *parent, int id = -1,
+                wxPoint& pos = wxDefaultPosition,
+                wxSize& size = wxDefaultSize,
+                int flags=wxHW_SCROLLBAR_AUTO,
+                char* name = "htmlWindow");

 
 

-    void _setSelf(PyObject* self, PyObject* _class);
-    %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlWindow)"
-    %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
-    %pragma(python) addtomethod = "__init__:#wx._StdOnScrollCallbacks(self)"

 
 

+    void _setCallbackInfo(PyObject* self, PyObject* _class);
+    %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWindow)"
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+    %pragma(python) addtomethod = "wxPreHtmlWindow:val._setOORInfo(val)"

 
     bool SetPage(const wxString& source);
     bool LoadPage(const wxString& location);
 
     bool SetPage(const wxString& source);
     bool LoadPage(const wxString& location);

+    bool AppendToPage(const wxString& source);

     wxString GetOpenedPage();
     wxString GetOpenedAnchor();
     wxString GetOpenedPageTitle();
     wxString GetOpenedPage();
     wxString GetOpenedAnchor();
     wxString GetOpenedPageTitle();


@@ -478,6 +575,10 @@ public:
 
     void base_OnLinkClicked(const wxHtmlLinkInfo& link);
     void base_OnSetTitle(const char* title);
 
     void base_OnLinkClicked(const wxHtmlLinkInfo& link);
     void base_OnSetTitle(const char* title);

+    void base_OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
+    void base_OnCellClicked(wxHtmlCell *cell,
+                            wxCoord x, wxCoord y,
+                            const wxMouseEvent& event);

 };
 
 // Static methods are mapped to stand-alone functions
 };
 
 // Static methods are mapped to stand-alone functions


@@ -492,7 +593,7 @@ public:
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 
 

-class wxHtmlDCRenderer {
+class wxHtmlDCRenderer : public wxObject {

 public:
     wxHtmlDCRenderer();
     ~wxHtmlDCRenderer();
 public:
     wxHtmlDCRenderer();
     ~wxHtmlDCRenderer();


@@ -533,7 +634,7 @@ public:
 
 
 
 
 
 

-class wxHtmlEasyPrinting {
+class wxHtmlEasyPrinting : public wxObject {

 public:
     wxHtmlEasyPrinting(const char* name = "Printing",
                        wxFrame *parent_frame = NULL);
 public:
     wxHtmlEasyPrinting(const char* name = "Printing",
                        wxFrame *parent_frame = NULL);


@@ -569,6 +670,10 @@ public:
 
     wxClassInfo::CleanUpClasses();
     wxClassInfo::InitializeClasses();
 
     wxClassInfo::CleanUpClasses();
     wxClassInfo::InitializeClasses();

+
+    wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
+    wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler");
+    wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow");

 %}
 
 //----------------------------------------------------------------------
 %}
 
 //----------------------------------------------------------------------