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_WEBVIEW_H_
  11 #define _WX_WEBVIEW_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 class wxWebView;
  36
  37 enum wxWebViewZoom
  38 {
  39     wxWEBVIEW_ZOOM_TINY,
  40     wxWEBVIEW_ZOOM_SMALL,
  41     wxWEBVIEW_ZOOM_MEDIUM,
  42     wxWEBVIEW_ZOOM_LARGE,
  43     wxWEBVIEW_ZOOM_LARGEST
  44 };
  45
  46 enum wxWebViewZoomType
  47 {
  48     //Scales entire page, including images
  49     wxWEBVIEW_ZOOM_TYPE_LAYOUT,
  50     wxWEBVIEW_ZOOM_TYPE_TEXT
  51 };
  52
  53 enum wxWebViewNavigationError
  54 {
  55     wxWEBVIEW_NAV_ERR_CONNECTION,
  56     wxWEBVIEW_NAV_ERR_CERTIFICATE,
  57     wxWEBVIEW_NAV_ERR_AUTH,
  58     wxWEBVIEW_NAV_ERR_SECURITY,
  59     wxWEBVIEW_NAV_ERR_NOT_FOUND,
  60     wxWEBVIEW_NAV_ERR_REQUEST,
  61     wxWEBVIEW_NAV_ERR_USER_CANCELLED,
  62     wxWEBVIEW_NAV_ERR_OTHER
  63 };
  64
  65 enum wxWebViewReloadFlags
  66 {
  67     //Default, may access cache
  68     wxWEBVIEW_RELOAD_DEFAULT,
  69     wxWEBVIEW_RELOAD_NO_CACHE
  70 };
  71
  72 enum wxWebViewFindFlags
  73 {
  74     wxWEBVIEW_FIND_WRAP =             0x0001,
  75     wxWEBVIEW_FIND_ENTIRE_WORD =      0x0002,
  76     wxWEBVIEW_FIND_MATCH_CASE =       0x0004,
  77     wxWEBVIEW_FIND_HIGHLIGHT_RESULT = 0x0008,
  78     wxWEBVIEW_FIND_BACKWARDS =        0x0010,
  79     wxWEBVIEW_FIND_DEFAULT =          0
  80 };
  81
  82 //Base class for custom scheme handlers
  83 class WXDLLIMPEXP_WEBVIEW wxWebViewHandler
  84 {
  85 public:
  86     wxWebViewHandler(const wxString& scheme) : m_scheme(scheme) {}
  87     virtual ~wxWebViewHandler() {}
  88     virtual wxString GetName() const { return m_scheme; }
  89     virtual wxFSFile* GetFile(const wxString &uri) = 0;
  90 private:
  91     wxString m_scheme;
  92 };
  93
  94 extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewNameStr[];
  95 extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewDefaultURLStr[];
  96 extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewBackendDefault[];
  97 extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewBackendIE[];
  98 extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewBackendWebKit[];
  99
 100 class WXDLLIMPEXP_WEBVIEW wxWebViewFactory : public wxObject
 101 {
 102 public:
 103     virtual wxWebView* Create() = 0;
 104     virtual wxWebView* Create(wxWindow* parent,
 105                               wxWindowID id,
 106                               const wxString& url = wxWebViewDefaultURLStr,
 107                               const wxPoint& pos = wxDefaultPosition,
 108                               const wxSize& size = wxDefaultSize,
 109                               long style = 0,
 110                               const wxString& name = wxWebViewNameStr) = 0;
 111 };
 112
 113 WX_DECLARE_STRING_HASH_MAP(wxSharedPtr<wxWebViewFactory>, wxStringWebViewFactoryMap);
 114
 115 class WXDLLIMPEXP_WEBVIEW wxWebView : public wxControl
 116 {
 117 public:
 118     wxWebView()
 119     {
 120         m_showMenu = true;
 121     }
 122
 123     virtual ~wxWebView() {}
 124
 125     virtual bool Create(wxWindow* parent,
 126            wxWindowID id,
 127            const wxString& url = wxWebViewDefaultURLStr,
 128            const wxPoint& pos = wxDefaultPosition,
 129            const wxSize& size = wxDefaultSize,
 130            long style = 0,
 131            const wxString& name = wxWebViewNameStr) = 0;
 132
 133     // Factory methods allowing the use of custom factories registered with
 134     // RegisterFactory
 135     static wxWebView* New(const wxString& backend = wxWebViewBackendDefault);
 136     static wxWebView* New(wxWindow* parent,
 137                           wxWindowID id,
 138                           const wxString& url = wxWebViewDefaultURLStr,
 139                           const wxPoint& pos = wxDefaultPosition,
 140                           const wxSize& size = wxDefaultSize,
 141                           const wxString& backend = wxWebViewBackendDefault,
 142                           long style = 0,
 143                           const wxString& name = wxWebViewNameStr);
 144
 145     static void RegisterFactory(const wxString& backend,
 146                                 wxSharedPtr<wxWebViewFactory> factory);
 147
 148     // General methods
 149     virtual void EnableContextMenu(bool enable = true)
 150     {
 151         m_showMenu = enable;
 152     }
 153     virtual wxString GetCurrentTitle() const = 0;
 154     virtual wxString GetCurrentURL() const = 0;
 155     // TODO: handle choosing a frame when calling GetPageSource()?
 156     virtual wxString GetPageSource() const = 0;
 157     virtual wxString GetPageText() const = 0;
 158     virtual bool IsBusy() const = 0;
 159     virtual bool IsContextMenuEnabled() const { return m_showMenu; }
 160     virtual bool IsEditable() const = 0;
 161     virtual void LoadURL(const wxString& url) = 0;
 162     virtual void Print() = 0;
 163     virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
 164     virtual void Reload(wxWebViewReloadFlags flags = wxWEBVIEW_RELOAD_DEFAULT) = 0;
 165     virtual void RunScript(const wxString& javascript) = 0;
 166     virtual void SetEditable(bool enable = true) = 0;
 167     void SetPage(const wxString& html, const wxString& baseUrl)
 168     {
 169         DoSetPage(html, baseUrl);
 170     }
 171     void SetPage(wxInputStream& html, wxString baseUrl)
 172     {
 173         wxStringOutputStream stream;
 174         stream.Write(html);
 175         DoSetPage(stream.GetString(), baseUrl);
 176     }
 177     virtual void Stop() = 0;
 178
 179     //History
 180     virtual bool CanGoBack() const = 0;
 181     virtual bool CanGoForward() const = 0;
 182     virtual void GoBack() = 0;
 183     virtual void GoForward() = 0;
 184     virtual void ClearHistory() = 0;
 185     virtual void EnableHistory(bool enable = true) = 0;
 186     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;
 187     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;
 188     virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
 189
 190     //Zoom
 191     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 192     virtual wxWebViewZoom GetZoom() const = 0;
 193     virtual wxWebViewZoomType GetZoomType() const = 0;
 194     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 195     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 196
 197     //Selection
 198     virtual void SelectAll() = 0;
 199     virtual bool HasSelection() const = 0;
 200     virtual void DeleteSelection() = 0;
 201     virtual wxString GetSelectedText() const = 0;
 202     virtual wxString GetSelectedSource() const = 0;
 203     virtual void ClearSelection() = 0;
 204
 205     //Clipboard functions
 206     virtual bool CanCut() const = 0;
 207     virtual bool CanCopy() const = 0;
 208     virtual bool CanPaste() const = 0;
 209     virtual void Cut() = 0;
 210     virtual void Copy() = 0;
 211     virtual void Paste() = 0;
 212
 213     //Undo / redo functionality
 214     virtual bool CanUndo() const = 0;
 215     virtual bool CanRedo() const = 0;
 216     virtual void Undo() = 0;
 217     virtual void Redo() = 0;
 218
 219     //Get the pointer to the underlying native engine.
 220     virtual void* GetNativeBackend() const = 0;
 221     //Find function
 222     virtual long Find(const wxString& text, int flags = wxWEBVIEW_FIND_DEFAULT) = 0;
 223
 224 protected:
 225     virtual void DoSetPage(const wxString& html, const wxString& baseUrl) = 0;
 226
 227 private:
 228     static void InitFactoryMap();
 229     static wxStringWebViewFactoryMap::iterator FindFactory(const wxString &backend);
 230
 231     bool m_showMenu;
 232     static wxStringWebViewFactoryMap m_factoryMap;
 233
 234     wxDECLARE_ABSTRACT_CLASS(wxWebView);
 235 };
 236
 237 class WXDLLIMPEXP_WEBVIEW wxWebViewEvent : public wxNotifyEvent
 238 {
 239 public:
 240     wxWebViewEvent() {}
 241     wxWebViewEvent(wxEventType type, int id, const wxString url,
 242                    const wxString target)
 243         : wxNotifyEvent(type, id), m_url(url), m_target(target)
 244     {}
 245
 246
 247     const wxString& GetURL() const { return m_url; }
 248     const wxString& GetTarget() const { return m_target; }
 249
 250     virtual wxEvent* Clone() const { return new wxWebViewEvent(*this); }
 251 private:
 252     wxString m_url;
 253     wxString m_target;
 254
 255     wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWebViewEvent);
 256 };
 257
 258 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEBVIEW_NAVIGATING, wxWebViewEvent );
 259 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEBVIEW_NAVIGATED, wxWebViewEvent );
 260 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEBVIEW_LOADED, wxWebViewEvent );
 261 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEBVIEW_ERROR, wxWebViewEvent );
 262 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEBVIEW_NEWWINDOW, wxWebViewEvent );
 263 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_COMMAND_WEBVIEW_TITLE_CHANGED, wxWebViewEvent );
 264
 265 typedef void (wxEvtHandler::*wxWebViewEventFunction)
 266              (wxWebViewEvent&);
 267
 268 #define wxWebViewEventHandler(func) \
 269     wxEVENT_HANDLER_CAST(wxWebViewEventFunction, func)
 270
 271 #define EVT_WEBVIEW_NAVIGATING(id, fn) \
 272     wx__DECLARE_EVT1(wxEVT_COMMAND_WEBVIEW_NAVIGATING, id, \
 273                      wxWebViewEventHandler(fn))
 274
 275 #define EVT_WEBVIEW_NAVIGATED(id, fn) \
 276     wx__DECLARE_EVT1(wxEVT_COMMAND_WEBVIEW_NAVIGATED, id, \
 277                      wxWebViewEventHandler(fn))
 278
 279 #define EVT_WEBVIEW_LOADED(id, fn) \
 280     wx__DECLARE_EVT1(wxEVT_COMMAND_WEBVIEW_LOADED, id, \
 281                      wxWebViewEventHandler(fn))
 282
 283 #define EVT_WEBVIEW_ERROR(id, fn) \
 284     wx__DECLARE_EVT1(wxEVT_COMMAND_WEBVIEW_ERROR, id, \
 285                      wxWebViewEventHandler(fn))
 286
 287 #define EVT_WEBVIEW_NEWWINDOW(id, fn) \
 288     wx__DECLARE_EVT1(wxEVT_COMMAND_WEBVIEW_NEWWINDOW, id, \
 289                      wxWebViewEventHandler(fn))
 290
 291 #define EVT_WEBVIEW_TITLE_CHANGED(id, fn) \
 292     wx__DECLARE_EVT1(wxEVT_COMMAND_WEBVIEW_TITLE_CHANGED, id, \
 293                      wxWebViewEventHandler(fn))
 294
 295 #endif // wxUSE_WEBVIEW
 296
 297 #endif // _WX_WEBVIEW_H_