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