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     wxWebFileHandler is provided to allow the navigation of pages inside a zip
 235     archive. It overrides the @c file scheme and provides support for the
 236     standard @c file syntax as well as paths to archives of the form
 237     @c file:///C:/example/docs.zip;protocol=zip/main.htm
 238
 239     @beginEventEmissionTable{wxWebViewEvent}
 240     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 241        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 242        to get a resource. This event may be vetoed to prevent navigating to this
 243        resource. Note that if the displayed HTML document has several frames, one
 244        such event will be generated per frame.
 245     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 246        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 247        confirmed that a resource would be requested. This event may not be vetoed.
 248        Note that if the displayed HTML document has several frames, one such event
 249        will be generated per frame.
 250     @event{EVT_WEB_VIEW_LOADED(id, func)}
 251        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 252        is fully loaded and displayed. Note that if the displayed HTML document has
 253        several frames, one such event will be generated per frame.
 254     @event{EVT_WEB_VIEW_ERROR(id, func)}
 255        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 256        error occurs.
 257        The integer associated with this event will be a wxWebNavigationError item.
 258        The string associated with this event may contain a backend-specific more
 259        precise error message/code.
 260     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 261        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 262        window is created. You must handle this event if you want anything to
 263        happen, for example to load the page in a new window or tab.
 264     @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
 265        Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
 266        the page title changes. Use GetString to get the title.
 267     @endEventTable
 268
 269     @since 2.9.3
 270     @library{wxwebview}
 271     @category{ctrl,webview}
 272     @see wxWebViewHandler, wxWebViewEvent
 273  */
 274 class wxWebView : public wxControl
 275 {
 276 public:
 277
 278     /**
 279         Creation function for two-step creation.
 280     */
 281     virtual bool Create(wxWindow* parent,
 282                         wxWindowID id,
 283                         const wxString& url = wxWebViewDefaultURLStr,
 284                         const wxPoint& pos = wxDefaultPosition,
 285                         const wxSize& size = wxDefaultSize,
 286                         long style = 0,
 287                         const wxString& name = wxWebViewNameStr) = 0;
 288
 289     /**
 290         Factory function to create a new wxWebView for two-step creation
 291         (you need to call wxWebView::Create on the returned object)
 292         @param backend which web engine to use as backend for wxWebView
 293         @return the created wxWebView, or NULL if the requested backend is
 294                 not available
 295      */
 296     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 297
 298     /**
 299         Factory function to create a new wxWebView
 300         @param parent parent window to create this view in
 301         @param id ID of this control
 302         @param url URL to load by default in the web view
 303         @param pos position to create this control at
 304                (you may use wxDefaultPosition if you use sizers)
 305         @param size size to create this control with
 306                (you may use wxDefaultSize if you use sizers)
 307         @param backend which web engine to use as backend for wxWebView
 308         @return the created wxWebView, or NULL if the requested backend
 309                 is not available
 310     */
 311     static wxWebView* New(wxWindow* parent,
 312            wxWindowID id,
 313            const wxString& url = wxWebViewDefaultURLStr,
 314            const wxPoint& pos = wxDefaultPosition,
 315            const wxSize& size = wxDefaultSize,
 316            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 317            long style = 0,
 318            const wxString& name = wxWebViewNameStr);
 319
 320     /**
 321         Get the title of the current web page, or its URL/path if title is not
 322         available.
 323     */
 324     virtual wxString GetCurrentTitle() const = 0;
 325
 326    /**
 327         Get the URL of the currently displayed document.
 328     */
 329     virtual wxString GetCurrentURL() const = 0;
 330
 331     /**
 332         Return the pointer to the native backend used by this control.
 333
 334         This method can be used to retrieve the pointer to the native rendering
 335         engine used by this control. The return value needs to be down-casted
 336         to the appropriate type depending on the platform: under Windows, it's
 337         a pointer to IWebBrowser2 interface, under OS X it's a WebView pointer
 338         and under GTK it's a WebKitWebView.
 339
 340         For example, you could set the WebKit options using this method:
 341         @code
 342             #include <webkit/webkit.h>
 343
 344             #ifdef __WXGTK__
 345                WebKitWebView*
 346                 wv = static_cast<WebKitWebView*>(m_window->GetNativeBackend());
 347
 348                WebKitWebSettings* settings = webkit_web_view_get_settings(wv);
 349                g_object_set(G_OBJECT(settings),
 350                             "enable-frame-flattening", TRUE,
 351                             NULL);
 352             #endif
 353         @endcode
 354
 355         @since 2.9.5
 356      */
 357     virtual void* GetNativeBackend() const = 0;
 358
 359     /**
 360         Get the HTML source code of the currently displayed document.
 361         @return The HTML source code, or an empty string if no page is currently
 362                 shown.
 363     */
 364     virtual wxString GetPageSource() const = 0;
 365
 366     /**
 367         Get the text of the current page.
 368     */
 369     virtual wxString GetPageText() const = 0;
 370
 371     /**
 372         Returns whether the web control is currently busy (e.g. loading a page).
 373     */
 374     virtual bool IsBusy() const = 0;
 375
 376     /**
 377         Returns whether the web control is currently editable
 378     */
 379     virtual bool IsEditable() const = 0;
 380
 381     /**
 382         Load a web page from a URL
 383         @param url The URL of the page to be loaded.
 384         @note Web engines generally report errors asynchronously, so if you wish
 385             to know whether loading the URL was successful, register to receive
 386             navigation error events.
 387     */
 388     virtual void LoadURL(const wxString& url) = 0;
 389
 390     /**
 391         Opens a print dialog so that the user may print the currently
 392         displayed page.
 393     */
 394     virtual void Print() = 0;
 395
 396     /**
 397         Registers a custom scheme handler.
 398         @param handler A shared pointer to a wxWebHandler.
 399     */
 400     virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
 401
 402     /**
 403         Reload the currently displayed URL.
 404         @param flags A bit array that may optionally contain reload options.
 405     */
 406     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 407
 408     /**
 409         Runs the given javascript code.
 410     */
 411     virtual void RunScript(const wxString& javascript) = 0;
 412
 413     /**
 414         Set the editable property of the web control. Enabling allows the user
 415         to edit the page even if the @c contenteditable attribute is not set.
 416         The exact capabilities vary with the backend being used.
 417     */
 418     virtual void SetEditable(bool enable = true) = 0;
 419
 420     /**
 421         Set the displayed page source to the contents of the given string.
 422         @param html    The string that contains the HTML data to display.
 423         @param baseUrl URL assigned to the HTML data, to be used to resolve
 424                     relative paths, for instance.
 425     */
 426     virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
 427
 428     /**
 429         Set the displayed page source to the contents of the given stream.
 430         @param html    The stream to read HTML data from.
 431         @param baseUrl URL assigned to the HTML data, to be used to resolve
 432                     relative paths, for instance.
 433     */
 434     virtual void SetPage(wxInputStream& html, wxString baseUrl);
 435
 436     /**
 437         Stop the current page loading process, if any.
 438         May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
 439         TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
 440     */
 441     virtual void Stop() = 0;
 442
 443     /**
 444         @name Clipboard
 445     */
 446
 447     /**
 448         Returns @true if the current selection can be copied.
 449
 450         @note This always returns @c true on the OSX WebKit backend.
 451     */
 452     virtual bool CanCopy() const = 0;
 453
 454     /**
 455         Returns @true if the current selection can be cut.
 456
 457          @note This always returns @c true on the OSX WebKit backend.
 458     */
 459     virtual bool CanCut() const = 0;
 460
 461     /**
 462         Returns @true if data can be pasted.
 463
 464         @note This always returns @c true on the OSX WebKit backend.
 465     */
 466     virtual bool CanPaste() const = 0;
 467
 468     /**
 469         Copies the current selection.
 470     */
 471     virtual void Copy() = 0;
 472
 473     /**
 474         Cuts the current selection.
 475     */
 476     virtual void Cut() = 0;
 477
 478     /**
 479         Pastes the current data.
 480     */
 481     virtual void Paste() = 0;
 482
 483     /**
 484         @name History
 485     */
 486
 487     /**
 488         Returns @true if it is possible to navigate backward in the history of
 489         visited pages.
 490     */
 491     virtual bool CanGoBack() const = 0;
 492
 493     /**
 494         Returns @true if it is possible to navigate forward in the history of
 495         visited pages.
 496     */
 497     virtual bool CanGoForward() const = 0;
 498
 499     /**
 500         Clear the history, this will also remove the visible page.
 501     */
 502     virtual void ClearHistory() = 0;
 503
 504     /**
 505         Enable or disable the history. This will also clear the history.
 506     */
 507     virtual void EnableHistory(bool enable = true) = 0;
 508
 509     /**
 510         Returns a list of items in the back history. The first item in the
 511         vector is the first page that was loaded by the control.
 512     */
 513     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;
 514
 515     /**
 516         Returns a list of items in the forward history. The first item in the
 517         vector is the next item in the history with respect to the curently
 518         loaded page.
 519     */
 520     virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;
 521
 522     /**
 523         Navigate back in the history of visited pages.
 524         Only valid if CanGoBack() returns true.
 525     */
 526     virtual void GoBack() = 0;
 527
 528     /**
 529         Navigate forward in the history of visited pages.
 530         Only valid if CanGoForward() returns true.
 531     */
 532     virtual void GoForward() = 0;
 533
 534     /**
 535         Loads a history item.
 536     */
 537     virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
 538
 539     /**
 540         @name Selection
 541     */
 542
 543     /**
 544         Clears the current selection.
 545     */
 546     virtual void ClearSelection() = 0;
 547
 548     /**
 549         Deletes the current selection. Note that for @c wxWEB_VIEW_BACKEND_WEBKIT
 550         the selection must be editable, either through SetEditable or the
 551         correct HTML attribute.
 552     */
 553     virtual void DeleteSelection() = 0;
 554
 555     /**
 556         Returns the currently selected source, if any.
 557     */
 558     virtual wxString GetSelectedSource() const = 0;
 559
 560     /**
 561         Returns the currently selected text, if any.
 562     */
 563     virtual wxString GetSelectedText() const = 0;
 564
 565     /**
 566         Returns @true if there is a current selection.
 567     */
 568     virtual bool HasSelection() const = 0;
 569
 570     /**
 571         Selects the entire page.
 572     */
 573     virtual void SelectAll() = 0;
 574
 575     /**
 576         @name Undo / Redo
 577     */
 578
 579     /**
 580         Returns @true if there is an action to redo.
 581     */
 582     virtual bool CanRedo() const = 0;
 583
 584     /**
 585         Returns @true if there is an action to undo.
 586     */
 587     virtual bool CanUndo() const = 0;
 588
 589     /**
 590         Redos the last action.
 591     */
 592     virtual void Redo() = 0;
 593
 594     /**
 595         Undos the last action.
 596     */
 597     virtual void Undo() = 0;
 598
 599     /**
 600         @name Finding
 601     */
 602
 603     /**
 604         Finds a phrase on the current page and if found, the control will
 605         scroll the phrase into view and select it.
 606         @param text The phrase to search for.
 607         @param flags The flags for the search.
 608         @return If search phrase was not found in combination with the flags
 609                 then @c wxNOT_FOUND is returned. If called for the first time
 610                 with search phrase then the total number of results will be
 611                 returned. Then for every time its called with the same search
 612                 phrase it will return the number of the current match.
 613         @note This function will restart the search if the flags
 614               @c wxWEB_VIEW_FIND_ENTIRE_WORD or @c wxWEB_VIEW_FIND_MATCH_CASE
 615               are changed, since this will require a new search. To reset the
 616               search, for example reseting the highlights call the function
 617               with an empty search phrase. This always returns @c wxNOT_FOUND
 618               on the OSX WebKit backend.
 619         @since 2.9.5
 620     */
 621     virtual long Find(const wxString& text, wxWebViewFindFlags flags = wxWEB_VIEW_FIND_DEFAULT) = 0;
 622
 623     /**
 624         @name Zoom
 625     */
 626
 627     /**
 628         Retrieve whether the current HTML engine supports a zoom type.
 629         @param type The zoom type to test.
 630         @return Whether this type of zoom is supported by this HTML engine
 631                 (and thus can be set through SetZoomType()).
 632     */
 633     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 634
 635     /**
 636         Get the zoom factor of the page.
 637         @return The current level of zoom.
 638     */
 639     virtual wxWebViewZoom GetZoom() const = 0;
 640
 641     /**
 642         Get how the zoom factor is currently interpreted.
 643         @return How the zoom factor is currently interpreted by the HTML engine.
 644     */
 645     virtual wxWebViewZoomType GetZoomType() const = 0;
 646
 647     /**
 648         Set the zoom factor of the page.
 649         @param zoom How much to zoom (scale) the HTML document.
 650     */
 651     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 652
 653     /**
 654         Set how to interpret the zoom factor.
 655         @param zoomType How the zoom factor should be interpreted by the
 656                         HTML engine.
 657         @note invoke    CanSetZoomType() first, some HTML renderers may not
 658                         support all zoom types.
 659     */
 660     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 661 };
 662
 663
 664
 665
 666 /**
 667     @class wxWebViewEvent
 668
 669     A navigation  event holds information about events associated with
 670     wxWebView objects.
 671
 672     @beginEventEmissionTable{wxWebViewEvent}
 673     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 674        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 675        to get a resource. This event may be vetoed to prevent navigating to this
 676        resource. Note that if the displayed HTML document has several frames, one
 677        such event will be generated per frame.
 678     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 679        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 680        confirmed that a resource would be requested. This event may not be vetoed.
 681        Note that if the displayed HTML document has several frames, one such event
 682        will be generated per frame.
 683     @event{EVT_WEB_VIEW_LOADED(id, func)}
 684        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 685        is fully loaded and displayed. Note that if the displayed HTML document has
 686        several frames, one such event will be generated per frame.
 687     @event{EVT_WEB_VIEW_ERROR(id, func)}
 688        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 689        error occurs.
 690        The integer associated with this event will be a wxWebNavigationError item.
 691        The string associated with this event may contain a backend-specific more
 692        precise error message/code.
 693     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 694        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 695        window is created. You must handle this event if you want anything to
 696        happen, for example to load the page in a new window or tab.
 697     @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
 698        Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
 699        the page title changes. Use GetString to get the title.
 700     @endEventTable
 701
 702     @since 2.9.3
 703     @library{wxwebview}
 704     @category{events,webview}
 705
 706     @see wxWebView
 707 */
 708 class wxWebViewEvent : public wxNotifyEvent
 709 {
 710 public:
 711     wxWebViewEvent();
 712     wxWebViewEvent(wxEventType type, int id, const wxString href,
 713                    const wxString target);
 714
 715     /**
 716         Get the name of the target frame which the url of this event
 717         has been or will be loaded into. This may return an emptry string
 718         if the frame is not available.
 719     */
 720     const wxString& GetTarget() const;
 721
 722     /**
 723         Get the URL being visited
 724     */
 725     const wxString& GetURL() const;
 726 };
 727
 728
 729 wxEventType wxEVT_COMMAND_WEB_VIEW_NAVIGATING;
 730 wxEventType wxEVT_COMMAND_WEB_VIEW_NAVIGATED;
 731 wxEventType wxEVT_COMMAND_WEB_VIEW_LOADED;
 732 wxEventType wxEVT_COMMAND_WEB_VIEW_ERROR;
 733 wxEventType wxEVT_COMMAND_WEB_VIEW_NEWWINDOW;
 734 wxEventType wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED;