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 //-----------------------------------------------------------------------------
  22 // wxWebViewWebKit
  23 //-----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_WEB wxWebViewWebKit : public wxWebView
  26 {
  27 public:
  28     wxWebViewWebKit() { Init(); }
  29
  30     wxWebViewWebKit(wxWindow *parent,
  31            wxWindowID id = wxID_ANY,
  32            const wxString& url = wxWebViewDefaultURLStr,
  33            const wxPoint& pos = wxDefaultPosition,
  34            const wxSize& size = wxDefaultSize, long style = 0,
  35            const wxString& name = wxWebViewNameStr)
  36     {
  37         Init();
  38
  39         Create(parent, id, url, pos, size, style, name);
  40     }
  41
  42     virtual bool Create(wxWindow *parent,
  43            wxWindowID id = wxID_ANY,
  44            const wxString& url = wxWebViewDefaultURLStr,
  45            const wxPoint& pos = wxDefaultPosition,
  46            const wxSize& size = wxDefaultSize, long style = 0,
  47            const wxString& name = wxWebViewNameStr);
  48
  49     virtual bool Enable( bool enable = true );
  50
  51     // implementation
  52     // --------------
  53
  54     static wxVisualAttributes
  55     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  56
  57     virtual void Stop();
  58     virtual void LoadURL(const wxString& url);
  59     virtual void GoBack();
  60     virtual void GoForward();
  61     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT);
  62     virtual bool CanGoBack() const;
  63     virtual bool CanGoForward() const;
  64     virtual void ClearHistory();
  65     virtual void EnableHistory(bool enable = true);
  66     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory();
  67     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory();
  68     virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item);
  69     virtual wxString GetCurrentURL() const;
  70     virtual wxString GetCurrentTitle() const;
  71     virtual wxString GetPageSource() const;
  72     virtual wxString GetPageText() const;
  73     //We do not want to hide the other overloads
  74     using wxWebView::SetPage;
  75     virtual void SetPage(const wxString& html, const wxString& baseUrl);
  76     virtual void Print();
  77     virtual bool IsBusy() const;
  78
  79     void SetZoomType(wxWebViewZoomType);
  80     wxWebViewZoomType GetZoomType() const;
  81     bool CanSetZoomType(wxWebViewZoomType) const;
  82     virtual wxWebViewZoom GetZoom() const;
  83     virtual void SetZoom(wxWebViewZoom);
  84
  85     //Clipboard functions
  86     virtual bool CanCut() const;
  87     virtual bool CanCopy() const;
  88     virtual bool CanPaste() const;
  89     virtual void Cut();
  90     virtual void Copy();
  91     virtual void Paste();
  92
  93     //Undo / redo functionality
  94     virtual bool CanUndo() const;
  95     virtual bool CanRedo() const;
  96     virtual void Undo();
  97     virtual void Redo();
  98
  99     //Editing functions
 100     virtual void SetEditable(bool enable = true);
 101     virtual bool IsEditable() const;
 102
 103     //Selection
 104     virtual void DeleteSelection();
 105     virtual bool HasSelection() const;
 106     virtual void SelectAll();
 107     virtual wxString GetSelectedText() const;
 108     virtual wxString GetSelectedSource() const;
 109     virtual void ClearSelection();
 110
 111     virtual void RunScript(const wxString& javascript);
 112
 113     //Virtual Filesystem Support
 114     virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler);
 115     virtual wxVector<wxSharedPtr<wxWebViewHandler> > GetHandlers() { return m_handlerList; }
 116
 117     /** FIXME: hack to work around signals being received too early */
 118     bool m_ready;
 119
 120
 121     /** TODO: check if this can be made private
 122      * The native control has a getter to check for busy state, but except in
 123      * very recent versions of webkit this getter doesn't say everything we need
 124      * (namely it seems to stay indefinitely busy when loading is cancelled by
 125      * user)
 126      */
 127     bool m_busy;
 128
 129     wxString m_vfsurl;
 130
 131     //We use this flag to stop recursion when we load a page from the navigation
 132     //callback, mainly when loading a VFS page
 133     bool m_guard;
 134
 135 protected:
 136
 137     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 138
 139 private:
 140
 141     void ZoomIn();
 142     void ZoomOut();
 143     void SetWebkitZoom(float level);
 144     float GetWebkitZoom() const;
 145
 146     // focus event handler: calls GTKUpdateBitmap()
 147     void GTKOnFocus(wxFocusEvent& event);
 148
 149     GtkWidget *web_view;
 150     gint m_historyLimit;
 151
 152     wxVector<wxSharedPtr<wxWebViewHandler> > m_handlerList;
 153
 154     wxDECLARE_DYNAMIC_CLASS(wxWebViewWebKit);
 155 };
 156
 157 #endif // wxUSE_WEBVIEW_WEBKIT && defined(__WXGTK__)
 158
 159 #endif