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