Warning fix for wxOS2 night build.

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

diff --git a/include/wx/html/htmlwin.h b/include/wx/html/htmlwin.h
index 62f044657310a876a5a7611d5aebf68c0c7a35ed..719173bedbaf763cd890b3a9608dc83542465bb1 100644 (file)
--- a/include/wx/html/htmlwin.h
+++ b/include/wx/html/htmlwin.h
@@ -7,25 +7,22 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-

 #ifndef _WX_HTMLWIN_H_
 #define _WX_HTMLWIN_H_
 
 #ifndef _WX_HTMLWIN_H_
 #define _WX_HTMLWIN_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "htmlwin.h"
-#endif
-

 #include "wx/defs.h"
 #if wxUSE_HTML
 
 #include "wx/window.h"
 #include "wx/scrolwin.h"
 #include "wx/config.h"
 #include "wx/defs.h"
 #if wxUSE_HTML
 
 #include "wx/window.h"
 #include "wx/scrolwin.h"
 #include "wx/config.h"

+#include "wx/stopwatch.h"

 #include "wx/html/winpars.h"
 #include "wx/html/htmlcell.h"
 #include "wx/filesys.h"
 #include "wx/html/htmlfilt.h"
 #include "wx/filename.h"
 #include "wx/html/winpars.h"
 #include "wx/html/htmlcell.h"
 #include "wx/filesys.h"
 #include "wx/html/htmlfilt.h"
 #include "wx/filename.h"

+#include "wx/bitmap.h"

 
 class wxHtmlProcessor;
 class wxHtmlWinModule;
 
 class wxHtmlProcessor;
 class wxHtmlWinModule;


@@ -68,7 +65,7 @@ class WXDLLIMPEXP_HTML wxHtmlWindow : public wxScrolledWindow
 
 public:
     wxHtmlWindow() { Init(); }
 
 public:
     wxHtmlWindow() { Init(); }

-    wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
+    wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY,

                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = wxHW_DEFAULT_STYLE,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = wxHW_DEFAULT_STYLE,


@@ -79,7 +76,7 @@ public:
     }
     ~wxHtmlWindow();
 
     }
     ~wxHtmlWindow();
 

-    bool Create(wxWindow *parent, wxWindowID id = -1,
+    bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxHW_SCROLLBAR_AUTO,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxHW_SCROLLBAR_AUTO,


@@ -88,8 +85,8 @@ 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
     // 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
-    bool SetPage(const wxString& source);
+    // Return value : false if an error occurred, true otherwise
+    virtual bool SetPage(const wxString& source);

 
     // Append to current page
     bool AppendToPage(const wxString& source);
 
     // Append to current page
     bool AppendToPage(const wxString& source);


@@ -127,15 +124,22 @@ public:
 #endif // wxUSE_STATUSBAR
 
     // Sets fonts to be used when displaying HTML page.
 #endif // wxUSE_STATUSBAR
 
     // Sets fonts to be used when displaying HTML page.

-    void SetFonts(wxString normal_face, wxString fixed_face,
+    void SetFonts(const wxString& normal_face, const wxString& fixed_face,

                   const int *sizes = NULL);
 
                   const int *sizes = NULL);
 

-    // Sets font sizes to be relative to the given size or the system default size
-    void NormalizeFontSizes(int size=-1);
-    
+    // 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 = wxEmptyString,
+                          const wxString& fixed_face = wxEmptyString);
+

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

+    // Sets the bitmap to use for background (currnetly it will be tiled,
+    // when/if we have CSS support we could add other possibilities...)
+    void SetBackgroundImage(const wxBitmap& bmpBg) { m_bmpBg = bmpBg; }
+

     // 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.
     // 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.


@@ -144,7 +148,7 @@ public:
     virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 
     // Goes to previous/next page (in browsing history)
     virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 
     // 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();
     bool HistoryBack();
     bool HistoryForward();
     bool HistoryCanBack();


@@ -167,6 +171,7 @@ public:
     // Adds HTML processor to wxHtmlWindow class as whole:
     static void AddGlobalProcessor(wxHtmlProcessor *processor);
 
     // Adds HTML processor to wxHtmlWindow class as whole:
     static void AddGlobalProcessor(wxHtmlProcessor *processor);
 

+

     // -- Callbacks --
 
     // Sets the title of the window
     // -- Callbacks --
 
     // Sets the title of the window


@@ -189,36 +194,35 @@ public:
 
     // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when
     // loading a page or loading an image). The data are downloaded if and only if
 
     // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when
     // loading a page or loading an image). The data are downloaded if and only if

-    // OnOpeningURL returns TRUE. If OnOpeningURL returns wxHTML_REDIRECT,
+    // OnOpeningURL returns true. If OnOpeningURL returns wxHTML_REDIRECT,

     // it must set *redirect to the new URL
     virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
                                              const wxString& WXUNUSED(url),
                                              wxString *WXUNUSED(redirect)) const
         { return wxHTML_OPEN; }
     // it must set *redirect to the new URL
     virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
                                              const wxString& WXUNUSED(url),
                                              wxString *WXUNUSED(redirect)) const
         { return wxHTML_OPEN; }

-   
+

 #if wxUSE_CLIPBOARD
     // Helper functions to select parts of page:
     void SelectWord(const wxPoint& pos);
     void SelectLine(const wxPoint& pos);
     void SelectAll();
 #if wxUSE_CLIPBOARD
     // 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() { return DoSelectionToText(m_selection); }
 
     // Converts current page to text:
     wxString ToText();
     // Convert selection to text:
     wxString SelectionToText() { return DoSelectionToText(m_selection); }
 
     // Converts current page to text:
     wxString ToText();

-#endif
+#endif // wxUSE_CLIPBOARD
+
+    virtual void OnInternalIdle();

 
 

-    virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg))
-        { /* do nothing */ }
-    

 protected:
     void Init();
 
     // Scrolls to anchor of this name. (Anchor is #news
     // or #features etc. it is part of address sometimes:
     // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
 protected:
     void Init();
 
     // Scrolls to anchor of this name. (Anchor is #news
     // or #features etc. it is part of address sometimes:
     // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)

-    // Return value : TRUE if anchor exists, FALSE otherwise
+    // Return value : true if anchor exists, false otherwise

     bool ScrollToAnchor(const wxString& anchor);
 
     // Prepares layout (= fill m_PosX, m_PosY for fragments) based on
     bool ScrollToAnchor(const wxString& anchor);
 
     // Prepares layout (= fill m_PosX, m_PosY for fragments) based on


@@ -239,8 +243,6 @@ protected:
     void OnMouseLeave(wxMouseEvent& event);
 #endif // wxUSE_CLIPBOARD
 
     void OnMouseLeave(wxMouseEvent& event);
 #endif // wxUSE_CLIPBOARD
 

-    virtual void OnInternalIdle();
-

     // Returns new filter (will be stored into m_DefaultFilter variable)
     virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
 
     // Returns new filter (will be stored into m_DefaultFilter variable)
     virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
 


@@ -267,9 +269,13 @@ protected:
     void StopAutoScrolling();
 #endif // wxUSE_CLIPBOARD
 
     void StopAutoScrolling();
 #endif // wxUSE_CLIPBOARD
 

-protected:

     wxString DoSelectionToText(wxHtmlSelection *sel);
     wxString DoSelectionToText(wxHtmlSelection *sel);

-    
+
+private:
+    // implementation of SetPage()
+    bool DoSetPage(const wxString& source);
+
+protected:

     // This is pointer to the first cell in parsed data.  (Note: the first cell
     // is usually top one = all other cells are sub-cells of this one)
     wxHtmlContainerCell *m_Cell;
     // This is pointer to the first cell in parsed data.  (Note: the first cell
     // is usually top one = all other cells are sub-cells of this one)
     wxHtmlContainerCell *m_Cell;


@@ -309,7 +315,7 @@ protected:
 #if wxUSE_CLIPBOARD
     // time of the last doubleclick event, used to detect tripleclicks
     // (tripleclicks are used to select whole line):
 #if wxUSE_CLIPBOARD
     // time of the last doubleclick event, used to detect tripleclicks
     // (tripleclicks are used to select whole line):

-    wxLongLong m_lastDoubleClick;
+    wxMilliClock_t m_lastDoubleClick;

 
     // helper class to automatically scroll the window if the user is selecting
     // text and the mouse leaves wxHtmlWindow:
 
     // helper class to automatically scroll the window if the user is selecting
     // text and the mouse leaves wxHtmlWindow:


@@ -320,13 +326,13 @@ private:
     // window content for double buffered rendering:
     wxBitmap *m_backBuffer;
 
     // window content for double buffered rendering:
     wxBitmap *m_backBuffer;
 

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

     // variables used when user is selecting text
     wxPoint     m_tmpSelFromPos;
     wxHtmlCell *m_tmpSelFromCell;
 
     // variables used when user is selecting text
     wxPoint     m_tmpSelFromPos;
     wxHtmlCell *m_tmpSelFromCell;
 

-    // a flag indicated if mouse moved
-    // (if TRUE we will try to change cursor in last call to OnIdle)
-    bool m_tmpMouseMoved;

     // contains last link name
     wxHtmlLinkInfo *m_tmpLastLink;
     // contains the last (terminal) cell which contained the mouse
     // contains last link name
     wxHtmlLinkInfo *m_tmpLastLink;
     // contains the last (terminal) cell which contained the mouse


@@ -340,15 +346,23 @@ private:
     // this filter is used when no filter is able to read some file
     static wxHtmlFilter *m_DefaultFilter;
 
     // this filter is used when no filter is able to read some file
     static wxHtmlFilter *m_DefaultFilter;
 

-    wxHtmlHistoryArray *m_History;
+    // html processors array:
+    wxHtmlProcessorList *m_Processors;
+    static wxHtmlProcessorList *m_GlobalProcessors;
+

     // browser history
     // browser history

+    wxHtmlHistoryArray *m_History;

     int m_HistoryPos;
     // if this FLAG is false, items are not added to history
     bool m_HistoryOn;
 
     int m_HistoryPos;
     // if this FLAG is false, items are not added to history
     bool m_HistoryOn;
 

-    // html processors array:
-    wxHtmlProcessorList *m_Processors;
-    static wxHtmlProcessorList *m_GlobalProcessors;
+    // a flag indicated if mouse moved
+    // (if true we will try to change cursor in last call to OnIdle)
+    bool m_tmpMouseMoved;
+
+    // a flag set if we need to erase background in OnPaint() (otherwise this
+    // is supposed to have been done in OnEraseBackground())
+    bool m_eraseBgInOnPaint;

 
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxHtmlWindow)
 
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxHtmlWindow)