include/wx/webview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        webview.h
   3 // Purpose:     Common interface and events for web view component
   4 // Author:      Marianne Gagnon
   5 // Id:          $Id$
   6 // Copyright:   (c) 2010 Marianne Gagnon, 2011 Steven Lamerton
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_WEB_VIEW_H_
  11 #define _WX_WEB_VIEW_H_
  12
  13 #include "wx/defs.h"
  14
  15 #if wxUSE_WEBVIEW
  16
  17 #include "wx/control.h"
  18 #include "wx/event.h"
  19 #include "wx/sstream.h"
  20 #include "wx/sharedptr.h"
  21 #include "wx/vector.h"
  22
  23 #if defined(__WXOSX__)
  24     #include "wx/osx/webviewhistoryitem_webkit.h"
  25 #elif defined(__WXGTK__)
  26     #include "wx/gtk/webviewhistoryitem_webkit.h"
  27 #elif defined(__WXMSW__)
  28     #include "wx/msw/webviewhistoryitem_ie.h"
  29 #else
  30     #error "wxWebView not implemented on this platform."
  31 #endif
  32
  33 class wxFSFile;
  34 class wxFileSystem;
  35
  36 enum wxWebViewZoom
  37 {
  38     wxWEB_VIEW_ZOOM_TINY,
  39     wxWEB_VIEW_ZOOM_SMALL,
  40     wxWEB_VIEW_ZOOM_MEDIUM,
  41     wxWEB_VIEW_ZOOM_LARGE,
  42     wxWEB_VIEW_ZOOM_LARGEST
  43 };
  44
  45 enum wxWebViewZoomType
  46 {
  47     //Scales entire page, including images
  48     wxWEB_VIEW_ZOOM_TYPE_LAYOUT,
  49     wxWEB_VIEW_ZOOM_TYPE_TEXT
  50 };
  51
  52 enum wxWebViewNavigationError
  53 {
  54     wxWEB_NAV_ERR_CONNECTION,
  55     wxWEB_NAV_ERR_CERTIFICATE,
  56     wxWEB_NAV_ERR_AUTH,
  57     wxWEB_NAV_ERR_SECURITY,
  58     wxWEB_NAV_ERR_NOT_FOUND,
  59     wxWEB_NAV_ERR_REQUEST,
  60     wxWEB_NAV_ERR_USER_CANCELLED,
  61     wxWEB_NAV_ERR_OTHER
  62 };
  63
  64 enum wxWebViewReloadFlags
  65 {
  66     //Default, may access cache
  67     wxWEB_VIEW_RELOAD_DEFAULT,
  68     wxWEB_VIEW_RELOAD_NO_CACHE
  69 };
  70
  71 enum wxWebViewBackend
  72 {
  73     wxWEB_VIEW_BACKEND_DEFAULT,
  74     wxWEB_VIEW_BACKEND_WEBKIT,
  75     wxWEB_VIEW_BACKEND_IE
  76 };
  77
  78 //Base class for custom scheme handlers
  79 class WXDLLIMPEXP_WEBVIEW wxWebViewHandler
  80 {
  81 public:
  82     wxWebViewHandler(const wxString& scheme) : m_scheme(scheme) {}
  83     virtual ~wxWebViewHandler() {}
  84     virtual wxString GetName() const { return m_scheme; }
  85     virtual wxFSFile* GetFile(const wxString &uri) = 0;
  86 private:
  87     wxString m_scheme;
  88 };
  89
  90 extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewNameStr[];
  91 extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewDefaultURLStr[];
  92
  93 class WXDLLIMPEXP_WEBVIEW wxWebView : public wxControl
  94 {
  95 public:
  96     virtual ~wxWebView() {}
  97
  98     virtual bool Create(wxWindow* parent,
  99            wxWindowID id,
 100            const wxString& url = wxWebViewDefaultURLStr,
 101            const wxPoint& pos = wxDefaultPosition,
 102            const wxSize& size = wxDefaultSize,
 103            long style = 0,
 104            const wxString& name = wxWebViewNameStr) = 0;
 105
 106     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 107     static wxWebView* New(wxWindow* parent,
 108            wxWindowID id,
 109            const wxString& url = wxWebViewDefaultURLStr,
 110            const wxPoint& pos = wxDefaultPosition,
 111            const wxSize& size = wxDefaultSize,
 112            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 113            long style = 0,
 114            const wxString& name = wxWebViewNameStr);
 115
 116     //General methods
 117     virtual wxString GetCurrentTitle() const = 0;
 118     virtual wxString GetCurrentURL() const = 0;
 119     // TODO: handle choosing a frame when calling GetPageSource()?
 120     virtual wxString GetPageSource() const = 0;
 121     virtual wxString GetPageText() const = 0;
 122     virtual bool IsBusy() const = 0;
 123     virtual bool IsEditable() const = 0;
 124     virtual void LoadURL(const wxString& url) = 0;
 125     virtual void Print() = 0;
 126     virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
 127     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 128     virtual void RunScript(const wxString& javascript) = 0;
 129     virtual void SetEditable(bool enable = true) = 0;
 130     void SetPage(const wxString& html, const wxString& baseUrl)
 131     {
 132         DoSetPage(html, baseUrl);
 133     }
 134     void SetPage(wxInputStream& html, wxString baseUrl)
 135     {
 136         wxStringOutputStream stream;
 137         stream.Write(html);
 138         DoSetPage(stream.GetString(), baseUrl);
 139     }
 140     virtual void Stop() = 0;
 141
 142     //History
 143     virtual bool CanGoBack() const = 0;
 144     virtual bool CanGoForward() const = 0;
 145     virtual void GoBack() = 0;
 146     virtual void GoForward() = 0;
 147     virtual void ClearHistory() = 0;
 148     virtual void EnableHistory(bool enable = true) = 0;
 149     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;
 150     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;
 151     virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
 152
 153     //Zoom
 154     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 155     virtual wxWebViewZoom GetZoom() const = 0;
 156     virtual wxWebViewZoomType GetZoomType() const = 0;
 157     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 158     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 159
 160     //Selection
 161     virtual void SelectAll() = 0;
 162     virtual bool HasSelection() const = 0;
 163     virtual void DeleteSelection() = 0;
 164     virtual wxString GetSelectedText() const = 0;
 165     virtual wxString GetSelectedSource() const = 0;
 166     virtual void ClearSelection() = 0;
 167
 168     //Clipboard functions
 169     virtual bool CanCut() const = 0;
 170     virtual bool CanCopy() const = 0;
 171     virtual bool CanPaste() const = 0;
 172     virtual void Cut() = 0;
 173     virtual void Copy() = 0;
 174     virtual void Paste() = 0;
 175
 176     //Undo / redo functionality
 177     virtual bool CanUndo() const = 0;
 178     virtual bool CanRedo() const = 0;
 179     virtual void Undo() = 0;
 180     virtual void Redo() = 0;
 181
 182     //Get the pointer to the underlying native engine.
 183     virtual void* GetNativeBackend() const = 0;
 184
 185 protected:
 186     virtual void DoSetPage(const wxString& html, const wxString& baseUrl) = 0;
 187
 188     wxDECLARE_ABSTRACT_CLASS(wxWebView);
 189 };
 190
 191 class WXDLLIMPEXP_WEBVIEW wxWebViewEvent : public wxNotifyEvent
 192 {
 193 public:
 194     wxWebViewEvent() {}
 195     wxWebViewEvent(wxEventType type, int id, const wxString url,
 196                    const wxString target)
 197         : wxNotifyEvent(type, id), m_url(url), m_target(target)
 198     {}
 199
 200
 201     const wxString& GetURL() const { return m_url; }
 202     const wxString& GetTarget() const { return m_target; }
 203
 204     virtual wxEvent* Clone() const { return new wxWebViewEvent(*this); }
 205 private:
 206     wxString m_url;
 207     wxString m_target;
 208
 209     wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWebViewEvent);
 210 };
 211
 212 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEB_VIEW_NAVIGATING, wxWebViewEvent );
 213 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEB_VIEW_NAVIGATED, wxWebViewEvent );
 214 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEB_VIEW_LOADED, wxWebViewEvent );
 215 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEB_VIEW_ERROR, wxWebViewEvent );
 216 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEB_VIEW_NEWWINDOW, wxWebViewEvent );
 217 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED, wxWebViewEvent );
 218
 219 typedef void (wxEvtHandler::*wxWebViewEventFunction)
 220              (wxWebViewEvent&);
 221
 222 #define wxWebViewEventHandler(func) \
 223     wxEVENT_HANDLER_CAST(wxWebViewEventFunction, func)
 224
 225 #define EVT_WEB_VIEW_NAVIGATING(id, fn) \
 226     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NAVIGATING, id, \
 227                      wxWebViewEventHandler(fn))
 228
 229 #define EVT_WEB_VIEW_NAVIGATED(id, fn) \
 230     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NAVIGATED, id, \
 231                      wxWebViewEventHandler(fn))
 232
 233 #define EVT_WEB_VIEW_LOADED(id, fn) \
 234     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_LOADED, id, \
 235                      wxWebViewEventHandler(fn))
 236
 237 #define EVT_WEB_VIEW_ERROR(id, fn) \
 238     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_ERROR, id, \
 239                      wxWebViewEventHandler(fn))
 240
 241 #define EVT_WEB_VIEW_NEWWINDOW(id, fn) \
 242     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NEWWINDOW, id, \
 243                      wxWebViewEventHandler(fn))
 244
 245 #define EVT_WEB_VIEW_TITLE_CHANGED(id, fn) \
 246     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED, id, \
 247                      wxWebViewEventHandler(fn))
 248
 249 #endif // wxUSE_WEBVIEW
 250
 251 #endif // _WX_WEB_VIEW_H_