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