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