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 wxWebView
 121
 122     This control may be used to render web (HTML / CSS / javascript) documents.
 123     Capabilities of the HTML renderer will depend upon the backed.
 124
 125     @c wxWEB_VIEW_BACKEND_IE uses the the Trident rendering engine, which
 126     is also used by Internet Explorer. It is important to note that by default
 127     it emulates Internet Explorer 7, this can be chaged with a registry
 128     setting, see
 129     <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
 130     this</a> article for more information.
 131
 132     Note that errors are generally reported asynchronously though the
 133     @c wxEVT_COMMAND_WEB_VIEW_ERROR event described below.
 134
 135     @beginEventEmissionTable{wxWebNavigationEvent}
 136     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 137        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 138        to get a resource. This event may be vetoed to prevent navigating to this
 139        resource. Note that if the displayed HTML document has several frames, one
 140        such event will be generated per frame.
 141     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 142        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 143        confirmed that a resource would be requested. This event may not be vetoed.
 144        Note that if the displayed HTML document has several frames, one such event
 145        will be generated per frame.
 146     @event{EVT_WEB_VIEW_LOADED(id, func)}
 147        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 148        is fully loaded and displayed. Note that if the displayed HTML document has
 149        several frames, one such event will be generated per frame.
 150     @event{EVT_WEB_VIEW_ERRROR(id, func)}
 151        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 152        error occurs.
 153        The integer associated with this event will be a wxWebNavigationError item.
 154        The string associated with this event may contain a backend-specific more
 155        precise error message/code.
 156     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 157        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 158        window is created. This event may be vetoed to prevent a new window showing,
 159        for example if you want to open the url in the existing window or a new tab.
 160     @endEventTable
 161
 162     @library{wxweb}
 163     @category{ctrl,web}
 164  */
 165 class wxWebView : public wxControl
 166 {
 167 public:
 168
 169     /**
 170         Creation function for two-step creation.
 171     */
 172     virtual bool Create(wxWindow* parent,
 173                         wxWindowID id,
 174                         const wxString& url,
 175                         const wxPoint& pos,
 176                         const wxSize& size,
 177                         long style,
 178                         const wxString& name) = 0;
 179
 180     /**
 181         Factory function to create a new wxWebView for two-step creation
 182         (you need to call wxWebView::Create on the returned object)
 183         @param backend which web engine to use as backend for wxWebView
 184         @return the created wxWebView, or NULL if the requested backend is
 185                 not available
 186      */
 187     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 188
 189     /**
 190         Factory function to create a new wxWebView
 191         @param parent parent window to create this view in
 192         @param id ID of this control
 193         @param url URL to load by default in the web view
 194         @param pos position to create this control at
 195                (you may use wxDefaultPosition if you use sizers)
 196         @param size size to create this control with
 197                (you may use wxDefaultSize if you use sizers)
 198         @param backend which web engine to use as backend for wxWebView
 199         @return the created wxWebView, or NULL if the requested backend
 200                 is not available
 201     */
 202     static wxWebView* New(wxWindow* parent,
 203            wxWindowID id,
 204            const wxString& url = wxWebViewDefaultURLStr,
 205            const wxPoint& pos = wxDefaultPosition,
 206            const wxSize& size = wxDefaultSize,
 207            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 208            long style = 0,
 209            const wxString& name = wxWebViewNameStr);
 210
 211     /**
 212         Get the title of the current web page, or its URL/path if title is not
 213         available.
 214     */
 215     virtual wxString GetCurrentTitle() = 0;
 216
 217    /**
 218         Get the URL of the currently displayed document.
 219     */
 220     virtual wxString GetCurrentURL() = 0;
 221
 222     /**
 223         Get the HTML source code of the currently displayed document.
 224         @return The HTML source code, or an empty string if no page is currently
 225                 shown.
 226     */
 227     virtual wxString GetPageSource() = 0;
 228
 229     /**
 230         Get the text of the current page.
 231     */
 232     virtual wxString GetPageText() = 0;
 233
 234     /**
 235         Returns whether the web control is currently busy (e.g. loading a page).
 236     */
 237     virtual bool IsBusy() = 0;
 238
 239     /**
 240         Returns whether the web control is currently editable
 241     */
 242     virtual bool IsEditable() = 0;
 243
 244     /**
 245         Load a web page from a URL
 246         @param url The URL of the page to be loaded.
 247         @note Web engines generally report errors asynchronously, so if you wish
 248             to know whether loading the URL was successful, register to receive
 249             navigation error events.
 250     */
 251     virtual void LoadUrl(const wxString& url) = 0;
 252
 253     /**
 254         Opens a print dialog so that the user may print the currently
 255         displayed page.
 256     */
 257     virtual void Print() = 0;
 258
 259     /**
 260         Reload the currently displayed URL.
 261         @param flags A bit array that may optionally contain reload options.
 262     */
 263     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 264
 265     /**
 266         Runs the given javascript code.
 267     */
 268     virtual void RunScript(const wxString& javascript) = 0;
 269
 270     /**
 271         Set the editable property of the web control. Enabling allows the user
 272         to edit the page even if the @c contenteditable attribute is not set.
 273         The exact capabilities vary with the backend being used.
 274     */
 275     virtual void SetEditable(bool enable = true) = 0;
 276
 277     /**
 278         Set the displayed page source to the contents of the given string.
 279         @param html    The string that contains the HTML data to display.
 280         @param baseUrl URL assigned to the HTML data, to be used to resolve
 281                     relative paths, for instance.
 282     */
 283     virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
 284
 285     /**
 286         Set the displayed page source to the contents of the given stream.
 287         @param html    The stream to read HTML data from.
 288         @param baseUrl URL assigned to the HTML data, to be used to resolve
 289                     relative paths, for instance.
 290     */
 291     virtual void SetPage(wxInputStream& html, wxString baseUrl);
 292
 293     /**
 294         Stop the current page loading process, if any.
 295         May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
 296         TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
 297     */
 298     virtual void Stop() = 0;
 299
 300     /**
 301         @name Clipboard
 302     */
 303
 304     /**
 305         Returns @true if the current selection can be copied.
 306     */
 307     virtual bool CanCopy() = 0;
 308
 309     /**
 310         Returns @true if the current selection can be cut.
 311     */
 312     virtual bool CanCut() = 0;
 313
 314     /**
 315         Returns @true if data can be pasted.
 316     */
 317     virtual bool CanPaste() = 0;
 318
 319     /**
 320         Copies the current selection.
 321     */
 322     virtual void Copy() = 0;
 323
 324     /**
 325         Cuts the current selection.
 326     */
 327     virtual void Cut() = 0;
 328
 329     /**
 330         Pastes the current data.
 331     */
 332     virtual void Paste() = 0;
 333
 334     /**
 335         @name History
 336     */
 337
 338     /**
 339         Returns @true if it is possible to navigate backward in the history of
 340         visited pages.
 341     */
 342     virtual bool CanGoBack() = 0;
 343
 344     /**
 345         Returns @true if it is possible to navigate forward in the history of
 346         visited pages.
 347     */
 348     virtual bool CanGoForward() = 0;
 349
 350     /**
 351         Clear the history, this will also remove the visible page.
 352     */
 353     virtual void ClearHistory() = 0;
 354
 355     /**
 356         Enable or disable the history. This will also clear the history.
 357     */
 358     virtual void EnableHistory(bool enable = true) = 0;
 359
 360     /**
 361         Returns a list of items in the back history. The first item in the
 362         vector is the first page that was loaded by the control.
 363     */
 364     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory() = 0;
 365
 366     /**
 367         Returns a list of items in the forward history. The first item in the
 368         vector is the next item in the history with respect to the curently
 369         loaded page.
 370     */
 371     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory() = 0;
 372
 373     /**
 374         Navigate back in the history of visited pages.
 375         Only valid if CanGoBack() returns true.
 376     */
 377     virtual void GoBack() = 0;
 378
 379     /**
 380         Navigate forward in the history of visited pages.
 381         Only valid if CanGoForward() returns true.
 382     */
 383     virtual void GoForward() = 0;
 384
 385     /**
 386         Loads a history item.
 387     */
 388     virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item) = 0;
 389
 390     /**
 391         @name Selection
 392     */
 393
 394     /**
 395         Clears the current selection.
 396     */
 397     virtual void ClearSelection() = 0;
 398
 399     /**
 400         Deletes the current selection. Note that for @c wxWEB_VIEW_BACKEND_WEBKIT
 401         the selection must be editable, either through SetEditable or the
 402         correct HTML attribute.
 403     */
 404     virtual void DeleteSelection() = 0;
 405
 406     /**
 407         Returns the currently selected source, if any.
 408     */
 409     virtual wxString GetSelectedSource() = 0;
 410
 411     /**
 412         Returns the currently selected text, if any.
 413     */
 414     virtual wxString GetSelectedText() = 0;
 415
 416     /**
 417         Returns @true if there is a current selection.
 418     */
 419     virtual bool HasSelection() = 0;
 420
 421     /**
 422         Selects the entire page.
 423     */
 424     virtual void SelectAll() = 0;
 425
 426     /**
 427         @name Undo / Redo
 428     */
 429
 430     /**
 431         Returns @true if there is an action to redo.
 432     */
 433     virtual bool CanRedo() = 0;
 434
 435     /**
 436         Returns @true if there is an action to undo.
 437     */
 438     virtual bool CanUndo() = 0;
 439
 440     /**
 441         Redos the last action.
 442     */
 443     virtual void Redo() = 0;
 444
 445     /**
 446         Undos the last action.
 447     */
 448     virtual void Undo() = 0;
 449
 450     /**
 451         @name Zoom
 452     */
 453
 454     /**
 455         Retrieve whether the current HTML engine supports a zoom type.
 456         @param type The zoom type to test.
 457         @return Whether this type of zoom is supported by this HTML engine
 458                 (and thus can be set through SetZoomType()).
 459     */
 460     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 461
 462     /**
 463         Get the zoom factor of the page.
 464         @return The current level of zoom.
 465     */
 466     virtual wxWebViewZoom GetZoom() = 0;
 467
 468     /**
 469         Get how the zoom factor is currently interpreted.
 470         @return How the zoom factor is currently interpreted by the HTML engine.
 471     */
 472     virtual wxWebViewZoomType GetZoomType() const = 0;
 473
 474     /**
 475         Set the zoom factor of the page.
 476         @param zoom How much to zoom (scale) the HTML document.
 477     */
 478     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 479
 480     /**
 481         Set how to interpret the zoom factor.
 482         @param zoomType How the zoom factor should be interpreted by the
 483                         HTML engine.
 484         @note invoke    CanSetZoomType() first, some HTML renderers may not
 485                         support all zoom types.
 486     */
 487     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 488 };
 489
 490
 491
 492
 493 /**
 494     @class wxWebNavigationEvent
 495
 496     A navigation  event holds information about events associated with
 497     wxWebView objects.
 498
 499     @beginEventEmissionTable{wxWebNavigationEvent}
 500     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 501        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 502        to get a resource. This event may be vetoed to prevent navigating to this
 503        resource. Note that if the displayed HTML document has several frames, one
 504        such event will be generated per frame.
 505     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 506        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 507        confirmed that a resource would be requested. This event may not be vetoed.
 508        Note that if the displayed HTML document has several frames, one such event
 509        will be generated per frame.
 510     @event{EVT_WEB_VIEW_LOADED(id, func)}
 511        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 512        is fully loaded and displayed. Note that if the displayed HTML document has
 513        several frames, one such event will be generated per frame.
 514     @event{EVT_WEB_VIEW_ERRROR(id, func)}
 515        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 516        error occurs.
 517        The integer associated with this event will be a wxWebNavigationError item.
 518        The string associated with this event may contain a backend-specific more
 519        precise error message/code.
 520     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 521        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 522        window is created. This event may be vetoed to prevent a new window showing,
 523        for example if you want to open the url in the existing window or a new tab.
 524     @endEventTable
 525
 526     @library{wxweb}
 527     @category{events,web}
 528
 529     @see wxWebView
 530 */
 531 class wxWebNavigationEvent : public wxCommandEvent
 532 {
 533 public:
 534     wxWebNavigationEvent();
 535     wxWebNavigationEvent(wxEventType type, int id, const wxString href,
 536                          const wxString target, bool canVeto);
 537     /**
 538         Get the URL being visited
 539     */
 540     const wxString& GetHref() const { return m_href; }
 541
 542     /**
 543         Get the target (frame or window) in which the URL that caused this event
 544         is viewed, or an empty string if not available.
 545     */
 546     const wxString& GetTarget() const;
 547
 548     virtual wxEvent* Clone() const;
 549
 550     /**
 551         Get whether this event may be vetoed (stopped/prevented). Only
 552         meaningful for events fired before navigation takes place or new
 553         window events.
 554      */
 555     bool CanVeto() const;
 556
 557     /**
 558         Whether this event was vetoed (stopped/prevented). Only meaningful for
 559         events fired before navigation takes place or new window events.
 560      */
 561     bool IsVetoed() const;
 562
 563     /**
 564         Veto (prevent/stop) this event. Only meaningful for events fired
 565         before navigation takes place or new window events. Only valid
 566         if CanVeto() returned true.
 567      */
 568     void Veto();
 569 };