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