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