trying to make GetData() return data format more clear

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

diff --git a/wxPython/src/html.i b/wxPython/src/html.i
index 5dcc2c635aad189207825790188d7415ec07b1d5..fa26472ed3bd351857dd78f95e2d0b1774eec2c4 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"


@@ -134,7 +137,7 @@ public:
 
     wxString GetName();
     bool HasParam(const wxString& par);
 
     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);
 
     // Can't do this one as-is, but GetParam should be enough...
     //int ScanParam(const wxString& par, const char *format, void* param);


@@ -196,6 +199,9 @@ public:
         }
     }
 
         }
     }
 

+    // Sets font sizes to be relative to the given size or the system default size
+    void NormalizeFontSizes(int size=-1);
+    

     wxHtmlContainerCell* GetContainer();
     wxHtmlContainerCell* OpenContainer();
     wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);
     wxHtmlContainerCell* GetContainer();
     wxHtmlContainerCell* OpenContainer();
     wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);


@@ -629,11 +635,11 @@ public:
 
     // returns True if this filter is able to open&read given file
     virtual bool CanRead(const wxFSFile& file) const {
 
     // 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;
         bool blocked = wxPyBeginBlockThreads();
         if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) {
         bool found;
         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);
         }
             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
             Py_DECREF(obj);
         }


@@ -649,7 +655,7 @@ public:
         bool found;
         bool blocked = wxPyBeginBlockThreads();
         if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) {
         bool found;
         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);
             PyObject* ro;
             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(O)", obj));
             Py_DECREF(obj);


@@ -782,10 +788,13 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
 
 
 
 
 
 

+MustHaveApp(wxPyHtmlWindow);
+

 %name(HtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
 public:
     %pythonAppend wxPyHtmlWindow      "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)"
     %pythonAppend wxPyHtmlWindow()    ""
 %name(HtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
 public:
     %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,
     
     wxPyHtmlWindow(wxWindow *parent, int id = -1,
                  const wxPoint& pos = wxDefaultPosition,


@@ -794,6 +803,9 @@ public:
                  const wxString& name = wxPyHtmlWindowNameStr);
     %name(PreHtmlWindow)wxPyHtmlWindow();
 
                  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,
     bool Create(wxWindow *parent, int id = -1,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,


@@ -856,6 +868,9 @@ public:
         }
     }
 
         }
     }
 

+    // Sets font sizes to be relative to the given size or the system default size
+    void NormalizeFontSizes(int size=-1);
+    

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


@@ -896,6 +911,11 @@ public:
     void SelectLine(const wxPoint& pos);
     void SelectAll();
 
     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_OnLinkClicked(const wxHtmlLinkInfo& link);
     void base_OnSetTitle(const wxString& title);


@@ -916,6 +936,8 @@ public:
 %newgroup
 
 
 %newgroup
 
 

+MustHaveApp(wxHtmlDCRenderer);
+

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


@@ -925,7 +947,7 @@ public:
     void SetSize(int width, int height);
     void SetHtmlText(const wxString& html,
                      const wxString& basepath = wxPyEmptyString,
     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) {
     // 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) {


@@ -936,7 +958,11 @@ public:
                 delete [] temp;
         }
     }
                 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
+    void NormalizeFontSizes(int size=-1);
+    
+    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
                );
                //int *known_pagebreaks = NULL, int number_of_pages = 0
                int* choices=NULL, int LCOUNT = 0
                );


@@ -953,6 +979,8 @@ enum {
 };
 
 
 };
 
 

+MustHaveApp(wxHtmlPrintout);
+

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


@@ -960,7 +988,7 @@ public:
 
     void SetHtmlText(const wxString& html,
                      const wxString &basepath = wxPyEmptyString,
 
     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);
     void SetHtmlFile(const wxString &htmlfile);
     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);


@@ -975,6 +1003,10 @@ public:
                 delete [] temp;
         }
     }
                 delete [] temp;
         }
     }

+
+    // Sets font sizes to be relative to the given size or the system default size
+    void NormalizeFontSizes(int size=-1);
+    

     void SetMargins(float top = 25.2, float bottom = 25.2,
                     float left = 25.2, float right = 25.2,
                     float spaces = 5);
     void SetMargins(float top = 25.2, float bottom = 25.2,
                     float left = 25.2, float right = 25.2,
                     float spaces = 5);


@@ -988,6 +1020,8 @@ public:
 
 
 
 
 
 

+MustHaveApp(wxHtmlEasyPrinting);
+

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


@@ -1013,6 +1047,9 @@ public:
         }
     }
 
         }
     }
 

+    // Sets font sizes to be relative to the given size or the system default size
+    void NormalizeFontSizes(int size=-1);
+    

     wxPrintData *GetPrintData() {return m_PrintData;}
     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
 
     wxPrintData *GetPrintData() {return m_PrintData;}
     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
 


@@ -1101,6 +1138,8 @@ public:
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+MustHaveApp(wxHtmlHelpFrame);
+

 class wxHtmlHelpFrame : public wxFrame {
 public:
     %pythonAppend wxHtmlHelpFrame    "self._setOORInfo(self)"
 class wxHtmlHelpFrame : public wxFrame {
 public:
     %pythonAppend wxHtmlHelpFrame    "self._setOORInfo(self)"


@@ -1138,6 +1177,8 @@ enum {
 };
 
 
 };
 
 

+MustHaveApp(wxHtmlHelpController);
+

 class wxHtmlHelpController : public wxEvtHandler {
 public:
     %pythonAppend wxHtmlHelpController "self._setOORInfo(self)"
 class wxHtmlHelpController : public wxEvtHandler {
 public:
     %pythonAppend wxHtmlHelpController "self._setOORInfo(self)"


@@ -1147,7 +1188,7 @@ public:
 
     void SetTitleFormat(const wxString& format);
     void SetTempDir(const wxString& path);
 
     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();
     void Display(const wxString& x);
     %name(DisplayID) void Display(int id);
     void DisplayContents();