include/wx/webview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        webview.h
   3 // Purpose:     Common interface and events for web view component
   4 // Author:      Marianne Gagnon
   5 // Id:          $Id$
   6 // Copyright:   (c) 2010 Marianne Gagnon
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_WEB_VIEW_H_
  11 #define _WX_WEB_VIEW_H_
  12
  13 #include "wx/setup.h"
  14
  15 #if wxUSE_WEB
  16
  17 #include <wx/control.h>
  18 #include <wx/event.h>
  19 #include <wx/sstream.h>
  20 #include "wx/sharedptr.h"
  21 #include "wx/vector.h"
  22
  23 class WXDLLIMPEXP_WEB wxWebHistoryItem
  24 {
  25 public:
  26     wxWebHistoryItem(const wxString& url, const wxString& title) :
  27                      m_url(url), m_title(title) {}
  28     wxString GetUrl() { return m_url; }
  29     wxString GetTitle() { return m_title; }
  30
  31 private:
  32     wxString m_url, m_title;
  33 };
  34
  35 /**
  36  * Zoom level in web view component
  37  */
  38 enum wxWebViewZoom
  39 {
  40     wxWEB_VIEW_ZOOM_TINY,
  41     wxWEB_VIEW_ZOOM_SMALL,
  42     wxWEB_VIEW_ZOOM_MEDIUM,
  43     wxWEB_VIEW_ZOOM_LARGE,
  44     wxWEB_VIEW_ZOOM_LARGEST
  45 };
  46
  47 /**
  48  * The type of zooming that the web view control can perform
  49  */
  50 enum wxWebViewZoomType
  51 {
  52     /** The entire layout scales when zooming, including images */
  53     wxWEB_VIEW_ZOOM_TYPE_LAYOUT,
  54     /** Only the text changes in size when zooming, images and other layout
  55       * elements retain their initial size */
  56     wxWEB_VIEW_ZOOM_TYPE_TEXT
  57 };
  58
  59 /** Types of errors that can cause navigation to fail */
  60 enum wxWebNavigationError
  61 {
  62     /** Connection error (timeout, etc.) */
  63     wxWEB_NAV_ERR_CONNECTION,
  64     /** Invalid certificate */
  65     wxWEB_NAV_ERR_CERTIFICATE,
  66     /** Authentication required */
  67     wxWEB_NAV_ERR_AUTH,
  68     /** Other security error */
  69     wxWEB_NAV_ERR_SECURITY,
  70     /** Requested resource not found */
  71     wxWEB_NAV_ERR_NOT_FOUND,
  72     /** Invalid request/parameters (e.g. bad URL, bad protocol,
  73       * unsupported resource type) */
  74     wxWEB_NAV_ERR_REQUEST,
  75     /** The user cancelled (e.g. in a dialog) */
  76     wxWEB_NAV_ERR_USER_CANCELLED,
  77     /** Another (exotic) type of error that didn't fit in other categories*/
  78     wxWEB_NAV_ERR_OTHER
  79 };
  80
  81 /** Type of refresh */
  82 enum wxWebViewReloadFlags
  83 {
  84     /** Default reload, will access cache */
  85     wxWEB_VIEW_RELOAD_DEFAULT,
  86     /** Reload the current view without accessing the cache */
  87     wxWEB_VIEW_RELOAD_NO_CACHE
  88 };
  89
  90
  91 /**
  92  * List of available backends for wxWebView
  93  */
  94 enum wxWebViewBackend
  95 {
  96     /** Value that may be passed to wxWebView to let it pick an appropriate
  97      * engine for the current platform*/
  98     wxWEB_VIEW_BACKEND_DEFAULT,
  99
 100     /** The WebKit web engine */
 101     wxWEB_VIEW_BACKEND_WEBKIT,
 102
 103     /** Use Microsoft Internet Explorer as web engine */
 104     wxWEB_VIEW_BACKEND_IE
 105 };
 106
 107 extern WXDLLIMPEXP_DATA_WEB(const char) wxWebViewNameStr[];
 108 extern WXDLLIMPEXP_DATA_WEB(const char) wxWebViewDefaultURLStr[];
 109
 110 class WXDLLIMPEXP_WEB wxWebView : public wxControl
 111 {
 112 public:
 113
 114     /**
 115      *  Creation function for two-step creation.
 116      */
 117     virtual bool Create(wxWindow* parent,
 118            wxWindowID id,
 119            const wxString& url,
 120            const wxPoint& pos,
 121            const wxSize& size,
 122            long style,
 123            const wxString& name) = 0;
 124
 125     /**
 126      * Factory function to create a new wxWebView for two-step creation
 127      * (you need to call wxWebView::Create on the returned object)
 128      * @param backend which web engine to use as backend for wxWebView
 129      * @return the created wxWebView, or NULL if the requested backend is
 130      *         not available
 131      */
 132     static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
 133
 134     // TODO: clarify what styles can do, or remove this flag
 135     /**
 136      * Factory function to create a new wxWebView
 137      * @param parent parent window to create this view in
 138      * @param id ID of this control
 139      * @param url URL to load by default in the web view
 140      * @param pos position to create this control at
 141      *            (you may use wxDefaultPosition if you use sizers)
 142      * @param size size to create this control with
 143      *             (you may use wxDefaultSize if you use sizers)
 144      * @param backend which web engine to use as backend for wxWebView
 145      * @return the created wxWebView, or NULL if the requested backend
 146      *         is not available
 147      */
 148     static wxWebView* New(wxWindow* parent,
 149            wxWindowID id,
 150            const wxString& url = wxWebViewDefaultURLStr,
 151            const wxPoint& pos = wxDefaultPosition,
 152            const wxSize& size = wxDefaultSize,
 153            wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
 154            long style = 0,
 155            const wxString& name = wxWebViewNameStr);
 156
 157
 158     /** Get whether it is possible to navigate back in the history of
 159       * visited pages
 160       */
 161     virtual bool CanGoBack() = 0;
 162
 163     /** Get whether it is possible to navigate forward in the history of
 164       * visited pages
 165       */
 166     virtual bool CanGoForward() = 0;
 167
 168     /** Navigate back in the history of visited pages.
 169       * Only valid if CanGoBack() returned true.
 170       */
 171     virtual void GoBack() = 0;
 172
 173     /** Navigate forwardin the history of visited pages.
 174       * Only valid if CanGoForward() returned true.
 175       */
 176     virtual void GoForward() = 0;
 177
 178     /**
 179      * Load a HTMl document (web page) from a URL
 180      * @param url the URL where the HTML document to display can be found
 181      * @note web engines generally report errors asynchronously, so if you wish
 182      *       to know whether loading the URL was successful, register to receive
 183      *       navigation error events
 184      */
 185     virtual void LoadUrl(const wxString& url) = 0;
 186
 187     virtual void ClearHistory() = 0;
 188     virtual void EnableHistory(bool enable = true) = 0;
 189     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory() = 0;
 190     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory() = 0;
 191     virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item) = 0;
 192
 193     /**
 194      * Stop the current page loading process, if any.
 195      * May trigger an error event of type wxWEB_NAV_ERR_USER_CANCELLED.
 196      * TODO: make wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
 197      */
 198     virtual void Stop() = 0;
 199
 200     /**
 201      * Reload the currently displayed URL.
 202      * @param flags A bit array that may optionnally contain reload options
 203      */
 204     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 205
 206
 207     /**
 208      * Get the URL of the currently displayed document
 209      */
 210     virtual wxString GetCurrentURL() = 0;
 211
 212     /**
 213      * Get the title of the current web page, or its URL/path if title is not
 214      * available
 215      */
 216     virtual wxString GetCurrentTitle() = 0;
 217
 218     // TODO: handle choosing a frame when calling GetPageSource()?
 219     /**
 220      * Get the HTML source code of the currently displayed document
 221      * @return the HTML source code, or an empty string if no page is currently
 222      *         shown
 223      */
 224     virtual wxString GetPageSource() = 0;
 225
 226    /**
 227      * Get the zoom factor of the page
 228      * @return How much the HTML document is zoomed (scaleed)
 229      */
 230     virtual wxWebViewZoom GetZoom() = 0;
 231
 232     /**
 233      * Set the zoom factor of the page
 234      * @param zoom How much to zoom (scale) the HTML document
 235      */
 236     virtual void SetZoom(wxWebViewZoom zoom) = 0;
 237
 238     /**
 239      * Set how to interpret the zoom factor
 240      * @param zoomType how the zoom factor should be interpreted by the
 241      *                 HTML engine
 242      * @note invoke    canSetZoomType() first, some HTML renderers may not
 243      *                 support all zoom types
 244      */
 245     virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
 246
 247     /**
 248      * Get how the zoom factor is currently interpreted
 249      * @return how the zoom factor is currently interpreted by the HTML engine
 250      */
 251     virtual wxWebViewZoomType GetZoomType() const = 0;
 252
 253     /**
 254      * Retrieve whether the current HTML engine supports a type of zoom
 255      * @param type the type of zoom to test
 256      * @return whether this type of zoom is supported by this HTML engine
 257      *         (and thus can be set through setZoomType())
 258      */
 259     virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
 260
 261     // TODO: allow 'SetPage' to find files (e.g. images) from a virtual file
 262     // system if possible
 263     /**
 264      * Set the displayed page source to the contents of the given string
 265      * @param html    the string that contains the HTML data to display
 266      * @param baseUrl URL assigned to the HTML data, to be used to resolve
 267      *                relative paths, for instance
 268      */
 269     virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
 270
 271     /**
 272      * Set the displayed page source to the contents of the given stream
 273      * @param html    the stream to read HTML data from
 274      * @param baseUrl URL assigned to the HTML data, to be used to resolve
 275      *                relative paths, for instance
 276      */
 277     virtual void SetPage(wxInputStream& html, wxString baseUrl)
 278     {
 279         wxStringOutputStream stream;
 280         stream.Write(html);
 281         SetPage(stream.GetString(), baseUrl);
 282     }
 283
 284     virtual void SetEditable(bool enable = true) = 0;
 285     virtual bool IsEditable() = 0;
 286
 287     // TODO:
 288     //     wxString GetSelection();                         // maybe?
 289     //     void SetSelection(...);                          // maybe?
 290
 291     //     void EnableJavascript(bool enabled);             // maybe?
 292     //     wxString RunScript(const wxString& javascript);  // maybe?
 293
 294     //     void SetScrollPos(int pos);                      // maybe?
 295     //     int GetScrollPos();                              // maybe?
 296
 297     //     wxString GetStatusText();                        // maybe?
 298     //     void SetStatusText(wxString text);               // maybe?
 299     //     * status text changed event?
 300     //     * title changed event?
 301
 302     //    virtual bool IsOfflineMode() = 0;                 // maybe?
 303     //     virtual void SetOfflineMode(bool offline) = 0;   // maybe?
 304
 305     /**
 306      * Opens a print dialog so that the user may print the currently
 307      * displayed page.
 308      */
 309     virtual void Print() = 0;
 310
 311     /**
 312      * Returns whether the web control is currently busy (e.g. loading a page)
 313      */
 314     virtual bool IsBusy() = 0;
 315
 316     //Clipboard functions
 317     virtual bool CanCut() = 0;
 318     virtual bool CanCopy() = 0;
 319     virtual bool CanPaste() = 0;
 320     virtual void Cut() = 0;
 321     virtual void Copy() = 0;
 322     virtual void Paste() = 0;
 323
 324     //Undo / redo functionality
 325     virtual bool CanUndo() = 0;
 326     virtual bool CanRedo() = 0;
 327     virtual void Undo() = 0;
 328     virtual void Redo() = 0;
 329 };
 330
 331 class WXDLLIMPEXP_WEB wxWebNavigationEvent : public wxCommandEvent
 332 {
 333 public:
 334     wxWebNavigationEvent() {}
 335     wxWebNavigationEvent(wxEventType type, int id, const wxString href,
 336                          const wxString target, bool canVeto)
 337         : wxCommandEvent(type, id)
 338     {
 339         m_href = href;
 340         m_target = target;
 341         m_vetoed = false;
 342         m_canVeto = canVeto;
 343     }
 344
 345     /**
 346      *  Get the URL being visited
 347      */
 348     const wxString& GetHref() const { return m_href; }
 349
 350     /**
 351      * Get the target (frame or window) in which the URL that caused this event
 352      * is viewed, or an empty string if not available.
 353      */
 354     const wxString& GetTarget() const { return m_target; }
 355
 356     // default copy ctor, assignment operator and dtor are ok
 357     virtual wxEvent* Clone() const { return new wxWebNavigationEvent(*this); }
 358
 359     /** Get whether this event may be vetoed (stopped/prevented). Only
 360       *  meaningful for events fired before navigation takes place.
 361       */
 362     bool CanVeto() const { return m_canVeto; }
 363
 364     /** Whether this event was vetoed (stopped/prevented). Only meaningful for
 365      *  events fired before navigation takes place.
 366      */
 367     bool IsVetoed() const { return m_vetoed; }
 368
 369     /** Veto (prevent/stop) this event. Only meaningful for events fired
 370      *  before navigation takes place. Only valid if CanVeto() returned true.
 371      */
 372     void Veto() { wxASSERT(m_canVeto); m_vetoed = true; }
 373
 374 private:
 375     wxString m_href;
 376     wxString m_target;
 377     bool m_canVeto;
 378     bool m_vetoed;
 379
 380     wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWebNavigationEvent);
 381 };
 382
 383 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_NAVIGATING, wxWebNavigationEvent );
 384 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_NAVIGATED, wxWebNavigationEvent );
 385 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_LOADED, wxWebNavigationEvent );
 386 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_ERROR, wxWebNavigationEvent );
 387 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB, wxEVT_COMMAND_WEB_VIEW_NEWWINDOW, wxWebNavigationEvent );
 388
 389 typedef void (wxEvtHandler::*wxWebNavigationEventFunction)
 390              (wxWebNavigationEvent&);
 391
 392 #define wxWebNavigationEventHandler(func) \
 393     wxEVENT_HANDLER_CAST(wxWebNavigationEventFunction, func)
 394
 395 #define EVT_WEB_VIEW_NAVIGATING(id, fn) \
 396     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NAVIGATING, id, \
 397                      wxHtmlNavigatingEventHandler(fn))
 398
 399 #define EVT_WEB_VIEW_NAVIGATED(id, fn) \
 400     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NAVIGATED, id, \
 401                      wxHtmlNavigatingEventHandler(fn))
 402
 403 #define EVT_WEB_VIEW_LOADED(id, fn) \
 404     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_LOADED, id, \
 405                      wxHtmlNavigatingEventHandler(fn))
 406
 407 #define EVT_WEB_VIEW_ERRROR(id, fn) \
 408     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_ERROR, id, \
 409                      wxHtmlNavigatingEventHandler(fn))
 410
 411 #define EVT_WEB_VIEW_NEWWINDOW(id, fn) \
 412     wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NEWWINDOW, id, \
 413                      wxHtmlNavigatingEventHandler(fn))
 414
 415 #endif // wxUSE_WEB
 416
 417 #endif // _WX_WEB_VIEW_H_