]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/html/htmlwin.h
Works a little better when you remember to say "virtual"
[wxWidgets.git] / include / wx / html / htmlwin.h
index 14ed7b410bba228c7eb50d82c711c74d08b27fe2..6e8b6ebb6da99c6165b305a3030404447b0b5f46 100644 (file)
@@ -11,7 +11,7 @@
 #ifndef _WX_HTMLWIN_H_
 #define _WX_HTMLWIN_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "htmlwin.h"
 #endif
 
 #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"
 
 class wxHtmlProcessor;
 class wxHtmlWinModule;
 class wxHtmlHistoryArray;
 class wxHtmlProcessorList;
+class WXDLLIMPEXP_HTML wxHtmlWinAutoScrollTimer;
 
 
 // wxHtmlWindow flags:
 #define wxHW_SCROLLBAR_NEVER    0x0002
 #define wxHW_SCROLLBAR_AUTO     0x0004
+#define wxHW_NO_SELECTION       0x0008
+
+#define wxHW_DEFAULT_STYLE      wxHW_SCROLLBAR_AUTO
+
 
 // enums for wxHtmlWindow::OnOpeningURL
 enum wxHtmlOpeningStatus
@@ -45,18 +50,18 @@ enum wxHtmlOpeningStatus
     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
+//                  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;
@@ -66,7 +71,7 @@ public:
     wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
-                 long style = wxHW_SCROLLBAR_AUTO,
+                 long style = wxHW_DEFAULT_STYLE,
                  const wxString& name = wxT("htmlWindow"))
     {
         Init();
@@ -100,6 +105,9 @@ public:
     // 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
@@ -117,7 +125,8 @@ public:
     void SetRelatedStatusBar(int bar);
 
     // Sets fonts to be used when displaying HTML page.
-    void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes);
+    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;}
@@ -153,9 +162,6 @@ public:
     // Adds HTML processor to wxHtmlWindow class as whole:
     static void AddGlobalProcessor(wxHtmlProcessor *processor);
 
-    // what would we do with it?
-    virtual bool AcceptsFocusFromKeyboard() const { return FALSE; }
-
     // -- Callbacks --
 
     // Sets the title of the window
@@ -198,10 +204,21 @@ protected:
     // 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 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;}
@@ -209,9 +226,34 @@ protected:
     // 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
+    void CopySelection(ClipboardType t = Secondary);
+
+#if wxUSE_CLIPBOARD
+    // Convert selection to text:
+    wxString SelectionToText();
+
+    // Helper functions to select parts of page:
+    void SelectWord(const wxPoint& pos);
+    void SelectLine(const wxPoint& pos);
+
+    // Automatic scrolling during selection:
+    void StopAutoScrolling();
+#endif // wxUSE_CLIPBOARD
+
 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)
+    // 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
@@ -238,7 +280,30 @@ protected:
 
     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;
+
+    // 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;
@@ -255,9 +320,6 @@ private:
     // this filter is used when no filter is able to read some file
     static wxHtmlFilter *m_DefaultFilter;
 
-    static wxCursor *s_cur_hand;
-    static wxCursor *s_cur_arrow;
-
     wxHtmlHistoryArray *m_History;
     // browser history
     int m_HistoryPos;
@@ -269,10 +331,11 @@ private:
     static wxHtmlProcessorList *m_GlobalProcessors;
 
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxHtmlWindow)
 };
 
 
-#endif
+#endif // wxUSE_HTML
 
 #endif // _WX_HTMLWIN_H_