update from herbert breunung

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

diff --git a/wxPython/src/html.i b/wxPython/src/html.i
index 7449fdff7a75a8d8001a8ce4e79678f068cccdf2..74cc3ac90f2abd8e36338c6c1a90b16cfb3f3c17 100644 (file)
--- a/wxPython/src/html.i
+++ b/wxPython/src/html.i
@@ -10,8 +10,11 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // 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"
 
 %{
 #include "wx/wxPython/wxPython.h"


@@ -29,15 +32,16 @@
 //---------------------------------------------------------------------------
 
 %import windows.i
 //---------------------------------------------------------------------------
 
 %import windows.i

-%pythoncode { wx = core }
+%pythoncode { wx = _core }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }

 
 %include _html_rename.i
 
 
 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
 
 %include _html_rename.i
 
 
 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);

-MAKE_CONST_WXSTRING2(HtmlWindowNameStr, "htmlWindow")
-MAKE_CONST_WXSTRING2(HtmlPrintoutTitleStr, "Printout")
-MAKE_CONST_WXSTRING2(HtmlPrintingTitleStr, "Printing")
+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
 
 
 // TODO: Split this file into multiple %included files that coresponds to the


@@ -249,7 +253,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
 
 %name(HtmlTagHandler) class wxPyHtmlTagHandler : public wxObject {
 public:
 
 %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);
     wxPyHtmlTagHandler();
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);


@@ -287,7 +291,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleT
 
 %name(HtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
 public:
 
 %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);
     wxPyHtmlWinTagHandler();
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);


@@ -312,21 +316,21 @@ public:
     }
 
     void OnExit() {
     }
 
     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);
         }
         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
     };
 
     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);
         PyObject* arg = PyTuple_New(0);
         PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg);
         Py_DECREF(arg);


@@ -334,10 +338,10 @@ public:
         // now figure out where it's C++ object is...
         wxPyHtmlWinTagHandler* thPtr;
         if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler"))) {
         // now figure out where it's C++ object is...
         wxPyHtmlWinTagHandler* thPtr;
         if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler"))) {

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return;
         }
             return;
         }

-        wxPyEndBlockThreads();
+        wxPyEndBlockThreads(blocked);

 
         // add it,
         parser->AddTagHandler(thPtr);
 
         // add it,
         parser->AddTagHandler(thPtr);


@@ -487,6 +491,11 @@ public:
     int GetWidth();
     int GetHeight();
     int GetDescent();
     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);
     const wxString& GetId() const;
     void SetId(const wxString& id);
     wxHtmlLinkInfo* GetLink(int x = 0, int y = 0);


@@ -625,13 +634,13 @@ public:
     virtual bool CanRead(const wxFSFile& file) const {
         bool rval = False;
         bool found;
     virtual bool CanRead(const wxFSFile& file) const {
         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
             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
             Py_DECREF(obj);
         }
         if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) {
             PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file);  // cast away const
             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
             Py_DECREF(obj);
         }

-        wxPyEndBlockThreads();
+        wxPyEndBlockThreads(blocked);

         return rval;
     }
 
         return rval;
     }
 


@@ -641,7 +650,7 @@ public:
     virtual wxString ReadFile(const wxFSFile& file) const {
         wxString rval;
         bool found;
     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* ro;
         if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) {
             PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file);  // cast away const
             PyObject* ro;


@@ -652,7 +661,7 @@ public:
                 Py_DECREF(ro);
             }
         }
                 Py_DECREF(ro);
             }
         }

-        wxPyEndBlockThreads();
+        wxPyEndBlockThreads(blocked);

         return rval;
     }
 
         return rval;
     }
 


@@ -667,7 +676,7 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter);
 
 %name(HtmlFilter) class wxPyHtmlFilter : public wxObject {
 public:
 
 %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);
     wxPyHtmlFilter();
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);


@@ -724,13 +733,13 @@ IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked);
 
 void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
     bool found;
 
 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);
     }
     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);
 }
     if (! found)
         wxHtmlWindow::OnLinkClicked(link);
 }


@@ -744,7 +753,7 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
                                                  wxString *redirect) const {
     bool found;
     wxHtmlOpeningStatus rval;
                                                  wxString *redirect) const {
     bool found;
     wxHtmlOpeningStatus rval;

-    wxPyBeginBlockThreads();
+    bool blocked = wxPyBeginBlockThreads();

     if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
         PyObject* ro;
         PyObject* s = wx2PyString(url);
     if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
         PyObject* ro;
         PyObject* s = wx2PyString(url);


@@ -765,7 +774,7 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
         }
         Py_DECREF(ro);
     }
         }
         Py_DECREF(ro);
     }

-    wxPyEndBlockThreads();
+    wxPyEndBlockThreads(blocked);

     if (! found)
         rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
     return rval;
     if (! found)
         rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
     return rval;


@@ -776,10 +785,12 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
 
 
 
 
 
 

+MustHaveApp(wxPyHtmlWindow);
+

 %name(HtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
 public:
 %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()    ""

     
     wxPyHtmlWindow(wxWindow *parent, int id = -1,
                  const wxPoint& pos = wxDefaultPosition,
     
     wxPyHtmlWindow(wxWindow *parent, int id = -1,
                  const wxPoint& pos = wxDefaultPosition,


@@ -850,7 +861,9 @@ public:
         }
     }
 
         }
     }
 

-    void SetTitle(const wxString& title);
+    DocDeclStr(
+        void, SetTitle(const wxString& title),
+        "", "");

 
     // Sets space between text and window borders.
     void SetBorders(int b);
 
     // Sets space between text and window borders.
     void SetBorders(int b);


@@ -883,13 +896,21 @@ public:
     //Adds input filter
     static void AddFilter(wxPyHtmlFilter *filter);
 
     //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();

 
 

+    

     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 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 +921,8 @@ public:
 %newgroup
 
 
 %newgroup
 
 

+MustHaveApp(wxHtmlDCRenderer);
+

 class wxHtmlDCRenderer : public wxObject {
 public:
     wxHtmlDCRenderer();
 class wxHtmlDCRenderer : public wxObject {
 public:
     wxHtmlDCRenderer();


@@ -937,6 +960,8 @@ enum {
 };
 
 
 };
 
 

+MustHaveApp(wxHtmlPrintout);
+

 class wxHtmlPrintout : public wxPyPrintout {
 public:
     wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr);
 class wxHtmlPrintout : public wxPyPrintout {
 public:
     wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr);


@@ -972,6 +997,8 @@ public:
 
 
 
 
 
 

+MustHaveApp(wxHtmlEasyPrinting);
+

 class wxHtmlEasyPrinting : public wxObject {
 public:
     wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr,
 class wxHtmlEasyPrinting : public wxObject {
 public:
     wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr,


@@ -1085,9 +1112,11 @@ public:
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+MustHaveApp(wxHtmlHelpFrame);
+

 class wxHtmlHelpFrame : public wxFrame {
 public:
 class wxHtmlHelpFrame : public wxFrame {
 public:

-    %addtofunc wxHtmlHelpFrame    "self._setOORInfo(self)"
+    %pythonAppend wxHtmlHelpFrame    "self._setOORInfo(self)"

     
     wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
                    const wxString& title = wxPyEmptyString,
     
     wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
                    const wxString& title = wxPyEmptyString,


@@ -1122,9 +1151,11 @@ enum {
 };
 
 
 };
 
 

+MustHaveApp(wxHtmlHelpController);
+

 class wxHtmlHelpController : public wxEvtHandler {
 public:
 class wxHtmlHelpController : public wxEvtHandler {
 public:

-    %addtofunc wxHtmlHelpController "self._setOORInfo(self)"
+    %pythonAppend wxHtmlHelpController "self._setOORInfo(self)"

     
     wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
     ~wxHtmlHelpController();
     
     wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
     ~wxHtmlHelpController();