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