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/setup.h"
  14
  15 #if wxUSE_WEB
  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 class wxFSFile;
  24 class wxFileSystem;
  25
  26 class WXDLLIMPEXP_WEB wxWebHistoryItem
  27 {
  28 public:
  29     wxWebHistoryItem(const wxString& url, const wxString& title) :
  30                      m_url(url), m_title(title) {}
  31     wxString GetUrl() { return m_url; }
  32     wxString GetTitle() { return m_title; }
  33
  34 private:
  35     wxString m_url, m_title;
  36 };
  37
  38 /**
  39  * Zoom level in web view component
  40  */
  41 enum wxWebViewZoom
  42 {
  43     wxWEB_VIEW_ZOOM_TINY,
  44     wxWEB_VIEW_ZOOM_SMALL,
  45     wxWEB_VIEW_ZOOM_MEDIUM,
  46     wxWEB_VIEW_ZOOM_LARGE,
  47     wxWEB_VIEW_ZOOM_LARGEST
  48 };
  49
  50 /**
  51  * The type of zooming that the web view control can perform
  52  */
  53 enum wxWebViewZoomType
  54 {
  55     /** The entire layout scales when zooming, including images */
  56     wxWEB_VIEW_ZOOM_TYPE_LAYOUT,
  57     /** Only the text changes in size when zooming, images and other layout
  58       * elements retain their initial size */
  59     wxWEB_VIEW_ZOOM_TYPE_TEXT
  60 };
  61
  62 /** Types of errors that can cause navigation to fail */
  63 enum wxWebNavigationError
  64 {
  65     /** Connection error (timeout, etc.) */
  66     wxWEB_NAV_ERR_CONNECTION,
  67     /** Invalid certificate */
  68     wxWEB_NAV_ERR_CERTIFICATE,
  69     /** Authentication required */
  70     wxWEB_NAV_ERR_AUTH,
  71     /** Other security error */
  72     wxWEB_NAV_ERR_SECURITY,
  73     /** Requested resource not found */
  74     wxWEB_NAV_ERR_NOT_FOUND,
  75     /** Invalid request/parameters (e.g. bad URL, bad protocol,
  76       * unsupported resource type) */
  77     wxWEB_NAV_ERR_REQUEST,
  78     /** The user cancelled (e.g. in a dialog) */
  79     wxWEB_NAV_ERR_USER_CANCELLED,
  80     /** Another (exotic) type of error that didn't fit in other categories*/
  81     wxWEB_NAV_ERR_OTHER
  82 };
  83
  84 /** Type of refresh */
  85 enum wxWebViewReloadFlags
  86 {
  87     /** Default reload, will access cache */
  88     wxWEB_VIEW_RELOAD_DEFAULT,
  89     /** Reload the current view without accessing the cache */
  90     wxWEB_VIEW_RELOAD_NO_CACHE
  91 };
  92
  93
  94 /**
  95  * List of available backends for wxWebView
  96  */
  97 enum wxWebViewBackend
  98 {
  99     /** Value that may be passed to wxWebView to let it pick an appropriate
 100      * engine for the current platform*/
 101     wxWEB_VIEW_BACKEND_DEFAULT,
 102
 103     /** The WebKit web engine */
 104     wxWEB_VIEW_BACKEND_WEBKIT,
 105
 106     /** Use Microsoft Internet Explorer as web engine */
 107     wxWEB_VIEW_BACKEND_IE
 108 };
 109
 110 //Base class for custom protocol handlers
 111 class WXDLLIMPEXP_WEB wxWebProtocolHandler
 112 {
 113 public:
 114     virtual wxString GetProtocol() = 0;
 115     virtual wxFSFile* GetFile(const wxString &uri) = 0;
 116     virtual wxString CombineURIs(const wxString &baseuri, const wxString &newuri) = 0;
 117 };
 118
 119 //Loads from uris such as file:///C:/example/example.html or archives such as
 120 //file:///C:/example/example.zip?protocol=zip;path=example.html
 121 class WXDLLIMPEXP_WEB wxWebFileProtocolHandler : public wxWebProtocolHandler
 122 {
 123 public:
 124     wxWebFileProtocolHandler();
 125     virtual wxString GetProtocol() { return m_protocol; }
 126     virtual wxFSFile* GetFile(const wxString &uri);
 127     virtual wxString CombineURIs(const wxString &baseuri, const wxString &newuri);
 128 private:
 129     wxString m_protocol;
 130     wxFileSystem* m_fileSystem;
 131 };
 132
 133 extern WXDLLIMPEXP_DATA_WEB(const char) wxWebViewNameStr[];
 134 extern WXDLLIMPEXP_DATA_WEB(const char) wxWebViewDefaultURLStr[];
 135
 136 class WXDLLIMPEXP_WEB wxWebView : public wxControl
 137 {
 138 public:
 139
 140     /**
 141      *  Creation function for two-step creation.
 142      */
 143     virtual bool Create(wxWindow* parent,
 144            wxWindowID id,
 145            const wxString& url,
 146            const wxPoint& pos,
 147            const wxSize& size,
 148            long style,
 149            const wxString& name) = 0;
 150
 151     /**
 152      * Factory function to create a new wxWebView for two-step creation
 153      * (you need to call wxWebView::Create on the returned object)
 154      * @param backend which web engine to use as backend for wxWebView
 155      * @return the created wxWebView, or NULL if the requested backend is
 156      *         not available
 157      */
 158     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 159
 160     // TODO: clarify what styles can do, or remove this flag
 161     /**
 162      * Factory function to create a new wxWebView
 163      * @param parent parent window to create this view in
 164      * @param id ID of this control
 165      * @param url URL to load by default in the web view
 166      * @param pos position to create this control at
 167      *            (you may use wxDefaultPosition if you use sizers)
 168      * @param size size to create this control with
 169      *             (you may use wxDefaultSize if you use sizers)
 170      * @param backend which web engine to use as backend for wxWebView
 171      * @return the created wxWebView, or NULL if the requested backend
 172      *         is not available
 173      */
 174     static wxWebView* New(wxWindow* parent,
 175            wxWindowID id,
 176            const wxString& url = wxWebViewDefaultURLStr,
 177            const wxPoint& pos = wxDefaultPosition,
 178            const wxSize& size = wxDefaultSize,
 179            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 180            long style = 0,
 181            const wxString& name = wxWebViewNameStr);
 182
 183
 184     /** Get whether it is possible to navigate back in the history of
 185       * visited pages
 186       */
 187     virtual bool CanGoBack() = 0;
 188
 189     /** Get whether it is possible to navigate forward in the history of
 190       * visited pages
 191       */
 192     virtual bool CanGoForward() = 0;
 193
 194     /** Navigate back in the history of visited pages.
 195       * Only valid if CanGoBack() returned true.
 196       */
 197     virtual void GoBack() = 0;
 198
 199     /** Navigate forwardin the history of visited pages.
 200       * Only valid if CanGoForward() returned true.
 201       */
 202     virtual void GoForward() = 0;
 203
 204     /**
 205      * Load a HTMl document (web page) from a URL
 206      * @param url the URL where the HTML document to display can be found
 207      * @note web engines generally report errors asynchronously, so if you wish
 208      *       to know whether loading the URL was successful, register to receive
 209      *       navigation error events
 210      */
 211     virtual void LoadUrl(const wxString& url) = 0;
 212
 213     virtual void ClearHistory() = 0;
 214     virtual void EnableHistory(bool enable = true) = 0;
 215     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory() = 0;
 216     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory() = 0;
 217     virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item) = 0;
 218
 219     /**
 220      * Stop the current page loading process, if any.
 221      * May trigger an error event of type wxWEB_NAV_ERR_USER_CANCELLED.
 222      * TODO: make wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
 223      */
 224     virtual void Stop() = 0;
 225
 226     /**
 227      * Reload the currently displayed URL.
 228      * @param flags A bit array that may optionnally contain reload options
 229      */
 230     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 231
 232
 233     /**
 234      * Get the URL of the currently displayed document
 235      */
 236     virtual wxString GetCurrentURL() = 0;
 237
 238     /**
 239      * Get the title of the current web page, or its URL/path if title is not
 240      * available
 241      */
 242     virtual wxString GetCurrentTitle() = 0;
 243
 244     // TODO: handle choosing a frame when calling GetPageSource()?
 245     /**
 246      * Get the HTML source code of the currently displayed document
 247      * @return the HTML source code, or an empty string if no page is currently
 248      *         shown
 249      */
 250     virtual wxString GetPageSource() = 0;
 251     virtual wxString GetPageText() = 0;
 252
 253    /**
 254      * Get the zoom factor of the page
 255      * @return How much the HTML document is zoomed (scaleed)
 256      */
 257     virtual wxWebViewZoom GetZoom() = 0;
 258
 259     /**
 260      * Set the zoom factor of the page
 261      * @param zoom How much to zoom (scale) the HTML document
 262      */
 263     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 264
 265     /**
 266      * Set how to interpret the zoom factor
 267      * @param zoomType how the zoom factor should be interpreted by the
 268      *                 HTML engine
 269      * @note invoke    canSetZoomType() first, some HTML renderers may not
 270      *                 support all zoom types
 271      */
 272     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 273
 274     /**
 275      * Get how the zoom factor is currently interpreted
 276      * @return how the zoom factor is currently interpreted by the HTML engine
 277      */
 278     virtual wxWebViewZoomType GetZoomType() const = 0;
 279
 280     /**
 281      * Retrieve whether the current HTML engine supports a type of zoom
 282      * @param type the type of zoom to test
 283      * @return whether this type of zoom is supported by this HTML engine
 284      *         (and thus can be set through setZoomType())
 285      */
 286     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 287
 288     // TODO: allow 'SetPage' to find files (e.g. images) from a virtual file
 289     // system if possible
 290     /**
 291      * Set the displayed page source to the contents of the given string
 292      * @param html    the string that contains the HTML data to display
 293      * @param baseUrl URL assigned to the HTML data, to be used to resolve
 294      *                relative paths, for instance
 295      */
 296     virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
 297
 298     /**
 299      * Set the displayed page source to the contents of the given stream
 300      * @param html    the stream to read HTML data from
 301      * @param baseUrl URL assigned to the HTML data, to be used to resolve
 302      *                relative paths, for instance
 303      */
 304     virtual void SetPage(wxInputStream& html, wxString baseUrl)
 305     {
 306         wxStringOutputStream stream;
 307         stream.Write(html);
 308         SetPage(stream.GetString(), baseUrl);
 309     }
 310
 311     virtual void SetEditable(bool enable = true) = 0;
 312     virtual bool IsEditable() = 0;
 313
 314     virtual void SelectAll() = 0;
 315     virtual bool HasSelection() = 0;
 316     virtual void DeleteSelection() = 0;
 317     virtual wxString GetSelectedText() = 0;
 318     virtual wxString GetSelectedSource() = 0;
 319     virtual void ClearSelection() = 0;
 320
 321     virtual void RunScript(const wxString& javascript) = 0;
 322
 323     // TODO:
 324     //     void EnableJavascript(bool enabled);             // maybe?
 325     //       // maybe?
 326
 327     //     void SetScrollPos(int pos);                      // maybe?
 328     //     int GetScrollPos();                              // maybe?
 329
 330     //     wxString GetStatusText();                        // maybe?
 331     //     void SetStatusText(wxString text);               // maybe?
 332     //     * status text changed event?
 333     //     * title changed event?
 334
 335     //    virtual bool IsOfflineMode() = 0;                 // maybe?
 336     //     virtual void SetOfflineMode(bool offline) = 0;   // maybe?
 337
 338     /**
 339      * Opens a print dialog so that the user may print the currently
 340      * displayed page.
 341      */
 342     virtual void Print() = 0;
 343
 344     /**
 345      * Returns whether the web control is currently busy (e.g. loading a page)
 346      */
 347     virtual bool IsBusy() = 0;
 348
 349     //Clipboard functions
 350     virtual bool CanCut() = 0;
 351     virtual bool CanCopy() = 0;
 352     virtual bool CanPaste() = 0;
 353     virtual void Cut() = 0;
 354     virtual void Copy() = 0;
 355     virtual void Paste() = 0;
 356
 357     //Undo / redo functionality
 358     virtual bool CanUndo() = 0;
 359     virtual bool CanRedo() = 0;
 360     virtual void Undo() = 0;
 361     virtual void Redo() = 0;
 362
 363     //Virtual Filesystem Support
 364     virtual void RegisterProtocol(wxWebProtocolHandler* handler) = 0;
 365 };
 366
 367 class WXDLLIMPEXP_WEB wxWebNavigationEvent : public wxCommandEvent
 368 {
 369 public:
 370     wxWebNavigationEvent() {}
 371     wxWebNavigationEvent(wxEventType type, int id, const wxString url,
 372                          const wxString target, bool canVeto)
 373         : wxCommandEvent(type, id)
 374     {
 375         m_url = url;
 376         m_target = target;
 377         m_vetoed = false;
 378         m_canVeto = canVeto;
 379     }
 380
 381     /**
 382      *  Get the URL being visited
 383      */
 384     const wxString& GetURL() const { return m_url; }
 385
 386     /**
 387      * Get the target (frame or window) in which the URL that caused this event
 388      * is viewed, or an empty string if not available.
 389      */
 390     const wxString& GetTarget() const { return m_target; }
 391
 392     // default copy ctor, assignment operator and dtor are ok
 393     virtual wxEvent* Clone() const { return new wxWebNavigationEvent(*this); }
 394
 395     /** Get whether this event may be vetoed (stopped/prevented). Only
 396       *  meaningful for events fired before navigation takes place.
 397       */
 398     bool CanVeto() const { return m_canVeto; }
 399
 400     /** Whether this event was vetoed (stopped/prevented). Only meaningful for
 401      *  events fired before navigation takes place.
 402      */
 403     bool IsVetoed() const { return m_vetoed; }
 404
 405     /** Veto (prevent/stop) this event. Only meaningful for events fired
 406      *  before navigation takes place. Only valid if CanVeto() returned true.
 407      */
 408     void Veto() { wxASSERT(m_canVeto); m_vetoed = true; }
 409
 410 private:
 411     wxString m_url;
 412     wxString m_target;
 413     bool m_canVeto;
 414     bool m_vetoed;
 415
 416     wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWebNavigationEvent);
 417 };
 418
 419 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_NAVIGATING, wxWebNavigationEvent );
 420 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_NAVIGATED, wxWebNavigationEvent );
 421 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_LOADED, wxWebNavigationEvent );
 422 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_ERROR, wxWebNavigationEvent );
 423 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_NEWWINDOW, wxWebNavigationEvent );
 424 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED, wxWebNavigationEvent );
 425
 426 typedef void (wxEvtHandler::*wxWebNavigationEventFunction)
 427              (wxWebNavigationEvent&);
 428
 429 #define wxWebNavigationEventHandler(func) \
 430     wxEVENT_HANDLER_CAST(wxWebNavigationEventFunction, func)
 431
 432 #define EVT_WEB_VIEW_NAVIGATING(id, fn) \
 433     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NAVIGATING, id, \
 434                      wxHtmlNavigatingEventHandler(fn))
 435
 436 #define EVT_WEB_VIEW_NAVIGATED(id, fn) \
 437     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NAVIGATED, id, \
 438                      wxHtmlNavigatingEventHandler(fn))
 439
 440 #define EVT_WEB_VIEW_LOADED(id, fn) \
 441     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_LOADED, id, \
 442                      wxHtmlNavigatingEventHandler(fn))
 443
 444 #define EVT_WEB_VIEW_ERRROR(id, fn) \
 445     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_ERROR, id, \
 446                      wxHtmlNavigatingEventHandler(fn))
 447
 448 #define EVT_WEB_VIEW_NEWWINDOW(id, fn) \
 449     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NEWWINDOW, id, \
 450                      wxHtmlNavigatingEventHandler(fn))
 451
 452 #define EVT_WEB_VIEW_TITLE_CHANGED(id, fn) \
 453     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED, id, \
 454                      wxHtmlNavigatingEventHandler(fn))
 455
 456 #endif // wxUSE_WEB
 457
 458 #endif // _WX_WEB_VIEW_H_