Add GetWindowBorderSize

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

diff --git a/wxPython/src/html.i b/wxPython/src/html.i
index 570753f83b3de5c21536f5b1032593ccd7d066b8..28afc3d5fb1eae85d79bc682d96510c6a8ad1e73 100644 (file)
--- a/wxPython/src/html.i
+++ b/wxPython/src/html.i
@@ -77,14 +77,6 @@ enum {
     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,
 };
 
 
@@ -125,6 +117,11 @@ public:
 
     void SetEvent(const wxMouseEvent *e);
     void SetHtmlCell(const wxHtmlCell * e);
+
+    %property(Event, GetEvent, SetEvent, doc="See `GetEvent` and `SetEvent`");
+    %property(Href, GetHref, doc="See `GetHref`");
+    %property(HtmlCell, GetHtmlCell, SetHtmlCell, doc="See `GetHtmlCell` and `SetHtmlCell`");
+    %property(Target, GetTarget, doc="See `GetTarget`");
 };
 
 //---------------------------------------------------------------------------
@@ -146,6 +143,12 @@ public:
     int GetBeginPos();
     int GetEndPos1();
     int GetEndPos2();
+    
+    %property(AllParams, GetAllParams, doc="See `GetAllParams`");
+    %property(BeginPos, GetBeginPos, doc="See `GetBeginPos`");
+    %property(EndPos1, GetEndPos1, doc="See `GetEndPos1`");
+    %property(EndPos2, GetEndPos2, doc="See `GetEndPos2`");
+    %property(Name, GetName, doc="See `GetName`");
 };
 
 //---------------------------------------------------------------------------
@@ -177,6 +180,9 @@ public:
     // Returns HTML source inside the element (i.e. between the starting
     // and ending tag)
     wxString GetInnerSource(const wxHtmlTag& tag);
+
+    %property(FS, GetFS, SetFS, doc="See `GetFS` and `SetFS`");
+    %property(Source, GetSource, doc="See `GetSource`");
 };
 
 
@@ -242,6 +248,21 @@ public:
     wxFont* CreateCurrentFont();
     wxHtmlLinkInfo GetLink();
 
+    %property(ActualColor, GetActualColor, SetActualColor, doc="See `GetActualColor` and `SetActualColor`");
+    %property(ActualColour, GetActualColour, SetActualColour, doc="See `GetActualColour` and `SetActualColour`");
+    %property(Align, GetAlign, SetAlign, doc="See `GetAlign` and `SetAlign`");
+    %property(CharHeight, GetCharHeight, doc="See `GetCharHeight`");
+    %property(CharWidth, GetCharWidth, doc="See `GetCharWidth`");
+    %property(Container, GetContainer, SetContainer, doc="See `GetContainer` and `SetContainer`");
+    %property(DC, GetDC, SetDC, doc="See `GetDC` and `SetDC`");
+    %property(FontBold, GetFontBold, SetFontBold, doc="See `GetFontBold` and `SetFontBold`");
+    %property(FontFixed, GetFontFixed, SetFontFixed, doc="See `GetFontFixed` and `SetFontFixed`");
+    %property(FontItalic, GetFontItalic, SetFontItalic, doc="See `GetFontItalic` and `SetFontItalic`");
+    %property(FontSize, GetFontSize, SetFontSize, doc="See `GetFontSize` and `SetFontSize`");
+    %property(FontUnderlined, GetFontUnderlined, SetFontUnderlined, doc="See `GetFontUnderlined` and `SetFontUnderlined`");
+    %property(Link, GetLink, SetLink, doc="See `GetLink` and `SetLink`");
+    %property(LinkColor, GetLinkColor, SetLinkColor, doc="See `GetLinkColor` and `SetLinkColor`");
+    %property(WindowInterface, GetWindowInterface, doc="See `GetWindowInterface`");
 };
 
 
@@ -272,7 +293,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
 %rename(HtmlTagHandler) wxPyHtmlTagHandler;
 class wxPyHtmlTagHandler : public wxObject {
 public:
-    %pythonAppend wxPyHtmlTagHandler   "self._setCallbackInfo(self, HtmlTagHandler)"
+    %pythonAppend wxPyHtmlTagHandler   setCallbackInfo(HtmlTagHandler)
     wxPyHtmlTagHandler();
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
@@ -280,6 +301,8 @@ public:
     void SetParser(wxHtmlParser *parser);
     wxHtmlParser* GetParser();
     void ParseInner(const wxHtmlTag& tag);
+
+    %property(Parser, GetParser, SetParser, doc="See `GetParser` and `SetParser`");
 };
 
 
@@ -311,7 +334,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleT
 %rename(HtmlWinTagHandler) wxPyHtmlWinTagHandler;
 class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
 public:
-    %pythonAppend wxPyHtmlWinTagHandler    "self._setCallbackInfo(self, HtmlWinTagHandler)"
+    %pythonAppend wxPyHtmlWinTagHandler    setCallbackInfo(HtmlWinTagHandler)
     wxPyHtmlWinTagHandler();
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
@@ -319,6 +342,8 @@ public:
     void SetParser(wxHtmlParser *parser);
     wxHtmlWinParser* GetParser();
     void ParseInner(const wxHtmlTag& tag);
+
+    %property(Parser, GetParser, SetParser, doc="See `GetParser` and `SetParser`");
 };
 
 
@@ -426,6 +451,12 @@ public:
 
     const bool IsEmpty() const;
 
+    %property(FromCell, GetFromCell, doc="See `GetFromCell`");
+    %property(FromPos, GetFromPos, doc="See `GetFromPos`");
+    %property(FromPrivPos, GetFromPrivPos, SetFromPrivPos, doc="See `GetFromPrivPos` and `SetFromPrivPos`");
+    %property(ToCell, GetToCell, doc="See `GetToCell`");
+    %property(ToPos, GetToPos, doc="See `GetToPos`");
+    %property(ToPrivPos, GetToPrivPos, SetToPrivPos, doc="See `GetToPrivPos` and `SetToPrivPos`");
 };
 
 
@@ -453,6 +484,10 @@ public:
     const wxColour& GetFgColour() const;
     void SetBgColour(const wxColour& c);
     const wxColour& GetBgColour() const;
+
+    %property(BgColour, GetBgColour, SetBgColour, doc="See `GetBgColour` and `SetBgColour`");
+    %property(FgColour, GetFgColour, SetFgColour, doc="See `GetFgColour` and `SetFgColour`");
+    %property(SelectionState, GetSelectionState, SetSelectionState, doc="See `GetSelectionState` and `SetSelectionState`");
 };
 
 
@@ -464,14 +499,15 @@ class wxHtmlRenderingStyle
 public:
     virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
     virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
+
+    %property(SelectedTextBgColour, GetSelectedTextBgColour, doc="See `GetSelectedTextBgColour`");
+    %property(SelectedTextColour, GetSelectedTextColour, doc="See `GetSelectedTextColour`");
 };
 
 // Standard style:
 class wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle
 {
 public:
-    virtual wxColour GetSelectedTextColour(const wxColour& clr);
-    virtual wxColour GetSelectedTextBgColour(const wxColour& clr);
 };
 
 
@@ -492,6 +528,10 @@ public:
     wxHtmlRenderingStyle& GetStyle();
 
     wxHtmlRenderingState& GetState();
+
+    %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
+    %property(State, GetState, doc="See `GetState`");
+    %property(Style, GetStyle, SetStyle, doc="See `GetStyle` and `SetStyle`");
 };
 
 //---------------------------------------------------------------------------
@@ -565,7 +605,8 @@ public:
                                    const wxPoint& pos,
                                    const wxMouseEvent& event);
     
-    bool AdjustPagebreak(int* INOUT);
+// TODO:     bool AdjustPagebreak(int* INOUT,
+//                                 wxArrayInt& known_pagebreaks);
     void SetCanLiveOnPagebreak(bool can);
 
     // Can the line be broken before this cell?
@@ -609,6 +650,24 @@ public:
     // Converts the cell into text representation. If sel != NULL then
     // only part of the cell inside the selection is converted.
     wxString ConvertToText(wxHtmlSelection *sel) const;
+
+    %property(Cursor, GetCursor, doc="See `GetCursor`");
+    %property(Depth, GetDepth, doc="See `GetDepth`");
+    %property(Descent, GetDescent, doc="See `GetDescent`");
+    %property(FirstChild, GetFirstChild, doc="See `GetFirstChild`");
+    %property(FirstTerminal, GetFirstTerminal, doc="See `GetFirstTerminal`");
+    %property(Height, GetHeight, doc="See `GetHeight`");
+    %property(Id, GetId, SetId, doc="See `GetId` and `SetId`");
+    %property(LastTerminal, GetLastTerminal, doc="See `GetLastTerminal`");
+    %property(Link, GetLink, SetLink, doc="See `GetLink` and `SetLink`");
+    %property(MaxTotalWidth, GetMaxTotalWidth, doc="See `GetMaxTotalWidth`");
+    %property(MouseCursor, GetMouseCursor, doc="See `GetMouseCursor`");
+    %property(Next, GetNext, SetNext, doc="See `GetNext` and `SetNext`");
+    %property(Parent, GetParent, SetParent, doc="See `GetParent` and `SetParent`");
+    %property(PosX, GetPosX, doc="See `GetPosX`");
+    %property(PosY, GetPosY, doc="See `GetPosY`");
+    %property(RootCell, GetRootCell, doc="See `GetRootCell`");
+    %property(Width, GetWidth, doc="See `GetWidth`");
 };
 
 
@@ -646,6 +705,13 @@ public:
     void SetBorder(const wxColour& clr1, const wxColour& clr2);
     wxHtmlCell* GetFirstChild();
     %pragma(python) addtoclass = "GetFirstCell = GetFirstChild"
+
+    %property(AlignHor, GetAlignHor, SetAlignHor, doc="See `GetAlignHor` and `SetAlignHor`");
+    %property(AlignVer, GetAlignVer, SetAlignVer, doc="See `GetAlignVer` and `SetAlignVer`");
+    %property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
+    %property(FirstChild, GetFirstChild, doc="See `GetFirstChild`");
+    %property(Indent, GetIndent, SetIndent, doc="See `GetIndent` and `SetIndent`");
+    %property(IndentUnits, GetIndentUnits, doc="See `GetIndentUnits`");
 };
 
 
@@ -732,7 +798,7 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter);
 %rename(HtmlFilter) wxPyHtmlFilter;
 class wxPyHtmlFilter : public wxObject {
 public:
-    %pythonAppend wxPyHtmlFilter   "self._setCallbackInfo(self, HtmlFilter)"
+    %pythonAppend wxPyHtmlFilter   setCallbackInfo(HtmlFilter)
     wxPyHtmlFilter();
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
@@ -816,6 +882,9 @@ public:
         Returns mouse cursor of given @a type.
      */
 //    virtual wxCursor GetHTMLCursor(HTMLCursor type) const = 0;
+
+    %property(HTMLBackgroundColour, GetHTMLBackgroundColour, SetHTMLBackgroundColour, doc="See `GetHTMLBackgroundColour` and `SetHTMLBackgroundColour`");
+    %property(HTMLWindow, GetHTMLWindow, doc="See `GetHTMLWindow`");
 };
 
 
@@ -927,7 +996,7 @@ class wxPyHtmlWindow : public wxScrolledWindow //,
                        // public wxHtmlWindowMouseHelper
 {
 public:
-    %pythonAppend wxPyHtmlWindow      "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)"
+    %pythonAppend wxPyHtmlWindow      "self._setOORInfo(self);" setCallbackInfo(HtmlWindow)
     %pythonAppend wxPyHtmlWindow()    ""
     %typemap(out) wxPyHtmlWindow*;    // turn off this typemap
 
@@ -953,7 +1022,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
+    // specify document location, use LoadPage() instead
     // Return value : False if an error occurred, True otherwise
     bool SetPage(const wxString& source);
 
@@ -1107,6 +1176,12 @@ public:
 //     virtual void SetHTMLStatusText(const wxString& text);
 //     virtual wxCursor GetHTMLCursor(HTMLCursor type) const;
     
+    %property(InternalRepresentation, GetInternalRepresentation, doc="See `GetInternalRepresentation`");
+    %property(OpenedAnchor, GetOpenedAnchor, doc="See `GetOpenedAnchor`");
+    %property(OpenedPage, GetOpenedPage, doc="See `GetOpenedPage`");
+    %property(OpenedPageTitle, GetOpenedPageTitle, doc="See `GetOpenedPageTitle`");
+    %property(Parser, GetParser, doc="See `GetParser`");
+    %property(RelatedFrame, GetRelatedFrame, doc="See `GetRelatedFrame`");
 };
 
 
@@ -1146,13 +1221,13 @@ public:
                           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
-               );
+    int Render(int x, int y, wxArrayInt& known_pagebreaks, int from = 0,
+               int dont_render = FALSE, int to = INT_MAX);
     int GetTotalHeight();
                 // returns total height of the html document
                 // (compare Render's return value with this)
+
+    %property(TotalHeight, GetTotalHeight, doc="See `GetTotalHeight`");
 };
 
 
@@ -1243,6 +1318,8 @@ public:
     wxPrintData *GetPrintData() {return m_PrintData;}
     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
 
+    %property(PageSetupData, GetPageSetupData, doc="See `GetPageSetupData`");
+    %property(PrintData, GetPrintData, doc="See `GetPrintData`");
 };
 
 
@@ -1270,6 +1347,14 @@ public:
     void SetStart(const wxString& start);
 
     wxString GetFullPath(const wxString &page) const;
+
+    %property(BasePath, GetBasePath, SetBasePath, doc="See `GetBasePath` and `SetBasePath`");
+    %property(BookFile, GetBookFile, doc="See `GetBookFile`");
+    %property(ContentsEnd, GetContentsEnd, doc="See `GetContentsEnd`");
+    %property(ContentsStart, GetContentsStart, doc="See `GetContentsStart`");
+    %property(FullPath, GetFullPath, doc="See `GetFullPath`");
+    %property(Start, GetStart, SetStart, doc="See `GetStart` and `SetStart`");
+    %property(Title, GetTitle, SetTitle, doc="See `GetTitle` and `SetTitle`");
 };
 
 //---------------------------------------------------------------------------
@@ -1298,6 +1383,10 @@ public:
     int GetCurIndex();
     int GetMaxIndex();
     const wxString& GetName();
+
+    %property(CurIndex, GetCurIndex, doc="See `GetCurIndex`");
+    %property(MaxIndex, GetMaxIndex, doc="See `GetMaxIndex`");
+    %property(Name, GetName, doc="See `GetName`");
 };
 
 //---------------------------------------------------------------------------
@@ -1320,6 +1409,7 @@ public:
     // TODO: this one needs fixed...
     const wxHtmlBookRecArray& GetBookRecArray();
 
+    %property(BookRecArray, GetBookRecArray, doc="See `GetBookRecArray`");
 };
 
 //---------------------------------------------------------------------------
@@ -1374,6 +1464,9 @@ enum {
 };
 
 
+%{
+    typedef wxTreeCtrl wxPyTreeCtrl;
+%}
 
 MustHaveApp(wxHtmlHelpWindow);
 
@@ -1453,7 +1546,7 @@ public:
     void RefreshLists();
 
     // Gets the HTML window
-    wxHtmlWindow* GetHtmlWindow() const;
+    wxPyHtmlWindow* GetHtmlWindow() const;
 
     // Gets the splitter window
     wxSplitterWindow* GetSplitterWindow();
@@ -1465,22 +1558,58 @@ public:
     wxHtmlHelpFrameCfg& GetCfgData();
 
     // Gets the tree control
-    wxTreeCtrl *GetTreeCtrl() const;
-
+    wxPyTreeCtrl *GetTreeCtrl() const;
+
+    %property(CfgData, GetCfgData, doc="See `GetCfgData`");
+    %property(Controller, GetController, SetController, doc="See `GetController` and `SetController`");
+    %property(Data, GetData, doc="See `GetData`");
+    %property(HtmlWindow, GetHtmlWindow, doc="See `GetHtmlWindow`");
+    %property(SplitterWindow, GetSplitterWindow, doc="See `GetSplitterWindow`");
+    %property(ToolBar, GetToolBar, doc="See `GetToolBar`");
+    %property(TreeCtrl, GetTreeCtrl, doc="See `GetTreeCtrl`");
 };
 
+//---------------------------------------------------------------------------
+
+
+%constant wxEventType wxEVT_COMMAND_HTML_CELL_CLICKED;
+%constant wxEventType wxEVT_COMMAND_HTML_CELL_HOVER;
+%constant wxEventType wxEVT_COMMAND_HTML_LINK_CLICKED;
 
-class wxHtmlWindowEvent: public wxNotifyEvent
+
+class wxHtmlCellEvent : public wxCommandEvent
 {
 public:
-    wxHtmlWindowEvent(wxEventType commandType = wxEVT_NULL, int id = 0):
-        wxNotifyEvent(commandType, id);
+    wxHtmlCellEvent(wxEventType commandType, int id,
+                    wxHtmlCell *cell, const wxPoint &pt,
+                    const wxMouseEvent &ev);
+
+    wxHtmlCell* GetCell() const;
+    wxPoint GetPoint() const;
+    wxMouseEvent GetMouseEvent() const;
 
-    void SetURL(const wxString& url);
-    const wxString& GetURL() const;
+    void SetLinkClicked(bool linkclicked);
+    bool GetLinkClicked() const;
 };
 
 
+class wxHtmlLinkEvent : public wxCommandEvent
+{
+public:
+    wxHtmlLinkEvent(int id, const wxHtmlLinkInfo &linkinfo);
+    
+    const wxHtmlLinkInfo &GetLinkInfo() const;
+};
+
+
+%pythoncode {
+    EVT_HTML_CELL_CLICKED = wx.PyEventBinder( wxEVT_COMMAND_HTML_CELL_CLICKED, 1 )
+    EVT_HTML_CELL_HOVER   = wx.PyEventBinder( wxEVT_COMMAND_HTML_CELL_HOVER, 1 )
+    EVT_HTML_LINK_CLICKED = wx.PyEventBinder( wxEVT_COMMAND_HTML_LINK_CLICKED, 1 )
+}
+        
+//---------------------------------------------------------------------------
+
 
 MustHaveApp(wxHtmlHelpFrame);
 
@@ -1492,7 +1621,9 @@ public:
 
     wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
                    const wxString& title = wxPyEmptyString,
-                   int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL);
+                   int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL,
+                    wxConfigBase *config=NULL,
+                    const wxString& rootpath = wxPyEmptyString);
     %RenameCtor(PreHtmlHelpFrame, wxHtmlHelpFrame(wxHtmlHelpData* data = NULL));
 
     // Turn it back on again
@@ -1500,7 +1631,9 @@ public:
 
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& title = wxPyEmptyString,
-                int style = wxHF_DEFAULT_STYLE);
+                int style = wxHF_DEFAULT_STYLE,
+                wxConfigBase *config=NULL,
+                const wxString& rootpath = wxPyEmptyString);
 
     wxHtmlHelpData* GetData();
     void SetTitleFormat(const wxString& format);
@@ -1539,6 +1672,10 @@ public:
         def WriteCustomization(self, config, rootpath=""):
             return self.GetHelpWindow().WriteCustomization(config, rootpath)
      %}
+
+    %property(Controller, GetController, SetController, doc="See `GetController` and `SetController`");
+    %property(Data, GetData, doc="See `GetData`");
+    %property(HelpWindow, GetHelpWindow, doc="See `GetHelpWindow`");
 };
 
 
@@ -1584,6 +1721,9 @@ public:
     // Override to add custom buttons to the toolbar
 //    virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {};
 
+    %property(Controller, GetController, SetController, doc="See `GetController` and `SetController`");
+    %property(Data, GetData, doc="See `GetData`");
+    %property(HelpWindow, GetHelpWindow, doc="See `GetHelpWindow`");
 };
 
 
@@ -1653,6 +1793,7 @@ public:
     /// Get the window that can optionally be used for the help window's parent.
     virtual wxWindow* GetParentWindow() const;
 
+    %property(ParentWindow, GetParentWindow, SetParentWindow, doc="See `GetParentWindow` and `SetParentWindow`");
 };
 
 
@@ -1688,6 +1829,10 @@ public:
 
     void MakeModalIfNeeded();
     wxWindow* FindTopLevelWindow();
+
+    %property(Dialog, GetDialog, doc="See `GetDialog`");
+    %property(Frame, GetFrame, doc="See `GetFrame`");
+    %property(HelpWindow, GetHelpWindow, SetHelpWindow, doc="See `GetHelpWindow` and `SetHelpWindow`");
 };