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