include/wx/gtk/webview_webkit.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        include/gtk/wx/webview.h
   3 // Purpose:     GTK webkit backend for web view component
   4 // Author:      Robert Roebling, Marianne Gagnon
   5 // Id:          $Id$
   6 // Copyright:   (c) 2010 Marianne Gagnon, 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GTK_WEBKITCTRL_H_
  11 #define _WX_GTK_WEBKITCTRL_H_
  12
  13 #include "wx/setup.h"
  14
  15 #if wxUSE_WEBVIEW_WEBKIT && defined(__WXGTK__)
  16
  17 #include "webkit/webkit.h"
  18 #include "wx/sharedptr.h"
  19 #include "wx/webview.h"
  20
  21 //A set of hash function so we can map wxWebHistoryItems to WebKitWebHistoryItems
  22 class SharedPtrHash
  23 {
  24 public:
  25     SharedPtrHash() { }
  26
  27     unsigned long operator()( const wxSharedPtr<wxWebHistoryItem> & item ) const
  28     {
  29
  30         return wxPointerHash()(item.get());
  31     }
  32     SharedPtrHash& operator=(const SharedPtrHash&) { return *this; }
  33 };
  34
  35 class SharedPtrEqual
  36 {
  37 public:
  38     SharedPtrEqual() { }
  39     bool operator()( const wxSharedPtr<wxWebHistoryItem> & a,
  40                      const wxSharedPtr<wxWebHistoryItem> & b ) const
  41     {
  42         return wxPointerEqual()(a.get(), b.get());
  43     }
  44
  45     SharedPtrEqual& operator=(const SharedPtrEqual&) { return *this; }
  46 };
  47
  48 WX_DECLARE_HASH_MAP(wxSharedPtr<wxWebHistoryItem>, WebKitWebHistoryItem*,
  49                     SharedPtrHash, SharedPtrEqual, HistoryItemHash);
  50
  51 //-----------------------------------------------------------------------------
  52 // wxWebViewWebKit
  53 //-----------------------------------------------------------------------------
  54
  55 class WXDLLIMPEXP_WEB wxWebViewWebKit : public wxWebView
  56 {
  57 public:
  58     wxWebViewWebKit() { Init(); }
  59
  60     wxWebViewWebKit(wxWindow *parent,
  61            wxWindowID id = wxID_ANY,
  62            const wxString& url = wxWebViewDefaultURLStr,
  63            const wxPoint& pos = wxDefaultPosition,
  64            const wxSize& size = wxDefaultSize, long style = 0,
  65            const wxString& name = wxWebViewNameStr)
  66     {
  67         Init();
  68
  69         Create(parent, id, url, pos, size, style, name);
  70     }
  71
  72     virtual bool Create(wxWindow *parent,
  73            wxWindowID id = wxID_ANY,
  74            const wxString& url = wxWebViewDefaultURLStr,
  75            const wxPoint& pos = wxDefaultPosition,
  76            const wxSize& size = wxDefaultSize, long style = 0,
  77            const wxString& name = wxWebViewNameStr);
  78
  79     virtual bool Enable( bool enable = true );
  80
  81     // implementation
  82     // --------------
  83
  84     static wxVisualAttributes
  85     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  86
  87     // helper to allow access to protected member from GTK callback
  88     void MoveWindow(int x, int y, int width, int height)
  89     {
  90         DoMoveWindow(x, y, width, height);
  91     }
  92
  93     void ZoomIn();
  94     void ZoomOut();
  95     void SetWebkitZoom(float level);
  96     float GetWebkitZoom();
  97
  98     virtual void Stop();
  99     virtual void LoadUrl(const wxString& url);
 100     virtual void GoBack();
 101     virtual void GoForward();
 102     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT);
 103     virtual bool CanGoBack();
 104     virtual bool CanGoForward();
 105     virtual void ClearHistory();
 106     virtual void EnableHistory(bool enable = true);
 107     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory();
 108     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory();
 109     virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item);
 110     virtual wxString GetCurrentURL();
 111     virtual wxString GetCurrentTitle();
 112     virtual wxString GetPageSource();
 113     virtual wxString GetPageText();
 114     //We do not want to hide the other overloads
 115     using wxWebView::SetPage;
 116     virtual void SetPage(const wxString& html, const wxString& baseUrl);
 117     virtual void Print();
 118     virtual bool IsBusy();
 119
 120     void SetZoomType(wxWebViewZoomType);
 121     wxWebViewZoomType GetZoomType() const;
 122     bool CanSetZoomType(wxWebViewZoomType) const;
 123     virtual wxWebViewZoom GetZoom();
 124     virtual void SetZoom(wxWebViewZoom);
 125
 126     //Clipboard functions
 127     virtual bool CanCut();
 128     virtual bool CanCopy();
 129     virtual bool CanPaste();
 130     virtual void Cut();
 131     virtual void Copy();
 132     virtual void Paste();
 133
 134     //Undo / redo functionality
 135     virtual bool CanUndo();
 136     virtual bool CanRedo();
 137     virtual void Undo();
 138     virtual void Redo();
 139
 140     //Editing functions
 141     virtual void SetEditable(bool enable = true);
 142     virtual bool IsEditable();
 143
 144     //Selection
 145     virtual void DeleteSelection();
 146     virtual bool HasSelection();
 147     virtual void SelectAll();
 148     virtual wxString GetSelectedText();
 149     virtual wxString GetSelectedSource();
 150     virtual void ClearSelection();
 151
 152     virtual void RunScript(const wxString& javascript);
 153
 154     //Virtual Filesystem Support
 155     virtual void RegisterProtocol(wxWebProtocolHandler* hanlder);
 156
 157     /** FIXME: hack to work around signals being received too early */
 158     bool m_ready;
 159
 160
 161     /** TODO: check if this can be made private
 162      * The native control has a getter to check for busy state, but except in
 163      * very recent versions of webkit this getter doesn't say everything we need
 164      * (namely it seems to stay indefinitely busy when loading is cancelled by
 165      * user)
 166      */
 167     bool m_busy;
 168
 169 protected:
 170
 171     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 172
 173 private:
 174
 175     // focus event handler: calls GTKUpdateBitmap()
 176     void GTKOnFocus(wxFocusEvent& event);
 177
 178     GtkWidget *web_view;
 179     gint m_historyLimit;
 180     HistoryItemHash m_historyMap;
 181
 182     // FIXME: try to get DECLARE_DYNAMIC_CLASS macros & stuff right
 183     //DECLARE_DYNAMIC_CLASS(wxWebViewWebKit)
 184 };
 185
 186 #endif // if wxHAVE_WEB_BACKEND_GTK_WEBKIT
 187
 188 #endif