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 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     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 123        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 124        window is created. This event may be vetoed to prevent a new window showing,
 125        for example if you want to open the url in the existing window or a new tab.
 126     @endEventTable
 127
 128     @library{wxweb}
 129     @category{ctrl}
 130  */
 131 class wxWebView : public wxControl
 132 {
 133 public:
 134
 135     /**
 136         Creation function for two-step creation.
 137     */
 138     virtual bool Create(wxWindow* parent,
 139                         wxWindowID id,
 140                         const wxString& url,
 141                         const wxPoint& pos,
 142                         const wxSize& size,
 143                         long style,
 144                         const wxString& name) = 0;
 145
 146     /**
 147         Factory function to create a new wxWebView for two-step creation
 148         (you need to call wxWebView::Create on the returned object)
 149         @param backend which web engine to use as backend for wxWebView
 150         @return the created wxWebView, or NULL if the requested backend is
 151                 not available
 152      */
 153     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 154
 155     /**
 156         Factory function to create a new wxWebView
 157         @param parent parent window to create this view in
 158         @param id ID of this control
 159         @param url URL to load by default in the web view
 160         @param pos position to create this control at
 161                (you may use wxDefaultPosition if you use sizers)
 162         @param size size to create this control with
 163                (you may use wxDefaultSize if you use sizers)
 164         @param backend which web engine to use as backend for wxWebView
 165         @return the created wxWebView, or NULL if the requested backend
 166                 is not available
 167     */
 168     static wxWebView* New(wxWindow* parent,
 169            wxWindowID id,
 170            const wxString& url = wxWebViewDefaultURLStr,
 171            const wxPoint& pos = wxDefaultPosition,
 172            const wxSize& size = wxDefaultSize,
 173            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 174            long style = 0,
 175            const wxString& name = wxWebViewNameStr);
 176
 177
 178     /**
 179         Get whether it is possible to navigate back in the history of
 180         visited pages
 181     */
 182     virtual bool CanGoBack() = 0;
 183
 184     /**
 185         Get whether it is possible to navigate forward in the history of
 186         visited pages
 187     */
 188     virtual bool CanGoForward() = 0;
 189
 190     /**
 191         Navigate back in the history of visited pages.
 192         Only valid if CanGoBack() returned true.
 193     */
 194     virtual void GoBack() = 0;
 195
 196     /**
 197         Navigate forwardin the history of visited pages.
 198         Only valid if CanGoForward() returned true.
 199     */
 200     virtual void GoForward() = 0;
 201
 202     /**
 203         Clear the history, this will also remove the visible page.
 204     */
 205     virtual void ClearHistory() = 0;
 206
 207     /**
 208         Enable or disable the history. This will also clear the history.
 209     */
 210     virtual void EnableHistory(bool enable = true) = 0;
 211
 212     /**
 213         Load a HTMl document (web page) from a URL
 214         @param url the URL where the HTML document to display can be found
 215         @note web engines generally report errors asynchronously, so if you wish
 216             to know whether loading the URL was successful, register to receive
 217             navigation error events
 218     */
 219     virtual void LoadUrl(const wxString& url) = 0;
 220
 221     /**
 222         Stop the current page loading process, if any.
 223         May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
 224         TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
 225     */
 226     virtual void Stop() = 0;
 227
 228     /**
 229         Reload the currently displayed URL.
 230         @param flags A bit array that may optionnally contain reload options
 231     */
 232     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 233
 234
 235     /**
 236         Get the URL of the currently displayed document
 237     */
 238     virtual wxString GetCurrentURL() = 0;
 239
 240     /**
 241         Get the title of the current web page, or its URL/path if title is not
 242         available
 243     */
 244     virtual wxString GetCurrentTitle() = 0;
 245
 246     /**
 247         Get the HTML source code of the currently displayed document
 248         @return the HTML source code, or an empty string if no page is currently
 249                 shown
 250     */
 251     virtual wxString GetPageSource() = 0;
 252
 253     /**
 254         Get the zoom factor of the page
 255         @return How much the HTML document is zoomed (scaleed)
 256     */
 257     virtual wxWebViewZoom GetZoom() = 0;
 258
 259     /**
 260         Set the zoom factor of the page
 261         @param zoom How much to zoom (scale) the HTML document
 262     */
 263     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 264
 265     /**
 266         Set how to interpret the zoom factor
 267         @param zoomType how the zoom factor should be interpreted by the
 268                         HTML engine
 269         @note invoke    canSetZoomType() first, some HTML renderers may not
 270                         support all zoom types
 271     */
 272     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 273
 274     /**
 275         Get how the zoom factor is currently interpreted
 276         @return how the zoom factor is currently interpreted by the HTML engine
 277     */
 278     virtual wxWebViewZoomType GetZoomType() const = 0;
 279
 280     /**
 281         Retrieve whether the current HTML engine supports a type of zoom
 282         @param type the type of zoom to test
 283         @return whether this type of zoom is supported by this HTML engine
 284                 (and thus can be set through setZoomType())
 285     */
 286     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 287
 288     /**
 289         Set the displayed page source to the contents of the given string
 290         @param html    the string that contains the HTML data to display
 291         @param baseUrl URL assigned to the HTML data, to be used to resolve
 292                     relative paths, for instance
 293     */
 294     virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
 295
 296     /**
 297         Set the displayed page source to the contents of the given stream
 298         @param html    the stream to read HTML data from
 299         @param baseUrl URL assigned to the HTML data, to be used to resolve
 300                     relative paths, for instance
 301     */
 302     virtual void SetPage(wxInputStream& html, wxString baseUrl)
 303     {
 304         wxStringOutputStream stream;
 305         stream.Write(html);
 306         SetPage(stream.GetString(), baseUrl);
 307     }
 308
 309     /**
 310         Opens a print dialog so that the user may print the currently
 311         displayed page.
 312     */
 313     virtual void Print() = 0;
 314
 315     /**
 316         Returns whether the web control is currently busy (e.g. loading a page)
 317     */
 318     virtual bool IsBusy() = 0;
 319 };
 320
 321
 322
 323
 324 /**
 325     @class wxWebNavigationEvent
 326
 327     A navigation  event holds information about events associated with
 328     wxWebView objects.
 329
 330     @beginEventEmissionTable{wxWebNavigationEvent}
 331     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
 332        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
 333        to get a resource. This event may be vetoed to prevent navigating to this
 334        resource. Note that if the displayed HTML document has several frames, one
 335        such event will be generated per frame.
 336     @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
 337        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
 338        confirmed that a resource would be requested. This event may not be vetoed.
 339        Note that if the displayed HTML document has several frames, one such event
 340        will be generated per frame.
 341     @event{EVT_WEB_VIEW_LOADED(id, func)}
 342        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
 343        is fully loaded and displayed.
 344     @event{EVT_WEB_VIEW_ERRROR(id, func)}
 345        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
 346        error occurs.
 347        The integer associated with this event will be a wxWebNavigationError item.
 348        The string associated with this event may contain a backend-specific more
 349        precise error message/code.
 350     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
 351        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
 352        window is created. This event may be vetoed to prevent a new window showing,
 353        for example if you want to open the url in the existing window or a new tab.
 354     @endEventTable
 355
 356     @library{wxweb}
 357     @category{events}
 358
 359     @see wxWebView
 360 */
 361 class wxWebNavigationEvent : public wxCommandEvent
 362 {
 363 public:
 364     wxWebNavigationEvent();
 365     wxWebNavigationEvent(wxEventType type, int id, const wxString href,
 366                          const wxString target, bool canVeto);
 367     /**
 368         Get the URL being visited
 369     */
 370     const wxString& GetHref() const { return m_href; }
 371
 372     /**
 373         Get the target (frame or window) in which the URL that caused this event
 374         is viewed, or an empty string if not available.
 375     */
 376     const wxString& GetTarget() const;
 377
 378     virtual wxEvent* Clone() const;
 379
 380     /**
 381         Get whether this event may be vetoed (stopped/prevented). Only
 382         meaningful for events fired before navigation takes place or new
 383         window events.
 384      */
 385     bool CanVeto() const;
 386
 387     /**
 388         Whether this event was vetoed (stopped/prevented). Only meaningful for
 389         events fired before navigation takes place or new window events.
 390      */
 391     bool IsVetoed() const;
 392
 393     /**
 394         Veto (prevent/stop) this event. Only meaningful for events fired
 395         before navigation takes place or new window events. Only valid
 396         if CanVeto() returned true.
 397      */
 398     void Veto();
 399 };