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