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 = 1,
  44     /** Invalid certificate */
  45     wxWEB_NAV_ERR_CERTIFICATE = 2,
  46     /** Authentication required */
  47     wxWEB_NAV_ERR_AUTH = 3,
  48     /** Other security error */
  49     wxWEB_NAV_ERR_SECURITY = 4,
  50     /** Requested resource not found */
  51     wxWEB_NAV_ERR_NOT_FOUND = 5,
  52     /** Invalid request/parameters (e.g. bad URL, bad protocol,
  53         unsupported resource type) */
  54     wxWEB_NAV_ERR_REQUEST = 6,
  55     /** The user cancelled (e.g. in a dialog) */
  56     wxWEB_NAV_ERR_USER_CANCELLED = 7,
  57     /** Another (exotic) type of error that didn't fit in other categories*/
  58     wxWEB_NAV_ERR_OTHER = 8
  59 };
  60
  61 /**
  62     Type of refresh
  63 */
  64 enum wxWebViewReloadFlags
  65 {
  66     /** Default reload, will access cache */
  67     wxWEB_VIEW_RELOAD_DEFAULT = 0,
  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 wxWebView
  94
  95     This control may be used to render web (HTML / CSS / javascript) documents.
  96     Capabilities of the HTML renderer will depend upon the backed.
  97     TODO: describe each backend and its capabilities here
  98
  99     Note that errors are generally reported asynchronously though the
 100     @c wxEVT_COMMAND_WEB_VIEW_ERROR event described below.
 101
 102     @beginEventEmissionTable{wxWebNavigationEvent}
 103     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 104        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 105        to get a resource. This event may be vetoed to prevent navigating to this
 106        resource. Note that if the displayed HTML document has several frames, one
 107        such event will be generated per frame.
 108     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 109        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 110        confirmed that a resource would be requested. This event may not be vetoed.
 111        Note that if the displayed HTML document has several frames, one such event
 112        will be generated per frame.
 113     @event{EVT_WEB_VIEW_LOADED(id, func)}
 114        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 115        is fully loaded and displayed.
 116     @event{EVT_WEB_VIEW_ERRROR(id, func)}
 117        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 118        error occurs.
 119        The integer associated with this event will be a wxWebNavigationError item.
 120        The string associated with this event may contain a backend-specific more
 121        precise error message/code.
 122     @endEventTable
 123
 124     @library{wxweb}
 125     @category{ctrl}
 126  */
 127 class wxWebView : public wxControl
 128 {
 129 public:
 130
 131     /**
 132         Creation function for two-step creation.
 133     */
 134     virtual bool Create(wxWindow* parent,
 135                         wxWindowID id,
 136                         const wxString& url,
 137                         const wxPoint& pos,
 138                         const wxSize& size,
 139                         long style,
 140                         const wxString& name) = 0;
 141
 142     /**
 143         Factory function to create a new wxWebView for two-step creation
 144         (you need to call wxWebView::Create on the returned object)
 145         @param backend which web engine to use as backend for wxWebView
 146         @return the created wxWebView, or NULL if the requested backend is
 147                 not available
 148      */
 149     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 150
 151     /**
 152         Factory function to create a new wxWebView
 153         @param parent parent window to create this view in
 154         @param id ID of this control
 155         @param url URL to load by default in the web view
 156         @param pos position to create this control at
 157                (you may use wxDefaultPosition if you use sizers)
 158         @param size size to create this control with
 159                (you may use wxDefaultSize if you use sizers)
 160         @param backend which web engine to use as backend for wxWebView
 161         @return the created wxWebView, or NULL if the requested backend
 162                 is not available
 163     */
 164     static wxWebView* New(wxWindow* parent,
 165            wxWindowID id,
 166            const wxString& url = wxWebViewDefaultURLStr,
 167            const wxPoint& pos = wxDefaultPosition,
 168            const wxSize& size = wxDefaultSize,
 169            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 170            long style = 0,
 171            const wxString& name = wxWebViewNameStr);
 172
 173
 174     /**
 175         Get whether it is possible to navigate back in the history of
 176         visited pages
 177     */
 178     virtual bool CanGoBack() = 0;
 179
 180     /**
 181         Get whether it is possible to navigate forward in the history of
 182         visited pages
 183     */
 184     virtual bool CanGoForward() = 0;
 185
 186     /**
 187         Navigate back in the history of visited pages.
 188         Only valid if CanGoBack() returned true.
 189     */
 190     virtual void GoBack() = 0;
 191
 192     /**
 193         Navigate forwardin the history of visited pages.
 194         Only valid if CanGoForward() returned true.
 195     */
 196     virtual void GoForward() = 0;
 197
 198     /**
 199         Load a HTMl document (web page) from a URL
 200         @param url the URL where the HTML document to display can be found
 201         @note web engines generally report errors asynchronously, so if you wish
 202             to know whether loading the URL was successful, register to receive
 203             navigation error events
 204     */
 205     virtual void LoadUrl(const wxString& url) = 0;
 206
 207     /**
 208         Stop the current page loading process, if any.
 209         May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
 210         TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
 211     */
 212     virtual void Stop() = 0;
 213
 214     /**
 215         Reload the currently displayed URL.
 216         @param flags A bit array that may optionnally contain reload options
 217     */
 218     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 219
 220
 221     /**
 222         Get the URL of the currently displayed document
 223     */
 224     virtual wxString GetCurrentURL() = 0;
 225
 226     /**
 227         Get the title of the current web page, or its URL/path if title is not
 228         available
 229     */
 230     virtual wxString GetCurrentTitle() = 0;
 231
 232     /**
 233         Get the HTML source code of the currently displayed document
 234         @return the HTML source code, or an empty string if no page is currently
 235                 shown
 236     */
 237     virtual wxString GetPageSource() = 0;
 238
 239     /**
 240         Get the zoom factor of the page
 241         @return How much the HTML document is zoomed (scaleed)
 242     */
 243     virtual wxWebViewZoom GetZoom() = 0;
 244
 245     /**
 246         Set the zoom factor of the page
 247         @param zoom How much to zoom (scale) the HTML document
 248     */
 249     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 250
 251     /**
 252         Set how to interpret the zoom factor
 253         @param zoomType how the zoom factor should be interpreted by the
 254                         HTML engine
 255         @note invoke    canSetZoomType() first, some HTML renderers may not
 256                         support all zoom types
 257     */
 258     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 259
 260     /**
 261         Get how the zoom factor is currently interpreted
 262         @return how the zoom factor is currently interpreted by the HTML engine
 263     */
 264     virtual wxWebViewZoomType GetZoomType() const = 0;
 265
 266     /**
 267         Retrieve whether the current HTML engine supports a type of zoom
 268         @param type the type of zoom to test
 269         @return whether this type of zoom is supported by this HTML engine
 270                 (and thus can be set through setZoomType())
 271     */
 272     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 273
 274     /**
 275         Set the displayed page source to the contents of the given string
 276         @param html    the string that contains the HTML data to display
 277         @param baseUrl URL assigned to the HTML data, to be used to resolve
 278                     relative paths, for instance
 279     */
 280     virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
 281
 282     /**
 283         Set the displayed page source to the contents of the given stream
 284         @param html    the stream to read HTML data from
 285         @param baseUrl URL assigned to the HTML data, to be used to resolve
 286                     relative paths, for instance
 287     */
 288     virtual void SetPage(wxInputStream& html, wxString baseUrl)
 289     {
 290         wxStringOutputStream stream;
 291         stream.Write(html);
 292         SetPage(stream.GetString(), baseUrl);
 293     }
 294
 295     /**
 296         Opens a print dialog so that the user may print the currently
 297         displayed page.
 298     */
 299     virtual void Print() = 0;
 300
 301     /**
 302         Returns whether the web control is currently busy (e.g. loading a page)
 303     */
 304     virtual bool IsBusy() = 0;
 305 };
 306
 307
 308
 309
 310 /**
 311     @class wxWebNavigationEvent
 312
 313     A navigation  event holds information about events associated with
 314     wxWebView objects.
 315
 316     @beginEventEmissionTable{wxWebNavigationEvent}
 317     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 318        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 319        to get a resource. This event may be vetoed to prevent navigating to this
 320        resource. Note that if the displayed HTML document has several frames, one
 321        such event will be generated per frame.
 322     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 323        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 324        confirmed that a resource would be requested. This event may not be vetoed.
 325        Note that if the displayed HTML document has several frames, one such event
 326        will be generated per frame.
 327     @event{EVT_WEB_VIEW_LOADED(id, func)}
 328        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 329        is fully loaded and displayed.
 330     @event{EVT_WEB_VIEW_ERRROR(id, func)}
 331        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 332        error occurs.
 333        The integer associated with this event will be a wxWebNavigationError item.
 334        The string associated with this event may contain a backend-specific more
 335        precise error message/code.
 336     @endEventTable
 337
 338     @library{wxweb}
 339     @category{events}
 340
 341     @see wxWebView
 342 */
 343 class wxWebNavigationEvent : public wxCommandEvent
 344 {
 345 public:
 346     wxWebNavigationEvent();
 347     wxWebNavigationEvent(wxEventType type, int id, const wxString href,
 348                          const wxString target, bool canVeto);
 349     /**
 350         Get the URL being visited
 351     */
 352     const wxString& GetHref() const { return m_href; }
 353
 354     /**
 355         Get the target (frame or window) in which the URL that caused this event
 356         is viewed, or an empty string if not available.
 357     */
 358     const wxString& GetTarget() const;
 359
 360     // default copy ctor, assignment operator and dtor are ok
 361     virtual wxEvent* Clone() const;
 362
 363     /**
 364         Get whether this event may be vetoed (stopped/prevented). Only
 365         meaningful for events fired before navigation takes place.
 366      */
 367     bool CanVeto() const;
 368
 369     /**
 370         Whether this event was vetoed (stopped/prevented). Only meaningful for
 371         events fired before navigation takes place.
 372      */
 373     bool IsVetoed() const;
 374
 375     /**
 376         Veto (prevent/stop) this event. Only meaningful for events fired
 377         before navigation takes place. Only valid if CanVeto() returned true.
 378      */
 379     void Veto();
 380 };