Extend history api using the ie backend to include loading history items, and getting...

[wxWidgets.git] / include / wx / html / htmlwin.h

diff --git a/include/wx/html/htmlwin.h b/include/wx/html/htmlwin.h
index d2a55a7695eef4ac056abf6e042e9c350ee9dc3e..580dbbca9bdeca45939765fe498becbbb0823580 100644 (file)
--- a/include/wx/html/htmlwin.h
+++ b/include/wx/html/htmlwin.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        htmlwin.h
+// Name:        wx/html/htmlwin.h

 // Purpose:     wxHtmlWindow class for parsing & displaying HTML
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Purpose:     wxHtmlWindow class for parsing & displaying HTML
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$


@@ -28,10 +28,10 @@ class wxHtmlProcessor;
 class wxHtmlWinModule;
 class wxHtmlHistoryArray;
 class wxHtmlProcessorList;
 class wxHtmlWinModule;
 class wxHtmlHistoryArray;
 class wxHtmlProcessorList;

-class WXDLLIMPEXP_HTML wxHtmlWinAutoScrollTimer;
-class WXDLLIMPEXP_HTML wxHtmlCellEvent;
-class WXDLLIMPEXP_HTML wxHtmlLinkEvent;
-
+class WXDLLIMPEXP_FWD_HTML wxHtmlWinAutoScrollTimer;
+class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent;
+class WXDLLIMPEXP_FWD_HTML wxHtmlLinkEvent;
+class WXDLLIMPEXP_FWD_CORE wxStatusBar;

 
 // wxHtmlWindow flags:
 #define wxHW_SCROLLBAR_NEVER    0x0002
 
 // wxHtmlWindow flags:
 #define wxHW_SCROLLBAR_NEVER    0x0002


@@ -195,7 +195,7 @@ protected:
 
     /**
         Called by HandleMouseClick when the user clicks on a cell.
 
     /**
         Called by HandleMouseClick when the user clicks on a cell.

-        Default behavior is to call wxHtmlWindowInterface::OnLinkClicked()
+        Default behaviour is to call wxHtmlWindowInterface::OnLinkClicked()

         if this cell corresponds to a hypertext link.
 
         @param cell   the cell the mouse is over
         if this cell corresponds to a hypertext link.
 
         @param cell   the cell the mouse is over


@@ -297,7 +297,8 @@ public:
 #if wxUSE_STATUSBAR
     // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
     // will be displayed. Default is -1 = no messages.
 #if wxUSE_STATUSBAR
     // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
     // will be displayed. Default is -1 = no messages.

-    void SetRelatedStatusBar(int bar);
+    void SetRelatedStatusBar(int index);
+    void SetRelatedStatusBar(wxStatusBar*, int index = 0);

 #endif // wxUSE_STATUSBAR
 
     // Sets fonts to be used when displaying HTML page.
 #endif // wxUSE_STATUSBAR
 
     // Sets fonts to be used when displaying HTML page.


@@ -317,12 +318,14 @@ public:
     // when/if we have CSS support we could add other possibilities...)
     void SetBackgroundImage(const wxBitmap& bmpBg) { m_bmpBg = bmpBg; }
 
     // when/if we have CSS support we could add other possibilities...)
     void SetBackgroundImage(const wxBitmap& bmpBg) { m_bmpBg = bmpBg; }
 

+#if wxUSE_CONFIG

     // Saves custom settings into cfg config. it will use the path 'path'
     // if given, otherwise it will save info into currently selected path.
     // saved values : things set by SetFonts, SetBorders.
     virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
     // ...
     virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
     // Saves custom settings into cfg config. it will use the path 'path'
     // if given, otherwise it will save info into currently selected path.
     // saved values : things set by SetFonts, SetBorders.
     virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
     // ...
     virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);

+#endif // wxUSE_CONFIG

 
     // Goes to previous/next page (in browsing history)
     // Returns true if successful, false otherwise
 
     // Goes to previous/next page (in browsing history)
     // Returns true if successful, false otherwise


@@ -355,7 +358,7 @@ public:
     // (depending on the information passed to SetRelatedFrame() method)
     virtual void OnSetTitle(const wxString& title);
 
     // (depending on the information passed to SetRelatedFrame() method)
     virtual void OnSetTitle(const wxString& title);
 

-    // Called when user clicked on hypertext link. Default behavior is to
+    // Called when user clicked on hypertext link. Default behaviour is to

     // call LoadPage(loc)
     virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
 
     // call LoadPage(loc)
     virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
 


@@ -399,7 +402,6 @@ protected:
     // actual size of window. This method also setup scrollbars
     void CreateLayout();
 
     // actual size of window. This method also setup scrollbars
     void CreateLayout();
 

-    void OnEraseBackground(wxEraseEvent& event);

     void OnPaint(wxPaintEvent& event);
     void OnSize(wxSizeEvent& event);
     void OnMouseMove(wxMouseEvent& event);
     void OnPaint(wxPaintEvent& event);
     void OnSize(wxSizeEvent& event);
     void OnMouseMove(wxMouseEvent& event);


@@ -443,7 +445,7 @@ protected:
 
     wxString DoSelectionToText(wxHtmlSelection *sel);
 
 
     wxString DoSelectionToText(wxHtmlSelection *sel);
 

-private:
+public:

     // wxHtmlWindowInterface methods:
     virtual void SetHTMLWindowTitle(const wxString& title);
     virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link);
     // wxHtmlWindowInterface methods:
     virtual void SetHTMLWindowTitle(const wxString& title);
     virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link);


@@ -467,25 +469,26 @@ protected:
     // is usually top one = all other cells are sub-cells of this one)
     wxHtmlContainerCell *m_Cell;
     // parser which is used to parse HTML input.
     // is usually top one = all other cells are sub-cells of this one)
     wxHtmlContainerCell *m_Cell;
     // parser which is used to parse HTML input.

-    // Each wxHtmlWindow has it's own parser because sharing one global
+    // Each wxHtmlWindow has its own parser because sharing one global

     // parser would be problematic (because of reentrancy)
     wxHtmlWinParser *m_Parser;
     // parser would be problematic (because of reentrancy)
     wxHtmlWinParser *m_Parser;

-    // contains name of actualy opened page or empty string if no page opened
+    // contains name of actually opened page or empty string if no page opened

     wxString m_OpenedPage;
     // contains name of current anchor within m_OpenedPage
     wxString m_OpenedAnchor;
     wxString m_OpenedPage;
     // contains name of current anchor within m_OpenedPage
     wxString m_OpenedAnchor;

-    // contains title of actualy opened page or empty string if no <TITLE> tag
+    // contains title of actually opened page or empty string if no <TITLE> tag

     wxString m_OpenedPageTitle;
     // class for opening files (file system)
     wxFileSystem* m_FS;
 
     wxString m_OpenedPageTitle;
     // class for opening files (file system)
     wxFileSystem* m_FS;
 

+    // frame in which page title should be displayed & number of its statusbar
+    // reserved for usage with this html window

     wxFrame *m_RelatedFrame;
     wxFrame *m_RelatedFrame;

-    wxString m_TitleFormat;

 #if wxUSE_STATUSBAR
 #if wxUSE_STATUSBAR

-    // frame in which page title should be displayed & number of it's statusbar
-    // reserved for usage with this html window
-    int m_RelatedStatusBar;
+    int m_RelatedStatusBarIndex;
+    wxStatusBar* m_RelatedStatusBar;

 #endif // wxUSE_STATUSBAR
 #endif // wxUSE_STATUSBAR

+    wxString m_TitleFormat;

 
     // borders (free space between text and window borders)
     // defaults to 10 pixels.
 
     // borders (free space between text and window borders)
     // defaults to 10 pixels.


@@ -508,8 +511,13 @@ protected:
 #endif // wxUSE_CLIPBOARD
 
 private:
 #endif // wxUSE_CLIPBOARD
 
 private:

-    // window content for double buffered rendering:
-    wxBitmap *m_backBuffer;
+    // erase the window background using m_bmpBg or just solid colour if we
+    // don't have any background image
+    void DoEraseBackground(wxDC& dc);
+
+    // window content for double buffered rendering, may be invalid until it is
+    // really initialized in OnPaint()
+    wxBitmap m_backBuffer;

 
     // background image, may be invalid
     wxBitmap m_bmpBg;
 
     // background image, may be invalid
     wxBitmap m_bmpBg;


@@ -537,29 +545,19 @@ private:
     // if this FLAG is false, items are not added to history
     bool m_HistoryOn;
 
     // if this FLAG is false, items are not added to history
     bool m_HistoryOn;
 

-    // a flag set if we need to erase background in OnPaint() (otherwise this
-    // is supposed to have been done in OnEraseBackground())
-    bool m_eraseBgInOnPaint;
-

     // standard mouse cursors
     static wxCursor *ms_cursorLink;
     static wxCursor *ms_cursorText;
 
     DECLARE_EVENT_TABLE()
     // standard mouse cursors
     static wxCursor *ms_cursorLink;
     static wxCursor *ms_cursorText;
 
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxHtmlWindow)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlWindow);

 };
 
 };
 

+class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent;

 
 

-
-
-BEGIN_DECLARE_EVENT_TYPES()
-    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_HTML,
-                                wxEVT_COMMAND_HTML_CELL_CLICKED, 1000)
-    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_HTML,
-                                wxEVT_COMMAND_HTML_CELL_HOVER, 1001)
-    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_HTML,
-                                wxEVT_COMMAND_HTML_LINK_CLICKED, 1002)
-END_DECLARE_EVENT_TYPES()
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_CLICKED, wxHtmlCellEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_HOVER, wxHtmlCellEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_LINK_CLICKED, wxHtmlLinkEvent );

 
 
 /*!
 
 
 /*!


@@ -633,9 +631,9 @@ typedef void (wxEvtHandler::*wxHtmlCellEventFunction)(wxHtmlCellEvent&);
 typedef void (wxEvtHandler::*wxHtmlLinkEventFunction)(wxHtmlLinkEvent&);
 
 #define wxHtmlCellEventHandler(func) \
 typedef void (wxEvtHandler::*wxHtmlLinkEventFunction)(wxHtmlLinkEvent&);
 
 #define wxHtmlCellEventHandler(func) \

-    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHtmlCellEventFunction, &func)
+    wxEVENT_HANDLER_CAST(wxHtmlCellEventFunction, func)

 #define wxHtmlLinkEventHandler(func) \
 #define wxHtmlLinkEventHandler(func) \

-    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHtmlLinkEventFunction, &func)
+    wxEVENT_HANDLER_CAST(wxHtmlLinkEventFunction, func)

 
 #define EVT_HTML_CELL_CLICKED(id, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_CLICKED, id, wxHtmlCellEventHandler(fn))
 
 #define EVT_HTML_CELL_CLICKED(id, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_CLICKED, id, wxHtmlCellEventHandler(fn))