]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/html.i
A little cleanup
[wxWidgets.git] / wxPython / src / html.i
index 22f0101444417bdda5ad41b4d66681e3d3aac7f9..8450f856f3754c05f5dc14ddce7112a9b2ac0858 100644 (file)
 // 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/html/htmprint.h>
 #include <wx/html/helpctrl.h>
 
-
-    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.)
 
@@ -75,6 +77,15 @@ enum {
     wxHTML_COND_ISANCHOR,
     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,
 };
 
 
@@ -126,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);
@@ -188,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);
@@ -242,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);
@@ -280,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);
@@ -305,30 +323,32 @@ 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();
-        PyObject* arg = Py_BuildValue("()");
-        PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL);
+        bool blocked = wxPyBeginBlockThreads();
+        PyObject* arg = PyTuple_New(0);
+        PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg);
         Py_DECREF(arg);
-        wxPyEndBlockThreads();
-
+        
         // now figure out where it's C++ object is...
         wxPyHtmlWinTagHandler* thPtr;
-        if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler")))
+        if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler"))) {
+            wxPyEndBlockThreads(blocked);
             return;
+        }
+        wxPyEndBlockThreads(blocked);
 
         // add it,
         parser->AddTagHandler(thPtr);
@@ -478,6 +498,13 @@ 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);
     wxHtmlCell* GetNext();
     wxHtmlContainerCell* GetParent();
@@ -508,7 +535,7 @@ public:
     // Can the line be broken before this cell?
     bool IsLinebreakAllowed() const;
 
-    // Returns true for simple == terminal cells, i.e. not composite ones.
+    // Returns True for simple == terminal cells, i.e. not composite ones.
     // This if for internal usage only and may disappear in future versions!
     bool IsTerminalCell() const;
 
@@ -532,9 +559,9 @@ public:
     // (if it is the root, depth is 0)
     unsigned GetDepth() const;
 
-    // Returns true if the cell appears before 'cell' in natural order of
+    // Returns True if the cell appears before 'cell' in natural order of
     // cells (= as they are read). If cell A is (grand)parent of cell B,
-    // then both A.IsBefore(B) and B.IsBefore(A) always return true.
+    // then both A.IsBefore(B) and B.IsBefore(A) always return True.
     bool IsBefore(wxHtmlCell *cell) const;
 
     // Converts the cell into text representation. If sel != NULL then
@@ -610,17 +637,17 @@ class wxPyHtmlFilter : public wxHtmlFilter {
 public:
     wxPyHtmlFilter() : wxHtmlFilter() {}
 
-    // returns TRUE if this filter is able to open&read given file
+    // 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;
     }
 
@@ -630,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);
@@ -641,7 +668,7 @@ public:
                 Py_DECREF(ro);
             }
         }
-        wxPyEndBlockThreads();
+        wxPyEndBlockThreads(blocked);
         return rval;
     }
 
@@ -656,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);
@@ -713,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);
 }
@@ -733,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);
@@ -754,7 +781,7 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
         }
         Py_DECREF(ro);
     }
-    wxPyEndBlockThreads();
+    wxPyEndBlockThreads(blocked);
     if (! found)
         rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
     return rval;
@@ -765,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,
@@ -777,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,
@@ -790,7 +823,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
-    // Return value : FALSE if an error occured, TRUE otherwise
+    // Return value : False if an error occured, True otherwise
     bool SetPage(const wxString& source);
 
     // Load HTML page from given location. Location can be either
@@ -839,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);
@@ -851,7 +892,7 @@ public:
     void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
 
     // Goes to previous/next page (in browsing history)
-    // Returns TRUE if successful, FALSE otherwise
+    // Returns True if successful, False otherwise
     bool HistoryBack();
     bool HistoryForward();
     bool HistoryCanBack();
@@ -872,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);
 };
 
 
@@ -889,6 +943,8 @@ public:
 %newgroup
 
 
+MustHaveApp(wxHtmlDCRenderer);
+
 class wxHtmlDCRenderer : public wxObject {
 public:
     wxHtmlDCRenderer();
@@ -898,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) {
@@ -909,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 maxHeight = INT_MAX,
                //int *known_pagebreaks = NULL, int number_of_pages = 0
                int* choices=NULL, int LCOUNT = 0
                );
@@ -926,6 +989,8 @@ enum {
 };
 
 
+MustHaveApp(wxHtmlPrintout);
+
 class wxHtmlPrintout : public wxPyPrintout {
 public:
     wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr);
@@ -933,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);
@@ -948,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);
@@ -961,6 +1033,8 @@ public:
 
 
 
+MustHaveApp(wxHtmlEasyPrinting);
+
 class wxHtmlEasyPrinting : public wxObject {
 public:
     wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr,
@@ -971,7 +1045,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);
@@ -986,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;}
 
@@ -1074,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,
@@ -1111,16 +1193,19 @@ enum {
 };
 
 
-class wxHtmlHelpController : public wxEvtHandler {
+MustHaveApp(wxHtmlHelpController);
+
+class wxHtmlHelpController : public wxObject  // wxHelpControllerBase
+{
 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();