interface/wx/webview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        webview.h
   3 // Purpose:     interface of wxWebView
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     Zoom levels availiable in wxWebView
  11 */
  12 enum wxWebViewZoom
  13 {
  14     wxWEB_VIEW_ZOOM_TINY,
  15     wxWEB_VIEW_ZOOM_SMALL,
  16     wxWEB_VIEW_ZOOM_MEDIUM, //!< default size
  17     wxWEB_VIEW_ZOOM_LARGE,
  18     wxWEB_VIEW_ZOOM_LARGEST
  19 };
  20
  21 /**
  22     The type of zooming that the web view control can perform
  23 */
  24 enum wxWebViewZoomType
  25 {
  26     /**
  27         The entire layout scales when zooming, including images
  28     */
  29     wxWEB_VIEW_ZOOM_TYPE_LAYOUT,
  30     /**
  31         Only the text changes in size when zooming, images and other layout
  32         elements retain their initial size
  33     */
  34     wxWEB_VIEW_ZOOM_TYPE_TEXT
  35 };
  36
  37 /**
  38     Types of errors that can cause navigation to fail
  39 */
  40 enum wxWebNavigationError
  41 {
  42     /** Connection error (timeout, etc.) */
  43     wxWEB_NAV_ERR_CONNECTION,
  44     /** Invalid certificate */
  45     wxWEB_NAV_ERR_CERTIFICATE,
  46     /** Authentication required */
  47     wxWEB_NAV_ERR_AUTH,
  48     /** Other security error */
  49     wxWEB_NAV_ERR_SECURITY,
  50     /** Requested resource not found */
  51     wxWEB_NAV_ERR_NOT_FOUND,
  52     /** Invalid request/parameters (e.g. bad URL, bad protocol,
  53         unsupported resource type) */
  54     wxWEB_NAV_ERR_REQUEST,
  55     /** The user cancelled (e.g. in a dialog) */
  56     wxWEB_NAV_ERR_USER_CANCELLED,
  57     /** Another (exotic) type of error that didn't fit in other categories*/
  58     wxWEB_NAV_ERR_OTHER
  59 };
  60
  61 /**
  62     Type of refresh
  63 */
  64 enum wxWebViewReloadFlags
  65 {
  66     /** Default reload, will access cache */
  67     wxWEB_VIEW_RELOAD_DEFAULT,
  68     /** Reload the current view without accessing the cache */
  69     wxWEB_VIEW_RELOAD_NO_CACHE
  70 };
  71
  72
  73 /**
  74  * List of available backends for wxWebView
  75  */
  76 enum wxWebViewBackend
  77 {
  78     /** Value that may be passed to wxWebView to let it pick an appropriate
  79      * engine for the current platform*/
  80     wxWEB_VIEW_BACKEND_DEFAULT,
  81
  82     /** The OSX-native WebKit web engine */
  83     wxWEB_VIEW_BACKEND_OSX_WEBKIT,
  84
  85     /** The GTK port of the WebKit engine */
  86     wxWEB_VIEW_BACKEND_GTK_WEBKIT,
  87
  88     /** Use Microsoft Internet Explorer as web engine */
  89     wxWEB_VIEW_BACKEND_IE
  90 };
  91
  92 /**
  93     @class wxWebHistoryItem
  94
  95     A simple class that contains the URL and title of an element of the history
  96     of a wxWebView.
  97
  98     @library{wxweb}
  99     @category{web}
 100
 101     @see wxWebView
 102  */
 103 class wxWebHistoryItem
 104 {
 105 public:
 106     /**
 107         Construtor.
 108     */
 109     wxWebHistoryItem(const wxString& url, const wxString& title);
 110
 111     /**
 112         @return The url of the page.
 113     */
 114     wxString GetUrl();
 115
 116     /**
 117         @return The title of the page.
 118     */
 119     wxString GetTitle();
 120 };
 121
 122 /**
 123     @class wxWebView
 124
 125     This control may be used to render web (HTML / CSS / javascript) documents.
 126     Capabilities of the HTML renderer will depend upon the backed.
 127
 128     @c wxWEB_VIEW_BACKEND_IE uses the the Trident rendering engine, which
 129     is also used by Internet Explorer. It is important to note that by default
 130     it emulates Internet Explorer 7, this can be chaged with a registry
 131     setting, see
 132     <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
 133     this</a> article for more information.
 134
 135     Note that errors are generally reported asynchronously though the
 136     @c wxEVT_COMMAND_WEB_VIEW_ERROR event described below.
 137
 138     @beginEventEmissionTable{wxWebNavigationEvent}
 139     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 140        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 141        to get a resource. This event may be vetoed to prevent navigating to this
 142        resource. Note that if the displayed HTML document has several frames, one
 143        such event will be generated per frame.
 144     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 145        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 146        confirmed that a resource would be requested. This event may not be vetoed.
 147        Note that if the displayed HTML document has several frames, one such event
 148        will be generated per frame.
 149     @event{EVT_WEB_VIEW_LOADED(id, func)}
 150        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 151        is fully loaded and displayed. Note that if the displayed HTML document has
 152        several frames, one such event will be generated per frame.
 153     @event{EVT_WEB_VIEW_ERRROR(id, func)}
 154        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 155        error occurs.
 156        The integer associated with this event will be a wxWebNavigationError item.
 157        The string associated with this event may contain a backend-specific more
 158        precise error message/code.
 159     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 160        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 161        window is created. This event may be vetoed to prevent a new window showing,
 162        for example if you want to open the url in the existing window or a new tab.
 163     @endEventTable
 164
 165     @library{wxweb}
 166     @category{ctrl,web}
 167  */
 168 class wxWebView : public wxControl
 169 {
 170 public:
 171
 172     /**
 173         Creation function for two-step creation.
 174     */
 175     virtual bool Create(wxWindow* parent,
 176                         wxWindowID id,
 177                         const wxString& url,
 178                         const wxPoint& pos,
 179                         const wxSize& size,
 180                         long style,
 181                         const wxString& name) = 0;
 182
 183     /**
 184         Factory function to create a new wxWebView for two-step creation
 185         (you need to call wxWebView::Create on the returned object)
 186         @param backend which web engine to use as backend for wxWebView
 187         @return the created wxWebView, or NULL if the requested backend is
 188                 not available
 189      */
 190     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 191
 192     /**
 193         Factory function to create a new wxWebView
 194         @param parent parent window to create this view in
 195         @param id ID of this control
 196         @param url URL to load by default in the web view
 197         @param pos position to create this control at
 198                (you may use wxDefaultPosition if you use sizers)
 199         @param size size to create this control with
 200                (you may use wxDefaultSize if you use sizers)
 201         @param backend which web engine to use as backend for wxWebView
 202         @return the created wxWebView, or NULL if the requested backend
 203                 is not available
 204     */
 205     static wxWebView* New(wxWindow* parent,
 206            wxWindowID id,
 207            const wxString& url = wxWebViewDefaultURLStr,
 208            const wxPoint& pos = wxDefaultPosition,
 209            const wxSize& size = wxDefaultSize,
 210            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 211            long style = 0,
 212            const wxString& name = wxWebViewNameStr);
 213
 214     /**
 215         Get the title of the current web page, or its URL/path if title is not
 216         available.
 217     */
 218     virtual wxString GetCurrentTitle() = 0;
 219
 220    /**
 221         Get the URL of the currently displayed document.
 222     */
 223     virtual wxString GetCurrentURL() = 0;
 224
 225     /**
 226         Get the HTML source code of the currently displayed document.
 227         @return The HTML source code, or an empty string if no page is currently
 228                 shown.
 229     */
 230     virtual wxString GetPageSource() = 0;
 231
 232     /**
 233         Returns whether the web control is currently busy (e.g. loading a page).
 234     */
 235     virtual bool IsBusy() = 0;
 236
 237     /**
 238         Load a web page from a URL
 239         @param url The URL of the page to be loaded.
 240         @note Web engines generally report errors asynchronously, so if you wish
 241             to know whether loading the URL was successful, register to receive
 242             navigation error events.
 243     */
 244     virtual void LoadUrl(const wxString& url) = 0;
 245
 246     /**
 247         Opens a print dialog so that the user may print the currently
 248         displayed page.
 249     */
 250     virtual void Print() = 0;
 251
 252     /**
 253         Reload the currently displayed URL.
 254         @param flags A bit array that may optionally contain reload options.
 255     */
 256     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 257
 258     /**
 259         Set the displayed page source to the contents of the given string.
 260         @param html    The string that contains the HTML data to display.
 261         @param baseUrl URL assigned to the HTML data, to be used to resolve
 262                     relative paths, for instance.
 263     */
 264     virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
 265
 266     /**
 267         Set the displayed page source to the contents of the given stream.
 268         @param html    The stream to read HTML data from.
 269         @param baseUrl URL assigned to the HTML data, to be used to resolve
 270                     relative paths, for instance.
 271     */
 272     virtual void SetPage(wxInputStream& html, wxString baseUrl)
 273     {
 274         wxStringOutputStream stream;
 275         stream.Write(html);
 276         SetPage(stream.GetString(), baseUrl);
 277     }
 278
 279     /**
 280         Stop the current page loading process, if any.
 281         May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
 282         TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
 283     */
 284     virtual void Stop() = 0;
 285
 286     /**
 287         @name Clipboard
 288     */
 289
 290     /**
 291         Returns @true if the current selection can be copied.
 292     */
 293     virtual bool CanCopy() = 0;
 294
 295     /**
 296         Returns @true if the current selection can be cut.
 297     */
 298     virtual bool CanCut() = 0;
 299
 300     /**
 301         Returns @true if data can be pasted.
 302     */
 303     virtual bool CanPaste() = 0;
 304
 305     /**
 306         Copies the current selection.
 307     */
 308     virtual void Copy() = 0;
 309
 310     /**
 311         Cuts the current selection.
 312     */
 313     virtual void Cut() = 0;
 314
 315     /**
 316         Pastes the current data.
 317     */
 318     virtual void Paste() = 0;
 319
 320     /**
 321         @name History
 322     */
 323
 324     /**
 325         Returns @true if it is possible to navigate backward in the history of
 326         visited pages.
 327     */
 328     virtual bool CanGoBack() = 0;
 329
 330     /**
 331         Returns @true if it is possible to navigate forward in the history of
 332         visited pages.
 333     */
 334     virtual bool CanGoForward() = 0;
 335
 336     /**
 337         Clear the history, this will also remove the visible page.
 338     */
 339     virtual void ClearHistory() = 0;
 340
 341     /**
 342         Enable or disable the history. This will also clear the history.
 343     */
 344     virtual void EnableHistory(bool enable = true) = 0;
 345
 346     /**
 347         Returns a list of items in the back history. The first item in the
 348         vector is the first page that was loaded by the control.
 349     */
 350     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory() = 0;
 351
 352     /**
 353         Returns a list of items in the forward history. The first item in the
 354         vector is the next item in the history with respect to the curently
 355         loaded page.
 356     */
 357     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory() = 0;
 358
 359     /**
 360         Navigate back in the history of visited pages.
 361         Only valid if CanGoBack() returns true.
 362     */
 363     virtual void GoBack() = 0;
 364
 365     /**
 366         Navigate forward in the history of visited pages.
 367         Only valid if CanGoForward() returns true.
 368     */
 369     virtual void GoForward() = 0;
 370
 371     /**
 372         Loads a history item.
 373     */
 374     virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item) = 0;
 375
 376     /**
 377         @name Undo / Redo
 378     */
 379
 380     /**
 381         Returns @true if there is an action to redo.
 382     */
 383     virtual bool CanRedo() = 0;
 384
 385     /**
 386         Returns @true if there is an action to undo.
 387     */
 388     virtual bool CanUndo() = 0;
 389
 390     /**
 391         Redos the last action.
 392     */
 393     virtual void Redo() = 0;
 394
 395     /**
 396         Undos the last action.
 397     */
 398     virtual void Undo() = 0;
 399
 400     /**
 401         @name Zoom
 402     */
 403
 404     /**
 405         Retrieve whether the current HTML engine supports a zoom type.
 406         @param type The zoom type to test.
 407         @return Whether this type of zoom is supported by this HTML engine
 408                 (and thus can be set through SetZoomType()).
 409     */
 410     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 411
 412     /**
 413         Get the zoom factor of the page.
 414         @return The current level of zoom.
 415     */
 416     virtual wxWebViewZoom GetZoom() = 0;
 417
 418     /**
 419         Get how the zoom factor is currently interpreted.
 420         @return How the zoom factor is currently interpreted by the HTML engine.
 421     */
 422     virtual wxWebViewZoomType GetZoomType() const = 0;
 423
 424     /**
 425         Set the zoom factor of the page.
 426         @param zoom How much to zoom (scale) the HTML document.
 427     */
 428     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 429
 430     /**
 431         Set how to interpret the zoom factor.
 432         @param zoomType How the zoom factor should be interpreted by the
 433                         HTML engine.
 434         @note invoke    CanSetZoomType() first, some HTML renderers may not
 435                         support all zoom types.
 436     */
 437     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 438 };
 439
 440
 441
 442
 443 /**
 444     @class wxWebNavigationEvent
 445
 446     A navigation  event holds information about events associated with
 447     wxWebView objects.
 448
 449     @beginEventEmissionTable{wxWebNavigationEvent}
 450     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 451        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 452        to get a resource. This event may be vetoed to prevent navigating to this
 453        resource. Note that if the displayed HTML document has several frames, one
 454        such event will be generated per frame.
 455     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 456        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 457        confirmed that a resource would be requested. This event may not be vetoed.
 458        Note that if the displayed HTML document has several frames, one such event
 459        will be generated per frame.
 460     @event{EVT_WEB_VIEW_LOADED(id, func)}
 461        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 462        is fully loaded and displayed. Note that if the displayed HTML document has
 463        several frames, one such event will be generated per frame.
 464     @event{EVT_WEB_VIEW_ERRROR(id, func)}
 465        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 466        error occurs.
 467        The integer associated with this event will be a wxWebNavigationError item.
 468        The string associated with this event may contain a backend-specific more
 469        precise error message/code.
 470     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 471        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 472        window is created. This event may be vetoed to prevent a new window showing,
 473        for example if you want to open the url in the existing window or a new tab.
 474     @endEventTable
 475
 476     @library{wxweb}
 477     @category{events,web}
 478
 479     @see wxWebView
 480 */
 481 class wxWebNavigationEvent : public wxCommandEvent
 482 {
 483 public:
 484     wxWebNavigationEvent();
 485     wxWebNavigationEvent(wxEventType type, int id, const wxString href,
 486                          const wxString target, bool canVeto);
 487     /**
 488         Get the URL being visited
 489     */
 490     const wxString& GetHref() const { return m_href; }
 491
 492     /**
 493         Get the target (frame or window) in which the URL that caused this event
 494         is viewed, or an empty string if not available.
 495     */
 496     const wxString& GetTarget() const;
 497
 498     virtual wxEvent* Clone() const;
 499
 500     /**
 501         Get whether this event may be vetoed (stopped/prevented). Only
 502         meaningful for events fired before navigation takes place or new
 503         window events.
 504      */
 505     bool CanVeto() const;
 506
 507     /**
 508         Whether this event was vetoed (stopped/prevented). Only meaningful for
 509         events fired before navigation takes place or new window events.
 510      */
 511     bool IsVetoed() const;
 512
 513     /**
 514         Veto (prevent/stop) this event. Only meaningful for events fired
 515         before navigation takes place or new window events. Only valid
 516         if CanVeto() returned true.
 517      */
 518     void Veto();
 519 };