WXUSINGDLL is defined when building samples on non-MSW platforms for simplicity,...

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

diff --git a/include/wx/html/htmlwin.h b/include/wx/html/htmlwin.h
index 75585561b6a76c9b211aedaf67fb9b86f222c474..0e4fab1eda97aa8fec7529651b13750103dab191 100644 (file)
--- a/include/wx/html/htmlwin.h
+++ b/include/wx/html/htmlwin.h
@@ -11,7 +11,7 @@
 #ifndef _WX_HTMLWIN_H_
 #define _WX_HTMLWIN_H_
 
 #ifndef _WX_HTMLWIN_H_
 #define _WX_HTMLWIN_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface "htmlwin.h"
 #endif
 
 #pragma interface "htmlwin.h"
 #endif
 


@@ -21,66 +21,79 @@
 #include "wx/window.h"
 #include "wx/scrolwin.h"
 #include "wx/config.h"
 #include "wx/window.h"
 #include "wx/scrolwin.h"
 #include "wx/config.h"

-#include "wx/treectrl.h"

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

+#include "wx/filename.h"

 
 

+class wxHtmlProcessor;
+class wxHtmlWinModule;
+class wxHtmlHistoryArray;
+class wxHtmlProcessorList;
+class WXDLLIMPEXP_HTML wxHtmlWinAutoScrollTimer;

 
 

-//--------------------------------------------------------------------------------
-// wxHtmlWindow
-//                  (This is probably the only class you will directly use.)
-//                  Purpose of this class is to display HTML page (either local
-//                  file or downloaded via HTTP protocol) in a window. Width
-//                  of window is constant - given in constructor - virtual height
-//                  is changed dynamicly depending on page size.
-//                  Once the window is created you can set it's content by calling
-//                  SetPage(text) or LoadPage(filename).
-//--------------------------------------------------------------------------------

 
 

+// wxHtmlWindow flags:
+#define wxHW_SCROLLBAR_NEVER    0x0002
+#define wxHW_SCROLLBAR_AUTO     0x0004
+#define wxHW_NO_SELECTION       0x0008

 
 

-// item of history list
-class WXDLLEXPORT HtmlHistoryItem : public wxObject
-{
-public:
-    HtmlHistoryItem(const wxString& p, const wxString& a) {m_Page = p, m_Anchor = a, m_Pos = 0;}
-    int GetPos() const {return m_Pos;}
-    void SetPos(int p) {m_Pos = p;}
-    const wxString& GetPage() const {return m_Page;}
-    const wxString& GetAnchor() const {return m_Anchor;}
-
-private:
-    wxString m_Page;
-    wxString m_Anchor;
-    int m_Pos;
-};
+#define wxHW_DEFAULT_STYLE      wxHW_SCROLLBAR_AUTO

 
 
 
 

-WX_DECLARE_EXPORTED_OBJARRAY(HtmlHistoryItem, HtmlHistoryArray);
+// enums for wxHtmlWindow::OnOpeningURL
+enum wxHtmlOpeningStatus
+{
+    wxHTML_OPEN,
+    wxHTML_BLOCK,
+    wxHTML_REDIRECT
+};

 
 

-class wxHtmlWinModule;
+// ----------------------------------------------------------------------------
+// wxHtmlWindow
+//                  (This is probably the only class you will directly use.)
+//                  Purpose of this class is to display HTML page (either local
+//                  file or downloaded via HTTP protocol) in a window. Width of
+//                  window is constant - given in constructor - virtual height
+//                  is changed dynamicly depending on page size.  Once the
+//                  window is created you can set it's content by calling
+//                  SetPage(text) or LoadPage(filename).
+// ----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxHtmlWindow : public wxScrolledWindow
+class WXDLLIMPEXP_HTML wxHtmlWindow : public wxScrolledWindow

 {
     DECLARE_DYNAMIC_CLASS(wxHtmlWindow)
     friend class wxHtmlWinModule;
 
 public:
 {
     DECLARE_DYNAMIC_CLASS(wxHtmlWindow)
     friend class wxHtmlWinModule;
 
 public:

-    wxHtmlWindow() : wxScrolledWindow() {};
+    wxHtmlWindow() { Init(); }

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

-                 const wxPoint& pos = wxDefaultPosition, 
+                 const wxPoint& pos = wxDefaultPosition,

                  const wxSize& size = wxDefaultSize,
                  const wxSize& size = wxDefaultSize,

-                 long style = wxHW_SCROLLBAR_AUTO,
-                 const wxString& name = "htmlWindow");
+                 long style = wxHW_DEFAULT_STYLE,
+                 const wxString& name = wxT("htmlWindow"))
+    {
+        Init();
+        Create(parent, id, pos, size, style, name);
+    }

     ~wxHtmlWindow();
 
     ~wxHtmlWindow();
 

+    bool Create(wxWindow *parent, wxWindowID id = -1,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxHW_SCROLLBAR_AUTO,
+                const wxString& name = wxT("htmlWindow"));
+

     // 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);
 
     // 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);
 

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

     // Load HTML page from given location. Location can be either
     // a) /usr/wxGTK2/docs/html/wx.htm
     // b) http://www.somewhere.uk/document.htm
     // Load HTML page from given location. Location can be either
     // a) /usr/wxGTK2/docs/html/wx.htm
     // b) http://www.somewhere.uk/document.htm


@@ -90,7 +103,10 @@ public:
     // After the page is loaded, the method calls SetPage() to display it.
     // Note : you can also use path relative to previously loaded page
     // Return value : same as SetPage
     // After the page is loaded, the method calls SetPage() to display it.
     // Note : you can also use path relative to previously loaded page
     // Return value : same as SetPage

-    bool LoadPage(const wxString& location);
+    virtual bool LoadPage(const wxString& location);
+
+    // Loads HTML page from file
+    bool LoadFile(const wxFileName& filename);

 
     // Returns full location of opened page
     wxString GetOpenedPage() const {return m_OpenedPage;}
 
     // Returns full location of opened page
     wxString GetOpenedPage() const {return m_OpenedPage;}


@@ -109,11 +125,8 @@ public:
     void SetRelatedStatusBar(int bar);
 
     // Sets fonts to be used when displaying HTML page.
     void SetRelatedStatusBar(int bar);
 
     // Sets fonts to be used when displaying HTML page.

-    void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes);
-
-    // Sets the title of the window
-    // (depending on the information passed to SetRelatedFrame() method)
-    virtual void OnSetTitle(const wxString& title);
+    void SetFonts(wxString normal_face, wxString fixed_face,
+                  const int *sizes = NULL);

 
     // 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;}


@@ -141,94 +154,196 @@ public:
     // Adds input filter
     static void AddFilter(wxHtmlFilter *filter);
 
     // Adds input filter
     static void AddFilter(wxHtmlFilter *filter);
 

-    // Called when users clicked on hypertext link. Default behavior is to
+    // Returns a pointer to the parser.
+    wxHtmlWinParser *GetParser() const { return m_Parser; }
+
+    // Adds HTML processor to this instance of wxHtmlWindow:
+    void AddProcessor(wxHtmlProcessor *processor);
+    // Adds HTML processor to wxHtmlWindow class as whole:
+    static void AddGlobalProcessor(wxHtmlProcessor *processor);
+
+    // -- Callbacks --
+
+    // Sets the title of the window
+    // (depending on the information passed to SetRelatedFrame() method)
+    virtual void OnSetTitle(const wxString& title);
+
+    // Called when the mouse hovers over a cell: (x, y) are logical coords
+    // Default behaviour is to do nothing at all
+    virtual void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
+
+    // Called when user clicks on a cell. Default behavior is to call
+    // OnLinkClicked() if this cell corresponds to a hypertext link
+    virtual void OnCellClicked(wxHtmlCell *cell,
+                               wxCoord x, wxCoord y,
+                               const wxMouseEvent& event);
+
+    // Called when user clicked on hypertext link. Default behavior is to

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

-    // Returns a pointer to the parser.
-    wxHtmlWinParser *GetParser() const { return m_Parser; }
+    // 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,
+    // 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();
+#endif

 
 

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

 protected:
 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
     bool ScrollToAnchor(const wxString& anchor);
 
     // 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
     bool ScrollToAnchor(const wxString& anchor);
 

-    // Prepares layout (= fill m_PosX, m_PosY for fragments) based on 
+    // Prepares layout (= fill m_PosX, m_PosY for fragments) based on

     // actual size of window. This method also setup scrollbars
     void CreateLayout();
 
     // actual size of window. This method also setup scrollbars
     void CreateLayout();
 

-    void OnDraw(wxDC& dc);
+    void OnEraseBackground(wxEraseEvent& event);
+    void OnPaint(wxPaintEvent& event);

     void OnSize(wxSizeEvent& event);
     void OnSize(wxSizeEvent& event);

-    void OnMouseEvent(wxMouseEvent& event);
-    void OnIdle(wxIdleEvent& event);
+    void OnMouseMove(wxMouseEvent& event);
+    void OnMouseDown(wxMouseEvent& event);
+    void OnMouseUp(wxMouseEvent& event);
+#if wxUSE_CLIPBOARD
+    void OnKeyUp(wxKeyEvent& event);
+    void OnDoubleClick(wxMouseEvent& event);
+    void OnCopy(wxCommandEvent& event);
+    void OnMouseEnter(wxMouseEvent& event);
+    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;}
 

+    // cleans static variables

     static void CleanUpStatics();
     static void CleanUpStatics();

-        // cleans static variables

 
 

+    // Returns true if text selection is enabled (wxClipboard must be available
+    // and wxHW_NO_SELECTION not used)
+    bool IsSelectionEnabled() const;
+
+    enum ClipboardType
+    {
+        Primary,
+        Secondary
+    };
+
+    // Copies selection to clipboard if the clipboard support is available
+    //
+    // returns true if anything was copied to clipboard, false otherwise
+    bool CopySelection(ClipboardType t = Secondary);
+
+#if wxUSE_CLIPBOARD
+    // Convert selection to text:
+    wxString SelectionToText();
+
+    // Automatic scrolling during selection:
+    void StopAutoScrolling();
+#endif // wxUSE_CLIPBOARD

 
 protected:
 
 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;
     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)
+    // parser which is used to parse HTML input.
+    // Each wxHtmlWindow has it's own parser because sharing one global
+    // parser would be problematic (because of reentrancy)

     wxHtmlWinParser *m_Parser;
     wxHtmlWinParser *m_Parser;

-            // parser which is used to parse HTML input.
-            // Each wxHtmlWindow has it's own parser because sharing one global
-            // parser would be problematic (because of reentrancy)
+    // contains name of actualy opened page or empty string if no page opened

     wxString m_OpenedPage;
     wxString m_OpenedPage;

-            // contains name of actualy opened page or empty string if no page opened
+    // contains name of current anchor within m_OpenedPage

     wxString m_OpenedAnchor;
     wxString m_OpenedAnchor;

-            // contains name of current anchor within m_OpenedPage
+    // contains title of actualy opened page or empty string if no <TITLE> tag

     wxString m_OpenedPageTitle;
     wxString m_OpenedPageTitle;

-            // contains title of actualy opened page or empty string if no <TITLE> tag
+    // class for opening files (file system)

     wxFileSystem* m_FS;
     wxFileSystem* m_FS;

-            // class for opening files (file system)

 
     wxFrame *m_RelatedFrame;
     wxString m_TitleFormat;
 
     wxFrame *m_RelatedFrame;
     wxString m_TitleFormat;

+    // 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_RelatedStatusBar;

-            // frame in which page title should be displayed & number of it's statusbar
-            // reserved for usage with this html window

 
 

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

     int m_Borders;
     int m_Borders;

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

 
     int m_Style;
 
 
     int m_Style;
 

+    // current text selection or NULL
+    wxHtmlSelection *m_selection;
+
+    // true if the user is dragging mouse to select text
+    bool m_makingSelection;
+
+#if wxUSE_CLIPBOARD
+    // time of the last doubleclick event, used to detect tripleclicks
+    // (tripleclicks are used to select whole line):
+    wxLongLong m_lastDoubleClick;
+
+    // helper class to automatically scroll the window if the user is selecting
+    // text and the mouse leaves wxHtmlWindow:
+    wxHtmlWinAutoScrollTimer *m_timerAutoScroll;
+#endif // wxUSE_CLIPBOARD
+

 private:
 private:

+    // window content for double buffered rendering:
+    wxBitmap *m_backBuffer;
+
+    // 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;
     bool m_tmpMouseMoved;

-            // a flag indicated if mouse moved
-            // (if TRUE we will try to change cursor in last call to OnIdle)
+    // contains last link name

     wxHtmlLinkInfo *m_tmpLastLink;
     wxHtmlLinkInfo *m_tmpLastLink;

-            // contains last link name
+    // contains the last (terminal) cell which contained the mouse
+    wxHtmlCell *m_tmpLastCell;
+    // if >0 contents of the window is not redrawn
+    // (in order to avoid ugly blinking)

     int m_tmpCanDrawLocks;
     int m_tmpCanDrawLocks;

-            // if >0 contents of the window is not redrawn
-            // (in order to avoid ugly blinking)

 
 

+    // list of HTML filters

     static wxList m_Filters;
     static wxList m_Filters;

-            // list of HTML filters
+    // this filter is used when no filter is able to read some file

     static wxHtmlFilter *m_DefaultFilter;
     static wxHtmlFilter *m_DefaultFilter;

-            // this filter is used when no filter is able to read some file

 
 

-    static wxCursor *s_cur_hand;
-    static wxCursor *s_cur_arrow;
-
-    HtmlHistoryArray m_History;
+    wxHtmlHistoryArray *m_History;
+    // browser history

     int m_HistoryPos;
     int m_HistoryPos;

-            // browser history
+    // if this FLAG is false, items are not added to history

     bool m_HistoryOn;
     bool m_HistoryOn;

-            // if this FLAG is false, items are not added to history

 
 

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

 
     DECLARE_EVENT_TABLE()
 
     DECLARE_EVENT_TABLE()

+    DECLARE_NO_COPY_CLASS(wxHtmlWindow)

 };
 
 
 };
 
 

-#endif
+#endif // wxUSE_HTML

 
 #endif // _WX_HTMLWIN_H_
 
 #endif // _WX_HTMLWIN_H_

+