synchronize GTK2 minimum version in docs

[wxWidgets.git] / interface / wx / webview.h

diff --git a/interface/wx/webview.h b/interface/wx/webview.h
index 68dba70a3f5364868ea04ba2d84775d2d670e50b..20e914e3a58e28c3a5403f418d3eb7e841f97704 100644 (file)
--- a/interface/wx/webview.h
+++ b/interface/wx/webview.h
@@ -7,7 +7,7 @@
 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**

-    Zoom levels availiable in wxWebView
+    Zoom levels available in wxWebView

 */
 enum wxWebViewZoom
 {
 */
 enum wxWebViewZoom
 {


@@ -23,21 +23,21 @@ enum wxWebViewZoom
 */
 enum wxWebViewZoomType
 {
 */
 enum wxWebViewZoomType
 {

-    /** 
-        The entire layout scales when zooming, including images 
+    /**
+        The entire layout scales when zooming, including images

     */
     wxWEB_VIEW_ZOOM_TYPE_LAYOUT,
     */
     wxWEB_VIEW_ZOOM_TYPE_LAYOUT,

-    /** 
+    /**

         Only the text changes in size when zooming, images and other layout
         Only the text changes in size when zooming, images and other layout

-        elements retain their initial size 
+        elements retain their initial size

     */
     wxWEB_VIEW_ZOOM_TYPE_TEXT
 };
 
     */
     wxWEB_VIEW_ZOOM_TYPE_TEXT
 };
 

-/** 
+/**

     Types of errors that can cause navigation to fail
 */
     Types of errors that can cause navigation to fail
 */

-enum wxWebNavigationError
+enum wxWebViewNavigationError

 {
     /** Connection error (timeout, etc.) */
     wxWEB_NAV_ERR_CONNECTION,
 {
     /** Connection error (timeout, etc.) */
     wxWEB_NAV_ERR_CONNECTION,


@@ -58,18 +58,17 @@ enum wxWebNavigationError
     wxWEB_NAV_ERR_OTHER
 };
 
     wxWEB_NAV_ERR_OTHER
 };
 

-/** 
-    Type of refresh 
+/**
+    Type of refresh

 */
 enum wxWebViewReloadFlags
 {
     /** Default reload, will access cache */
     wxWEB_VIEW_RELOAD_DEFAULT,
     /** Reload the current view without accessing the cache */
 */
 enum wxWebViewReloadFlags
 {
     /** Default reload, will access cache */
     wxWEB_VIEW_RELOAD_DEFAULT,
     /** Reload the current view without accessing the cache */

-    wxWEB_VIEW_RELOAD_NO_CACHE 
+    wxWEB_VIEW_RELOAD_NO_CACHE

 };
 
 };
 

-

 /**
  * List of available backends for wxWebView
  */
 /**
  * List of available backends for wxWebView
  */


@@ -79,55 +78,141 @@ enum wxWebViewBackend
      * engine for the current platform*/
     wxWEB_VIEW_BACKEND_DEFAULT,
 
      * engine for the current platform*/
     wxWEB_VIEW_BACKEND_DEFAULT,
 

-    /** The OSX-native WebKit web engine */
-    wxWEB_VIEW_BACKEND_OSX_WEBKIT,
-
-    /** The GTK port of the WebKit engine */
-    wxWEB_VIEW_BACKEND_GTK_WEBKIT,
+    /** The WebKit web engine */
+    wxWEB_VIEW_BACKEND_WEBKIT,

 
     /** Use Microsoft Internet Explorer as web engine */
     wxWEB_VIEW_BACKEND_IE
 };
 
 /**
 
     /** Use Microsoft Internet Explorer as web engine */
     wxWEB_VIEW_BACKEND_IE
 };
 
 /**

-    @class wxWebHistoryItem
-  
+    @class wxWebViewHistoryItem
+

     A simple class that contains the URL and title of an element of the history
     A simple class that contains the URL and title of an element of the history

-    of a wxWebView. 
-   
-    @library{wxweb}
-    @category{ctrl}
+    of a wxWebView.
+
+    @since 2.9.3
+    @library{wxwebview}
+    @category{webview}
+
+    @see wxWebView

  */
  */

-class wxWebHistoryItem
+class wxWebViewHistoryItem

 {
 public:
     /**
         Construtor.
     */
 {
 public:
     /**
         Construtor.
     */

-    wxWebHistoryItem(const wxString& url, const wxString& title);
-    
+    wxWebViewHistoryItem(const wxString& url, const wxString& title);
+

     /**
         @return The url of the page.
     */
     wxString GetUrl();
     /**
         @return The url of the page.
     */
     wxString GetUrl();

-    
+

     /**
         @return The title of the page.
     */
     wxString GetTitle();
 };
 
     /**
         @return The title of the page.
     */
     wxString GetTitle();
 };
 

+/**
+    @class wxWebViewHandler
+
+    The base class for handling custom schemes in wxWebView, for example to
+    allow virtual file system support.
+
+    @since 2.9.3
+    @library{wxwebview}
+    @category{webview}
+
+    @see wxWebView
+ */
+class wxWebViewHandler
+{
+public:
+    /**
+        Constructor. Takes the name of the scheme that will be handled by this
+        class for example @c file or @c zip.
+    */
+    wxWebViewHandler(const wxString& scheme);
+
+    /**
+        @return A pointer to the file represented by @c uri.
+    */
+    virtual wxFSFile* GetFile(const wxString &uri) = 0;
+
+    /**
+        @return The name of the scheme, as passed to the constructor.
+    */
+    virtual wxString GetName() const;
+};
+

 /**
     @class wxWebView
 /**
     @class wxWebView

-  
+

     This control may be used to render web (HTML / CSS / javascript) documents.
     This control may be used to render web (HTML / CSS / javascript) documents.

-    Capabilities of the HTML renderer will depend upon the backed.
-    TODO: describe each backend and its capabilities here
-  
-    Note that errors are generally reported asynchronously though the
-    @c wxEVT_COMMAND_WEB_VIEW_ERROR event described below.
-  
-    @beginEventEmissionTable{wxWebNavigationEvent}
+    It is designed to allow the creation of multiple backends for each port,
+    although currently just one is available. It differs from wxHtmlWindow in
+    that each backend is actually a full rendering engine, Trident on MSW and
+    Webkit on OSX and GTK. This allows the correct viewing complex pages with
+    javascript and css.
+
+    @section descriptions Backend Descriptions
+
+    @par wxWEB_VIEW_BACKEND_IE (MSW)
+
+    The IE backend uses Microsoft's Trident rendering engine, specifically the
+    version used by the locally installed copy of Internet Explorer. As such it
+    is only available for the MSW port. By default recent versions of the
+    <a href="http://msdn.microsoft.com/en-us/library/aa752085%28v=VS.85%29.aspx">WebBrowser</a>
+    control, which this backend uses, emulate Internet Explorer 7. This can be
+    changed with a registry setting, see
+    <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
+    this</a> article for more information. This backend has full support for
+    custom schemes and virtual file systems.
+
+    @par wxWEB_VIEW_WEBKIT (GTK)
+
+    Under GTK the WebKit backend uses
+    <a href="http://webkitgtk.org/">WebKitGTK+</a>. The current minimum version
+    required is 1.3.1 which ships by default with Ubuntu Natty and Debian
+    Wheezy and has the package name libwebkitgtk-dev. Custom schemes and
+    virtual files systems are supported under this backend, however embedded
+    resources such as images and stylesheets are currently loaded using the
+    data:// scheme.
+
+    @par wxWEB_VIEW_WEBKIT (OSX)
+
+    The OSX WebKit backend uses Apple's
+    <a href="http://developer.apple.com/library/mac/#documentation/Cocoa/Reference/WebKit/Classes/WebView_Class/Reference/Reference.html#//apple_ref/doc/uid/20001903">WebView</a>
+    class. This backend has full support for custom schemes and virtual file
+    systems.
+
+    @section async Asynchronous Notifications
+
+    Many of the methods in wxWebView are asynchronous, i.e. they return
+    immediately and perform their work in the background. This includes
+    functions such as LoadUrl() and Reload(). To receive notification of the
+    progress and completion of these functions you need to handle the events
+    that are provided. Specifically @c wxEVT_COMMAND_WEB_VIEW_LOADED notifies
+    when the page or a sub-frame has finished loading and
+    @c wxEVT_COMMAND_WEB_VIEW_ERROR notifies that an error has occurred.
+
+    @section vfs Virtual File Systems and Custom Schemes
+
+    wxWebView supports the registering of custom scheme handlers, for example
+    @c file or @c http. To do this create a new class which inherits from
+    wxWebViewHandler, where wxWebHandler::GetFile() returns a pointer to a
+    wxFSFile which represents the given url. You can then register your handler
+    with RegisterHandler() it will be called for all pages and resources.
+
+    wxWebFileHandler is provided to allow the navigation of pages inside a zip
+    archive. It overrides the @c file scheme and provides support for the
+    standard @c file syntax as well as paths to archives of the form
+    @c file:///C:/example/docs.zip;protocol=zip/main.htm
+
+    @beginEventEmissionTable{wxWebViewEvent}

     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
        to get a resource. This event may be vetoed to prevent navigating to this
     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
        to get a resource. This event may be vetoed to prevent navigating to this


@@ -140,8 +225,9 @@ public:
        will be generated per frame.
     @event{EVT_WEB_VIEW_LOADED(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
        will be generated per frame.
     @event{EVT_WEB_VIEW_LOADED(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document

-       is fully loaded and displayed.
-    @event{EVT_WEB_VIEW_ERRROR(id, func)}
+       is fully loaded and displayed. Note that if the displayed HTML document has
+       several frames, one such event will be generated per frame.
+    @event{EVT_WEB_VIEW_ERROR(id, func)}

        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
        error occurs.
        The integer associated with this event will be a wxWebNavigationError item.
        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
        error occurs.
        The integer associated with this event will be a wxWebNavigationError item.


@@ -149,12 +235,17 @@ public:
        precise error message/code.
     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
        precise error message/code.
     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new

-       window is created. This event may be vetoed to prevent a new window showing,
-       for example if you want to open the url in the existing window or a new tab.
+       window is created. You must handle this event if you want anything to
+       happen, for example to load the page in a new window or tab.
+    @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
+       Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
+       the page title changes. Use GetString to get the title.

     @endEventTable
     @endEventTable

-   
-    @library{wxweb}
-    @category{ctrl}
+
+    @since 2.9.3
+    @library{wxwebview}
+    @category{ctrl,webview}
+    @see wxWebViewHandler, wxWebViewEvent

  */
 class wxWebView : public wxControl
 {
  */
 class wxWebView : public wxControl
 {


@@ -165,11 +256,11 @@ public:
     */
     virtual bool Create(wxWindow* parent,
                         wxWindowID id,
     */
     virtual bool Create(wxWindow* parent,
                         wxWindowID id,

-                        const wxString& url,
-                        const wxPoint& pos,
-                        const wxSize& size,
-                        long style,
-                        const wxString& name) = 0;
+                        const wxString& url = wxWebViewDefaultURLStr,
+                        const wxPoint& pos = wxDefaultPosition,
+                        const wxSize& size = wxDefaultSize,
+                        long style = 0,
+                        const wxString& name = wxWebViewNameStr) = 0;

 
     /**
         Factory function to create a new wxWebView for two-step creation
 
     /**
         Factory function to create a new wxWebView for two-step creation


@@ -206,24 +297,34 @@ public:
         Get the title of the current web page, or its URL/path if title is not
         available.
     */
         Get the title of the current web page, or its URL/path if title is not
         available.
     */

-    virtual wxString GetCurrentTitle() = 0;
+    virtual wxString GetCurrentTitle() const = 0;

 
    /**
         Get the URL of the currently displayed document.
     */
 
    /**
         Get the URL of the currently displayed document.
     */

-    virtual wxString GetCurrentURL() = 0;
+    virtual wxString GetCurrentURL() const = 0;

 
     /**
         Get the HTML source code of the currently displayed document.
         @return The HTML source code, or an empty string if no page is currently
                 shown.
     */
 
     /**
         Get the HTML source code of the currently displayed document.
         @return The HTML source code, or an empty string if no page is currently
                 shown.
     */

-    virtual wxString GetPageSource() = 0;
-    
+    virtual wxString GetPageSource() const = 0;
+
+    /**
+        Get the text of the current page.
+    */
+    virtual wxString GetPageText() const = 0;
+

     /**
         Returns whether the web control is currently busy (e.g. loading a page).
     */
     /**
         Returns whether the web control is currently busy (e.g. loading a page).
     */

-    virtual bool IsBusy() = 0;          
+    virtual bool IsBusy() const = 0;
+
+    /**
+        Returns whether the web control is currently editable
+    */
+    virtual bool IsEditable() const = 0;

 
     /**
         Load a web page from a URL
 
     /**
         Load a web page from a URL


@@ -232,7 +333,7 @@ public:
             to know whether loading the URL was successful, register to receive
             navigation error events.
     */
             to know whether loading the URL was successful, register to receive
             navigation error events.
     */

-    virtual void LoadUrl(const wxString& url) = 0;
+    virtual void LoadURL(const wxString& url) = 0;

 
     /**
         Opens a print dialog so that the user may print the currently
 
     /**
         Opens a print dialog so that the user may print the currently


@@ -240,12 +341,30 @@ public:
     */
     virtual void Print() = 0;
 
     */
     virtual void Print() = 0;
 

+    /**
+        Registers a custom scheme handler.
+        @param handler A shared pointer to a wxWebHandler.
+    */
+    virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
+

     /**
         Reload the currently displayed URL.
         @param flags A bit array that may optionally contain reload options.
     */
     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 
     /**
         Reload the currently displayed URL.
         @param flags A bit array that may optionally contain reload options.
     */
     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
 

+    /**
+        Runs the given javascript code.
+    */
+    virtual void RunScript(const wxString& javascript) = 0;
+
+    /**
+        Set the editable property of the web control. Enabling allows the user
+        to edit the page even if the @c contenteditable attribute is not set.
+        The exact capabilities vary with the backend being used.
+    */
+    virtual void SetEditable(bool enable = true) = 0;
+

     /**
         Set the displayed page source to the contents of the given string.
         @param html    The string that contains the HTML data to display.
     /**
         Set the displayed page source to the contents of the given string.
         @param html    The string that contains the HTML data to display.


@@ -260,12 +379,7 @@ public:
         @param baseUrl URL assigned to the HTML data, to be used to resolve
                     relative paths, for instance.
     */
         @param baseUrl URL assigned to the HTML data, to be used to resolve
                     relative paths, for instance.
     */

-    virtual void SetPage(wxInputStream& html, wxString baseUrl)
-    {
-        wxStringOutputStream stream;
-        stream.Write(html);
-        SetPage(stream.GetString(), baseUrl);
-    }
+    virtual void SetPage(wxInputStream& html, wxString baseUrl);

 
     /**
         Stop the current page loading process, if any.
 
     /**
         Stop the current page loading process, if any.


@@ -280,21 +394,27 @@ public:
 
     /**
         Returns @true if the current selection can be copied.
 
     /**
         Returns @true if the current selection can be copied.

+
+        @note This always returns @c true on the OSX WebKit backend.

     */
     */

-    virtual bool CanCopy() = 0;
+    virtual bool CanCopy() const = 0;

 
     /**
         Returns @true if the current selection can be cut.
 
     /**
         Returns @true if the current selection can be cut.

+
+         @note This always returns @c true on the OSX WebKit backend.

     */
     */

-    virtual bool CanCut() = 0;
+    virtual bool CanCut() const = 0;

 
     /**
         Returns @true if data can be pasted.
 
     /**
         Returns @true if data can be pasted.

+
+        @note This always returns @c true on the OSX WebKit backend.

     */
     */

-    virtual bool CanPaste() = 0;
+    virtual bool CanPaste() const = 0;

 
     /**
 
     /**

-        Copies the current selection. 
+        Copies the current selection.

     */
     virtual void Copy() = 0;
 
     */
     virtual void Copy() = 0;
 


@@ -312,17 +432,17 @@ public:
         @name History
     */
 
         @name History
     */
 

-    /** 
+    /**

         Returns @true if it is possible to navigate backward in the history of
         visited pages.
     */
         Returns @true if it is possible to navigate backward in the history of
         visited pages.
     */

-    virtual bool CanGoBack() = 0;
+    virtual bool CanGoBack() const = 0;

 
 

-    /** 
+    /**

         Returns @true if it is possible to navigate forward in the history of
         visited pages.
     */
         Returns @true if it is possible to navigate forward in the history of
         visited pages.
     */

-    virtual bool CanGoForward() = 0;
+    virtual bool CanGoForward() const = 0;

 
     /**
         Clear the history, this will also remove the visible page.
 
     /**
         Clear the history, this will also remove the visible page.


@@ -338,16 +458,16 @@ public:
         Returns a list of items in the back history. The first item in the
         vector is the first page that was loaded by the control.
     */
         Returns a list of items in the back history. The first item in the
         vector is the first page that was loaded by the control.
     */

-    virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory() = 0;
+    virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;

 
     /**
 
     /**

-        Returns a list of items in the forward history. The first item in the 
-        vector is the next item in the history with respect to the curently 
+        Returns a list of items in the forward history. The first item in the
+        vector is the next item in the history with respect to the curently

         loaded page.
     */
         loaded page.
     */

-    virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory() = 0;
+    virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;

 
 

-    /** 
+    /**

         Navigate back in the history of visited pages.
         Only valid if CanGoBack() returns true.
     */
         Navigate back in the history of visited pages.
         Only valid if CanGoBack() returns true.
     */


@@ -360,9 +480,45 @@ public:
     virtual void GoForward() = 0;
 
     /**
     virtual void GoForward() = 0;
 
     /**

-        Loads a history item. 
+        Loads a history item.

     */
     */

-    virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item) = 0;
+    virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
+
+    /**
+        @name Selection
+    */
+
+    /**
+        Clears the current selection.
+    */
+    virtual void ClearSelection() = 0;
+
+    /**
+        Deletes the current selection. Note that for @c wxWEB_VIEW_BACKEND_WEBKIT
+        the selection must be editable, either through SetEditable or the
+        correct HTML attribute.
+    */
+    virtual void DeleteSelection() = 0;
+
+    /**
+        Returns the currently selected source, if any.
+    */
+    virtual wxString GetSelectedSource() const = 0;
+
+    /**
+        Returns the currently selected text, if any.
+    */
+    virtual wxString GetSelectedText() const = 0;
+
+    /**
+        Returns @true if there is a current selection.
+    */
+    virtual bool HasSelection() const = 0;
+
+    /**
+        Selects the entire page.
+    */
+    virtual void SelectAll() = 0;

 
     /**
         @name Undo / Redo
 
     /**
         @name Undo / Redo


@@ -371,12 +527,12 @@ public:
     /**
         Returns @true if there is an action to redo.
     */
     /**
         Returns @true if there is an action to redo.
     */

-    virtual bool CanRedo() = 0;
+    virtual bool CanRedo() const = 0;

 
     /**
         Returns @true if there is an action to undo.
     */
 
     /**
         Returns @true if there is an action to undo.
     */

-    virtual bool CanUndo() = 0;
+    virtual bool CanUndo() const = 0;

 
     /**
         Redos the last action.
 
     /**
         Redos the last action.


@@ -404,7 +560,7 @@ public:
         Get the zoom factor of the page.
         @return The current level of zoom.
     */
         Get the zoom factor of the page.
         @return The current level of zoom.
     */

-    virtual wxWebViewZoom GetZoom() = 0;
+    virtual wxWebViewZoom GetZoom() const = 0;

 
     /**
         Get how the zoom factor is currently interpreted.
 
     /**
         Get how the zoom factor is currently interpreted.


@@ -432,12 +588,12 @@ public:
 
 
 /**
 
 
 /**

-    @class wxWebNavigationEvent
+    @class wxWebViewEvent

 
 

-    A navigation  event holds information about events associated with 
+    A navigation  event holds information about events associated with

     wxWebView objects.
 
     wxWebView objects.
 

-    @beginEventEmissionTable{wxWebNavigationEvent}
+    @beginEventEmissionTable{wxWebViewEvent}

     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
        to get a resource. This event may be vetoed to prevent navigating to this
     @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
        to get a resource. This event may be vetoed to prevent navigating to this


@@ -450,8 +606,9 @@ public:
        will be generated per frame.
     @event{EVT_WEB_VIEW_LOADED(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
        will be generated per frame.
     @event{EVT_WEB_VIEW_LOADED(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document

-       is fully loaded and displayed.
-    @event{EVT_WEB_VIEW_ERRROR(id, func)}
+       is fully loaded and displayed. Note that if the displayed HTML document has
+       several frames, one such event will be generated per frame.
+    @event{EVT_WEB_VIEW_ERROR(id, func)}

        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
        error occurs.
        The integer associated with this event will be a wxWebNavigationError item.
        Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
        error occurs.
        The integer associated with this event will be a wxWebNavigationError item.


@@ -459,51 +616,43 @@ public:
        precise error message/code.
     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
        precise error message/code.
     @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
        Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new

-       window is created. This event may be vetoed to prevent a new window showing,
-       for example if you want to open the url in the existing window or a new tab.
+       window is created. You must handle this event if you want anything to
+       happen, for example to load the page in a new window or tab.
+    @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
+       Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
+       the page title changes. Use GetString to get the title.

     @endEventTable
 
     @endEventTable
 

-    @library{wxweb}
-    @category{events}
+    @since 2.9.3
+    @library{wxwebview}
+    @category{events,webview}

 
     @see wxWebView
 */
 
     @see wxWebView
 */

-class wxWebNavigationEvent : public wxCommandEvent
+class wxWebViewEvent : public wxNotifyEvent

 {
 public:
 {
 public:

-    wxWebNavigationEvent();
-    wxWebNavigationEvent(wxEventType type, int id, const wxString href,
-                         const wxString target, bool canVeto);
-    /**
-        Get the URL being visited
-    */
-    const wxString& GetHref() const { return m_href; }
+    wxWebViewEvent();
+    wxWebViewEvent(wxEventType type, int id, const wxString href,
+                   const wxString target);

 
     /**
 
     /**

-        Get the target (frame or window) in which the URL that caused this event
-        is viewed, or an empty string if not available.
+        Get the name of the target frame which the url of this event
+        has been or will be loaded into. This may return an emptry string
+        if the frame is not available.

     */
     const wxString& GetTarget() const;
 
     */
     const wxString& GetTarget() const;
 

-    virtual wxEvent* Clone() const;
-
-    /** 
-        Get whether this event may be vetoed (stopped/prevented). Only
-        meaningful for events fired before navigation takes place or new 
-        window events.
-     */
-    bool CanVeto() const;
+    /**
+        Get the URL being visited
+    */
+    const wxString& GetURL() const;
+};

 
 

-    /** 
-        Whether this event was vetoed (stopped/prevented). Only meaningful for
-        events fired before navigation takes place or new window events.
-     */
-    bool IsVetoed() const;

 
 

-    /** 
-        Veto (prevent/stop) this event. Only meaningful for events fired
-        before navigation takes place or new window events. Only valid 
-        if CanVeto() returned true.
-     */
-    void Veto();
-};
\ No newline at end of file
+wxEventType wxEVT_COMMAND_WEB_VIEW_NAVIGATING;
+wxEventType wxEVT_COMMAND_WEB_VIEW_NAVIGATED;
+wxEventType wxEVT_COMMAND_WEB_VIEW_LOADED;
+wxEventType wxEVT_COMMAND_WEB_VIEW_ERROR;
+wxEventType wxEVT_COMMAND_WEB_VIEW_NEWWINDOW;
+wxEventType wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED;