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