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 available 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 wxWebViewNavigationError
  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     Find flags used when searching for text on page.
  74 */
  75 enum wxWebViewFindFlags
  76 {
  77     /** Causes the search to restart when end or beginning reached */
  78     wxWEB_VIEW_FIND_WRAP =             0x0001,
  79
  80     /** Matches an entire word when searching */
  81     wxWEB_VIEW_FIND_ENTIRE_WORD =      0x0002,
  82
  83     /** Match case, i.e. case sensitive searching */
  84     wxWEB_VIEW_FIND_MATCH_CASE =       0x0004,
  85
  86     /** Highlights the search results */
  87     wxWEB_VIEW_FIND_HIGHLIGHT_RESULT = 0x0008,
  88
  89     /** Searches for phrase in backward direction */
  90     wxWEB_VIEW_FIND_BACKWARDS =        0x0010,
  91
  92     /** The default flag, which is simple searching */
  93     wxWEB_VIEW_FIND_DEFAULT =          0
  94 };
  95
  96 /**
  97  * List of available backends for wxWebView
  98  */
  99 enum wxWebViewBackend
 100 {
 101     /** Value that may be passed to wxWebView to let it pick an appropriate
 102      * engine for the current platform*/
 103     wxWEB_VIEW_BACKEND_DEFAULT,
 104
 105     /** The WebKit web engine */
 106     wxWEB_VIEW_BACKEND_WEBKIT,
 107
 108     /** Use Microsoft Internet Explorer as web engine */
 109     wxWEB_VIEW_BACKEND_IE
 110 };
 111
 112 /**
 113     @class wxWebViewHistoryItem
 114
 115     A simple class that contains the URL and title of an element of the history
 116     of a wxWebView.
 117
 118     @since 2.9.3
 119     @library{wxwebview}
 120     @category{webview}
 121
 122     @see wxWebView
 123  */
 124 class wxWebViewHistoryItem
 125 {
 126 public:
 127     /**
 128         Construtor.
 129     */
 130     wxWebViewHistoryItem(const wxString& url, const wxString& title);
 131
 132     /**
 133         @return The url of the page.
 134     */
 135     wxString GetUrl();
 136
 137     /**
 138         @return The title of the page.
 139     */
 140     wxString GetTitle();
 141 };
 142
 143 /**
 144     @class wxWebViewHandler
 145
 146     The base class for handling custom schemes in wxWebView, for example to
 147     allow virtual file system support.
 148
 149     @since 2.9.3
 150     @library{wxwebview}
 151     @category{webview}
 152
 153     @see wxWebView
 154  */
 155 class wxWebViewHandler
 156 {
 157 public:
 158     /**
 159         Constructor. Takes the name of the scheme that will be handled by this
 160         class for example @c file or @c zip.
 161     */
 162     wxWebViewHandler(const wxString& scheme);
 163
 164     /**
 165         @return A pointer to the file represented by @c uri.
 166     */
 167     virtual wxFSFile* GetFile(const wxString &uri) = 0;
 168
 169     /**
 170         @return The name of the scheme, as passed to the constructor.
 171     */
 172     virtual wxString GetName() const;
 173 };
 174
 175 /**
 176     @class wxWebView
 177
 178     This control may be used to render web (HTML / CSS / javascript) documents.
 179     It is designed to allow the creation of multiple backends for each port,
 180     although currently just one is available. It differs from wxHtmlWindow in
 181     that each backend is actually a full rendering engine, Trident on MSW and
 182     Webkit on OSX and GTK. This allows the correct viewing complex pages with
 183     javascript and css.
 184
 185     @section descriptions Backend Descriptions
 186
 187     @par wxWEB_VIEW_BACKEND_IE (MSW)
 188
 189     The IE backend uses Microsoft's Trident rendering engine, specifically the
 190     version used by the locally installed copy of Internet Explorer. As such it
 191     is only available for the MSW port. By default recent versions of the
 192     <a href="http://msdn.microsoft.com/en-us/library/aa752085%28v=VS.85%29.aspx">WebBrowser</a>
 193     control, which this backend uses, emulate Internet Explorer 7. This can be
 194     changed with a registry setting, see
 195     <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
 196     this</a> article for more information. This backend has full support for
 197     custom schemes and virtual file systems.
 198
 199     @par wxWEB_VIEW_WEBKIT (GTK)
 200
 201     Under GTK the WebKit backend uses
 202     <a href="http://webkitgtk.org/">WebKitGTK+</a>. The current minimum version
 203     required is 1.3.1 which ships by default with Ubuntu Natty and Debian
 204     Wheezy and has the package name libwebkitgtk-dev. Custom schemes and
 205     virtual files systems are supported under this backend, however embedded
 206     resources such as images and stylesheets are currently loaded using the
 207     data:// scheme.
 208
 209     @par wxWEB_VIEW_WEBKIT (OSX)
 210
 211     The OSX WebKit backend uses Apple's
 212     <a href="http://developer.apple.com/library/mac/#documentation/Cocoa/Reference/WebKit/Classes/WebView_Class/Reference/Reference.html#//apple_ref/doc/uid/20001903">WebView</a>
 213     class. This backend has full support for custom schemes and virtual file
 214     systems.
 215
 216     @section async Asynchronous Notifications
 217
 218     Many of the methods in wxWebView are asynchronous, i.e. they return
 219     immediately and perform their work in the background. This includes
 220     functions such as LoadUrl() and Reload(). To receive notification of the
 221     progress and completion of these functions you need to handle the events
 222     that are provided. Specifically @c wxEVT_COMMAND_WEB_VIEW_LOADED notifies
 223     when the page or a sub-frame has finished loading and
 224     @c wxEVT_COMMAND_WEB_VIEW_ERROR notifies that an error has occurred.
 225
 226     @section vfs Virtual File Systems and Custom Schemes
 227
 228     wxWebView supports the registering of custom scheme handlers, for example
 229     @c file or @c http. To do this create a new class which inherits from
 230     wxWebViewHandler, where wxWebHandler::GetFile() returns a pointer to a
 231     wxFSFile which represents the given url. You can then register your handler
 232     with RegisterHandler() it will be called for all pages and resources.
 233
 234     wxWebViewFSHandler is provided to access the virtual file system encapsulated by
 235     wxFileSystem. The wxMemoryFSHandler documentation gives an example of how this
 236     may be used.
 237
 238     wxWebViewArchiveHandler is provided to allow the navigation of pages inside a zip
 239     archive. It supports paths of the form:
 240     @c scheme:///C:/example/docs.zip;protocol=zip/main.htm
 241
 242     @beginEventEmissionTable{wxWebViewEvent}
 243     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 244        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 245        to get a resource. This event may be vetoed to prevent navigating to this
 246        resource. Note that if the displayed HTML document has several frames, one
 247        such event will be generated per frame.
 248     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 249        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 250        confirmed that a resource would be requested. This event may not be vetoed.
 251        Note that if the displayed HTML document has several frames, one such event
 252        will be generated per frame.
 253     @event{EVT_WEB_VIEW_LOADED(id, func)}
 254        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 255        is fully loaded and displayed. Note that if the displayed HTML document has
 256        several frames, one such event will be generated per frame.
 257     @event{EVT_WEB_VIEW_ERROR(id, func)}
 258        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 259        error occurs.
 260        The integer associated with this event will be a wxWebNavigationError item.
 261        The string associated with this event may contain a backend-specific more
 262        precise error message/code.
 263     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 264        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 265        window is created. You must handle this event if you want anything to
 266        happen, for example to load the page in a new window or tab.
 267     @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
 268        Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
 269        the page title changes. Use GetString to get the title.
 270     @endEventTable
 271
 272     @since 2.9.3
 273     @library{wxwebview}
 274     @category{ctrl,webview}
 275     @see wxWebViewHandler, wxWebViewEvent
 276  */
 277 class wxWebView : public wxControl
 278 {
 279 public:
 280
 281     /**
 282         Creation function for two-step creation.
 283     */
 284     virtual bool Create(wxWindow* parent,
 285                         wxWindowID id,
 286                         const wxString& url = wxWebViewDefaultURLStr,
 287                         const wxPoint& pos = wxDefaultPosition,
 288                         const wxSize& size = wxDefaultSize,
 289                         long style = 0,
 290                         const wxString& name = wxWebViewNameStr) = 0;
 291
 292     /**
 293         Factory function to create a new wxWebView for two-step creation
 294         (you need to call wxWebView::Create on the returned object)
 295         @param backend which web engine to use as backend for wxWebView
 296         @return the created wxWebView, or NULL if the requested backend is
 297                 not available
 298      */
 299     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 300
 301     /**
 302         Factory function to create a new wxWebView
 303         @param parent parent window to create this view in
 304         @param id ID of this control
 305         @param url URL to load by default in the web view
 306         @param pos position to create this control at
 307                (you may use wxDefaultPosition if you use sizers)
 308         @param size size to create this control with
 309                (you may use wxDefaultSize if you use sizers)
 310         @param backend which web engine to use as backend for wxWebView
 311         @return the created wxWebView, or NULL if the requested backend
 312                 is not available
 313     */
 314     static wxWebView* New(wxWindow* parent,
 315            wxWindowID id,
 316            const wxString& url = wxWebViewDefaultURLStr,
 317            const wxPoint& pos = wxDefaultPosition,
 318            const wxSize& size = wxDefaultSize,
 319            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 320            long style = 0,
 321            const wxString& name = wxWebViewNameStr);
 322
 323     /**
 324         Get the title of the current web page, or its URL/path if title is not
 325         available.
 326     */
 327     virtual wxString GetCurrentTitle() const = 0;
 328
 329    /**
 330         Get the URL of the currently displayed document.
 331     */
 332     virtual wxString GetCurrentURL() const = 0;
 333
 334     /**
 335         Return the pointer to the native backend used by this control.
 336
 337         This method can be used to retrieve the pointer to the native rendering
 338         engine used by this control. The return value needs to be down-casted
 339         to the appropriate type depending on the platform: under Windows, it's
 340         a pointer to IWebBrowser2 interface, under OS X it's a WebView pointer
 341         and under GTK it's a WebKitWebView.
 342
 343         For example, you could set the WebKit options using this method:
 344         @code
 345             #include <webkit/webkit.h>
 346
 347             #ifdef __WXGTK__
 348                WebKitWebView*
 349                 wv = static_cast<WebKitWebView*>(m_window->GetNativeBackend());
 350
 351                WebKitWebSettings* settings = webkit_web_view_get_settings(wv);
 352                g_object_set(G_OBJECT(settings),
 353                             "enable-frame-flattening", TRUE,
 354                             NULL);
 355             #endif
 356         @endcode
 357
 358         @since 2.9.5
 359      */
 360     virtual void* GetNativeBackend() const = 0;
 361
 362     /**
 363         Get the HTML source code of the currently displayed document.
 364         @return The HTML source code, or an empty string if no page is currently
 365                 shown.
 366     */
 367     virtual wxString GetPageSource() const = 0;
 368
 369     /**
 370         Get the text of the current page.
 371     */
 372     virtual wxString GetPageText() const = 0;
 373
 374     /**
 375         Returns whether the web control is currently busy (e.g.\ loading a page).
 376     */
 377     virtual bool IsBusy() const = 0;
 378
 379     /**
 380         Returns whether the web control is currently editable
 381     */
 382     virtual bool IsEditable() const = 0;
 383
 384     /**
 385         Load a web page from a URL
 386         @param url The URL of the page to be loaded.
 387         @note Web engines generally report errors asynchronously, so if you wish
 388             to know whether loading the URL was successful, register to receive
 389             navigation error events.
 390     */
 391     virtual void LoadURL(const wxString& url) = 0;
 392
 393     /**
 394         Opens a print dialog so that the user may print the currently
 395         displayed page.
 396     */
 397     virtual void Print() = 0;
 398
 399     /**
 400         Registers a custom scheme handler.
 401         @param handler A shared pointer to a wxWebHandler.
 402     */
 403     virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
 404
 405     /**
 406         Reload the currently displayed URL.
 407         @param flags A bit array that may optionally contain reload options.
 408     */
 409     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 410
 411     /**
 412         Runs the given javascript code.
 413         @note When using wxWEB_VIEW_BACKEND_IE you must wait for the current
 414               page to finish loading before calling RunScript().
 415     */
 416     virtual void RunScript(const wxString& javascript) = 0;
 417
 418     /**
 419         Set the editable property of the web control. Enabling allows the user
 420         to edit the page even if the @c contenteditable attribute is not set.
 421         The exact capabilities vary with the backend being used.
 422     */
 423     virtual void SetEditable(bool enable = true) = 0;
 424
 425     /**
 426         Set the displayed page source to the contents of the given string.
 427         @param html    The string that contains the HTML data to display.
 428         @param baseUrl URL assigned to the HTML data, to be used to resolve
 429                     relative paths, for instance.
 430         @note When using wxWEB_VIEW_BACKEND_IE you must wait for the current
 431               page to finish loading before calling SetPage().
 432     */
 433     virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
 434
 435     /**
 436         Set the displayed page source to the contents of the given stream.
 437         @param html    The stream to read HTML data from.
 438         @param baseUrl URL assigned to the HTML data, to be used to resolve
 439                     relative paths, for instance.
 440     */
 441     virtual void SetPage(wxInputStream& html, wxString baseUrl);
 442
 443     /**
 444         Stop the current page loading process, if any.
 445         May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
 446         TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
 447     */
 448     virtual void Stop() = 0;
 449
 450     /**
 451         @name Clipboard
 452     */
 453
 454     /**
 455         Returns @true if the current selection can be copied.
 456
 457         @note This always returns @c true on the OSX WebKit backend.
 458     */
 459     virtual bool CanCopy() const = 0;
 460
 461     /**
 462         Returns @true if the current selection can be cut.
 463
 464          @note This always returns @c true on the OSX WebKit backend.
 465     */
 466     virtual bool CanCut() const = 0;
 467
 468     /**
 469         Returns @true if data can be pasted.
 470
 471         @note This always returns @c true on the OSX WebKit backend.
 472     */
 473     virtual bool CanPaste() const = 0;
 474
 475     /**
 476         Copies the current selection.
 477     */
 478     virtual void Copy() = 0;
 479
 480     /**
 481         Cuts the current selection.
 482     */
 483     virtual void Cut() = 0;
 484
 485     /**
 486         Pastes the current data.
 487     */
 488     virtual void Paste() = 0;
 489
 490     /**
 491         @name History
 492     */
 493
 494     /**
 495         Returns @true if it is possible to navigate backward in the history of
 496         visited pages.
 497     */
 498     virtual bool CanGoBack() const = 0;
 499
 500     /**
 501         Returns @true if it is possible to navigate forward in the history of
 502         visited pages.
 503     */
 504     virtual bool CanGoForward() const = 0;
 505
 506     /**
 507         Clear the history, this will also remove the visible page.
 508     */
 509     virtual void ClearHistory() = 0;
 510
 511     /**
 512         Enable or disable the history. This will also clear the history.
 513     */
 514     virtual void EnableHistory(bool enable = true) = 0;
 515
 516     /**
 517         Returns a list of items in the back history. The first item in the
 518         vector is the first page that was loaded by the control.
 519     */
 520     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;
 521
 522     /**
 523         Returns a list of items in the forward history. The first item in the
 524         vector is the next item in the history with respect to the curently
 525         loaded page.
 526     */
 527     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;
 528
 529     /**
 530         Navigate back in the history of visited pages.
 531         Only valid if CanGoBack() returns true.
 532     */
 533     virtual void GoBack() = 0;
 534
 535     /**
 536         Navigate forward in the history of visited pages.
 537         Only valid if CanGoForward() returns true.
 538     */
 539     virtual void GoForward() = 0;
 540
 541     /**
 542         Loads a history item.
 543     */
 544     virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
 545
 546     /**
 547         @name Selection
 548     */
 549
 550     /**
 551         Clears the current selection.
 552     */
 553     virtual void ClearSelection() = 0;
 554
 555     /**
 556         Deletes the current selection. Note that for @c wxWEB_VIEW_BACKEND_WEBKIT
 557         the selection must be editable, either through SetEditable or the
 558         correct HTML attribute.
 559     */
 560     virtual void DeleteSelection() = 0;
 561
 562     /**
 563         Returns the currently selected source, if any.
 564     */
 565     virtual wxString GetSelectedSource() const = 0;
 566
 567     /**
 568         Returns the currently selected text, if any.
 569     */
 570     virtual wxString GetSelectedText() const = 0;
 571
 572     /**
 573         Returns @true if there is a current selection.
 574     */
 575     virtual bool HasSelection() const = 0;
 576
 577     /**
 578         Selects the entire page.
 579     */
 580     virtual void SelectAll() = 0;
 581
 582     /**
 583         @name Undo / Redo
 584     */
 585
 586     /**
 587         Returns @true if there is an action to redo.
 588     */
 589     virtual bool CanRedo() const = 0;
 590
 591     /**
 592         Returns @true if there is an action to undo.
 593     */
 594     virtual bool CanUndo() const = 0;
 595
 596     /**
 597         Redos the last action.
 598     */
 599     virtual void Redo() = 0;
 600
 601     /**
 602         Undos the last action.
 603     */
 604     virtual void Undo() = 0;
 605
 606     /**
 607         @name Finding
 608     */
 609
 610     /**
 611         Finds a phrase on the current page and if found, the control will
 612         scroll the phrase into view and select it.
 613         @param text The phrase to search for.
 614         @param flags The flags for the search.
 615         @return If search phrase was not found in combination with the flags
 616                 then @c wxNOT_FOUND is returned. If called for the first time
 617                 with search phrase then the total number of results will be
 618                 returned. Then for every time its called with the same search
 619                 phrase it will return the number of the current match.
 620         @note This function will restart the search if the flags
 621               @c wxWEB_VIEW_FIND_ENTIRE_WORD or @c wxWEB_VIEW_FIND_MATCH_CASE
 622               are changed, since this will require a new search. To reset the
 623               search, for example reseting the highlights call the function
 624               with an empty search phrase. This always returns @c wxNOT_FOUND
 625               on the OSX WebKit backend.
 626         @since 2.9.5
 627     */
 628     virtual long Find(const wxString& text, wxWebViewFindFlags flags = wxWEB_VIEW_FIND_DEFAULT) = 0;
 629
 630     /**
 631         @name Zoom
 632     */
 633
 634     /**
 635         Retrieve whether the current HTML engine supports a zoom type.
 636         @param type The zoom type to test.
 637         @return Whether this type of zoom is supported by this HTML engine
 638                 (and thus can be set through SetZoomType()).
 639     */
 640     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 641
 642     /**
 643         Get the zoom factor of the page.
 644         @return The current level of zoom.
 645     */
 646     virtual wxWebViewZoom GetZoom() const = 0;
 647
 648     /**
 649         Get how the zoom factor is currently interpreted.
 650         @return How the zoom factor is currently interpreted by the HTML engine.
 651     */
 652     virtual wxWebViewZoomType GetZoomType() const = 0;
 653
 654     /**
 655         Set the zoom factor of the page.
 656         @param zoom How much to zoom (scale) the HTML document.
 657     */
 658     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 659
 660     /**
 661         Set how to interpret the zoom factor.
 662         @param zoomType How the zoom factor should be interpreted by the
 663                         HTML engine.
 664         @note invoke    CanSetZoomType() first, some HTML renderers may not
 665                         support all zoom types.
 666     */
 667     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 668 };
 669
 670
 671
 672
 673 /**
 674     @class wxWebViewEvent
 675
 676     A navigation  event holds information about events associated with
 677     wxWebView objects.
 678
 679     @beginEventEmissionTable{wxWebViewEvent}
 680     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 681        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 682        to get a resource. This event may be vetoed to prevent navigating to this
 683        resource. Note that if the displayed HTML document has several frames, one
 684        such event will be generated per frame.
 685     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 686        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 687        confirmed that a resource would be requested. This event may not be vetoed.
 688        Note that if the displayed HTML document has several frames, one such event
 689        will be generated per frame.
 690     @event{EVT_WEB_VIEW_LOADED(id, func)}
 691        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 692        is fully loaded and displayed. Note that if the displayed HTML document has
 693        several frames, one such event will be generated per frame.
 694     @event{EVT_WEB_VIEW_ERROR(id, func)}
 695        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 696        error occurs.
 697        The integer associated with this event will be a wxWebNavigationError item.
 698        The string associated with this event may contain a backend-specific more
 699        precise error message/code.
 700     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 701        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 702        window is created. You must handle this event if you want anything to
 703        happen, for example to load the page in a new window or tab.
 704     @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
 705        Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
 706        the page title changes. Use GetString to get the title.
 707     @endEventTable
 708
 709     @since 2.9.3
 710     @library{wxwebview}
 711     @category{events,webview}
 712
 713     @see wxWebView
 714 */
 715 class wxWebViewEvent : public wxNotifyEvent
 716 {
 717 public:
 718     wxWebViewEvent();
 719     wxWebViewEvent(wxEventType type, int id, const wxString href,
 720                    const wxString target);
 721
 722     /**
 723         Get the name of the target frame which the url of this event
 724         has been or will be loaded into. This may return an emptry string
 725         if the frame is not available.
 726     */
 727     const wxString& GetTarget() const;
 728
 729     /**
 730         Get the URL being visited
 731     */
 732     const wxString& GetURL() const;
 733 };
 734
 735
 736 wxEventType wxEVT_COMMAND_WEB_VIEW_NAVIGATING;
 737 wxEventType wxEVT_COMMAND_WEB_VIEW_NAVIGATED;
 738 wxEventType wxEVT_COMMAND_WEB_VIEW_LOADED;
 739 wxEventType wxEVT_COMMAND_WEB_VIEW_ERROR;
 740 wxEventType wxEVT_COMMAND_WEB_VIEW_NEWWINDOW;
 741 wxEventType wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED;