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