DEBUGREPORT
[wxWidgets.git] / include / wx / html / htmlwin.h
index df896b6f5e56958481e3f1e990c3bb61294cd186..388cc120103741bdec070573f1532d9db4a2c954 100644 (file)
@@ -4,15 +4,15 @@
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik
-// Licence:     wxWindows Licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 #ifndef _WX_HTMLWIN_H_
 #define _WX_HTMLWIN_H_
 
-#ifdef __GNUG__
-#pragma interface
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#pragma interface "htmlwin.h"
 #endif
 
 #include "wx/defs.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/filename.h"
+#include "wx/bitmap.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
+};
 
+// ----------------------------------------------------------------------------
+// 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)
-
-    public:
-        wxHtmlWindow() : wxScrolledWindow() {};
-        wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
-                     const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
-                     long style = wxHW_SCROLLBAR_AUTO,
-                     const wxString& name = "htmlWindow");
-        ~wxHtmlWindow();
-
-        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 LoadPage(const wxString& location);
-                // Load HTML page from given location. Location can be either
-                // a) /usr/wxGTK2/docs/html/wx.htm
-                // b) http://www.somewhere.uk/document.htm
-                // c) ftp://ftp.somesite.cz/pub/something.htm
-                // In case there is no prefix (http:,ftp:), the method
-                // will try to find it itself (1. local file, then http or ftp)
-                // 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
-
-        wxString GetOpenedPage() const {return m_OpenedPage;}
-                // Returns full location of opened page
-
-        wxString GetOpenedPageTitle() const {return m_OpenedPageTitle;}
-                // Returns <TITLE> of opened page or empty string otherwise
-
-        void SetRelatedFrame(wxFrame* frame, const wxString& format);
-                // sets frame in which page title will  be displayed. Format is format of
-                // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
-        wxFrame* GetRelatedFrame() const {return m_RelatedFrame;}
-
-        void SetRelatedStatusBar(int bar);
-                // after(!) calling SetRelatedFrame, this sets statusbar slot where messages
-                // will be displayed. Default is -1 = no messages.
-
-        void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes);
-                // sets fonts to be used when displaying HTML page.
-
-        virtual void OnSetTitle(const wxString& title);
-                // Sets the title of the window
-                // (depending on the information passed to SetRelatedFrame() method)
-
-        void SetBorders(int b) {m_Borders = b;}
-                // Sets space between text and window borders.
-
-        virtual void ReadCustomization(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 WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
-                // ...
-
-        bool HistoryBack();
-        bool HistoryForward();
-                // Goes to previous/next page (in browsing history)
-                // Returns TRUE if successful, FALSE otherwise
-        void HistoryClear();
-                // Resets history
-
-        wxHtmlContainerCell* GetInternalRepresentation() const {return m_Cell;}
-                // Returns pointer to conteiners/cells structure.
-                // It should be used ONLY when printing
-
-        static void AddFilter(wxHtmlFilter *filter);
-                // Adds input filter
-
-        virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
-                // called when users clicked on hypertext link. Default behavior is to
-                // call LoadPage(loc)
-
-        static void CleanUpStatics();
-               // cleans static variables
-
-        wxHtmlWinParser *GetParser() const { return m_Parser; }
-                // return a pointer to the parser.
-
-    protected:
-        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
-
-        void CreateLayout();
-                // prepare layout (= fill m_PosX, m_PosY for fragments) based on actual size of
-                // window. This method also setup scrollbars
-
-        void OnDraw(wxDC& dc);
-        void OnSize(wxSizeEvent& event);
-        void OnMouseEvent(wxMouseEvent& event);
-        void OnIdle(wxIdleEvent& event);
-        void OnKeyDown(wxKeyEvent& event);
-
-        virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
-               // returns new filter (will be stored into m_DefaultFilter variable)
-
-
-    protected:
-        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)
-        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)
-        wxString m_OpenedPage;
-                // contains name of actualy opened page or empty string if no page opened
-        wxString m_OpenedAnchor;
-                // contains name of current anchor within m_OpenedPage
-        wxString m_OpenedPageTitle;
-                // contains title of actualy opened page or empty string if no <TITLE> tag
-        wxFileSystem* m_FS;
-                // class for opening files (file system)
-
-        wxFrame *m_RelatedFrame;
-        wxString m_TitleFormat;
-        int m_RelatedStatusBar;
-                // frame in which page title should be displayed & number of it's statusbar
-                // reserved for usage with this html window
-
-        int m_Borders;
-                // borders (free space between text and window borders)
-                // defaults to 10 pixels.
-
-        int m_Style;
-
-    private:
-        bool m_tmpMouseMoved;
-                // a flag indicated if mouse moved
-                // (if TRUE we will try to change cursor in last call to OnIdle)
-        wxHtmlLinkInfo *m_tmpLastLink;
-                // contains last link name
-        int m_tmpCanDrawLocks;
-                // if >0 contents of the window is not redrawn
-                // (in order to avoid ugly bliking)
-
-        static wxList m_Filters;
-                // list of HTML filters
-        static wxHtmlFilter *m_DefaultFilter;
-                // this filter is used when no filter is able to read some file
-
-        HtmlHistoryArray m_History;
-        int m_HistoryPos;
-                // browser history
-        bool m_HistoryOn;
-                // if this FLAG is false, items are not added to history
-
+    friend class wxHtmlWinModule;
+
+public:
+    wxHtmlWindow() { Init(); }
+    wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = wxHW_DEFAULT_STYLE,
+                 const wxString& name = wxT("htmlWindow"))
+    {
+        Init();
+        Create(parent, id, pos, size, style, name);
+    }
+    ~wxHtmlWindow();
+
+    bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
+                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);
+
+    // 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
+    // c) ftp://ftp.somesite.cz/pub/something.htm
+    // In case there is no prefix (http:,ftp:), the method
+    // will try to find it itself (1. local file, then http or ftp)
+    // 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
+    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 anchor within opened page
+    wxString GetOpenedAnchor() const {return m_OpenedAnchor;}
+    // Returns <TITLE> of opened page or empty string otherwise
+    wxString GetOpenedPageTitle() const {return m_OpenedPageTitle;}
+
+    // Sets frame in which page title will  be displayed. Format is format of
+    // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
+    void SetRelatedFrame(wxFrame* frame, const wxString& format);
+    wxFrame* GetRelatedFrame() const {return m_RelatedFrame;}
+
+#if wxUSE_STATUSBAR
+    // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
+    // will be displayed. Default is -1 = no messages.
+    void SetRelatedStatusBar(int bar);
+#endif // wxUSE_STATUSBAR
+
+    // Sets fonts to be used when displaying HTML page.
+    void SetFonts(wxString normal_face, wxString fixed_face,
+                  const int *sizes = NULL);
+
+    // 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 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.
+    virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
+    // ...
+    virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
+
+    // Goes to previous/next page (in browsing history)
+    // Returns true if successful, false otherwise
+    bool HistoryBack();
+    bool HistoryForward();
+    bool HistoryCanBack();
+    bool HistoryCanForward();
+    // Resets history
+    void HistoryClear();
+
+    // Returns pointer to conteiners/cells structure.
+    // It should be used ONLY when printing
+    wxHtmlContainerCell* GetInternalRepresentation() const {return m_Cell;}
+
+    // Adds input filter
+    static void AddFilter(wxHtmlFilter *filter);
+
+    // 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);
+
+    // 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();
+
+    // Convert selection to text:
+    wxString SelectionToText() { return DoSelectionToText(m_selection); }
+
+    // Converts current page to text:
+    wxString ToText();
+#endif // wxUSE_CLIPBOARD
+
+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);
+
+    // Prepares layout (= fill m_PosX, m_PosY for fragments) based on
+    // 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 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;}
+
+    // cleans static variables
+    static void CleanUpStatics();
+
+    // 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
+    // Automatic scrolling during selection:
+    void StopAutoScrolling();
+#endif // wxUSE_CLIPBOARD
+
+protected:
+    wxString DoSelectionToText(wxHtmlSelection *sel);
+
+    // 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;
+    // 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;
+    // contains name of actualy opened page or empty string if no page opened
+    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
+    wxString m_OpenedPageTitle;
+    // class for opening files (file system)
+    wxFileSystem* m_FS;
+
+    wxFrame *m_RelatedFrame;
+    wxString m_TitleFormat;
+#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;
+#endif // wxUSE_STATUSBAR
+
+    // borders (free space between text and window borders)
+    // defaults to 10 pixels.
+    int m_Borders;
+
+    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:
+    // 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;
+
+    // contains last link name
+    wxHtmlLinkInfo *m_tmpLastLink;
+    // 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;
+
+    // list of HTML filters
+    static wxList m_Filters;
+    // this filter is used when no filter is able to read some file
+    static wxHtmlFilter *m_DefaultFilter;
+
+    // html processors array:
+    wxHtmlProcessorList *m_Processors;
+    static wxHtmlProcessorList *m_GlobalProcessors;
+
+    // browser history
+    wxHtmlHistoryArray *m_History;
+    int m_HistoryPos;
+    // if this FLAG is false, items are not added to history
+    bool m_HistoryOn;
+
+    // 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)
 };
 
 
-#endif
+#endif // wxUSE_HTML
 
 #endif // _WX_HTMLWIN_H_
+