X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e40741b95c8bce336dec8d829f3c3a36be8df917..1b7751aaa9a86d76a850b9267bc0c201e3cea30f:/interface/wx/webview.h diff --git a/interface/wx/webview.h b/interface/wx/webview.h index 7d5f96da90..d9bae67391 100644 --- a/interface/wx/webview.h +++ b/interface/wx/webview.h @@ -7,15 +7,15 @@ ///////////////////////////////////////////////////////////////////////////// /** - Zoom levels availiable in wxWebView + Zoom levels available in wxWebView */ enum wxWebViewZoom { - wxWEB_VIEW_ZOOM_TINY, - wxWEB_VIEW_ZOOM_SMALL, - wxWEB_VIEW_ZOOM_MEDIUM, //!< default size - wxWEB_VIEW_ZOOM_LARGE, - wxWEB_VIEW_ZOOM_LARGEST + wxWEBVIEW_ZOOM_TINY, + wxWEBVIEW_ZOOM_SMALL, + wxWEBVIEW_ZOOM_MEDIUM, //!< default size + wxWEBVIEW_ZOOM_LARGE, + wxWEBVIEW_ZOOM_LARGEST }; /** @@ -23,144 +23,281 @@ enum wxWebViewZoom */ enum wxWebViewZoomType { - /** - The entire layout scales when zooming, including images + /** + The entire layout scales when zooming, including images */ - wxWEB_VIEW_ZOOM_TYPE_LAYOUT, - /** + wxWEBVIEW_ZOOM_TYPE_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 + wxWEBVIEW_ZOOM_TYPE_TEXT }; -/** +/** Types of errors that can cause navigation to fail */ -enum wxWebNavigationError +enum wxWebViewNavigationError { /** Connection error (timeout, etc.) */ - wxWEB_NAV_ERR_CONNECTION, + wxWEBVIEW_NAV_ERR_CONNECTION, /** Invalid certificate */ - wxWEB_NAV_ERR_CERTIFICATE, + wxWEBVIEW_NAV_ERR_CERTIFICATE, /** Authentication required */ - wxWEB_NAV_ERR_AUTH, + wxWEBVIEW_NAV_ERR_AUTH, /** Other security error */ - wxWEB_NAV_ERR_SECURITY, + wxWEBVIEW_NAV_ERR_SECURITY, /** Requested resource not found */ - wxWEB_NAV_ERR_NOT_FOUND, + wxWEBVIEW_NAV_ERR_NOT_FOUND, /** Invalid request/parameters (e.g. bad URL, bad protocol, unsupported resource type) */ - wxWEB_NAV_ERR_REQUEST, + wxWEBVIEW_NAV_ERR_REQUEST, /** The user cancelled (e.g. in a dialog) */ - wxWEB_NAV_ERR_USER_CANCELLED, + wxWEBVIEW_NAV_ERR_USER_CANCELLED, /** Another (exotic) type of error that didn't fit in other categories*/ - wxWEB_NAV_ERR_OTHER + wxWEBVIEW_NAV_ERR_OTHER }; -/** - Type of refresh +/** + Type of refresh */ enum wxWebViewReloadFlags { /** Default reload, will access cache */ - wxWEB_VIEW_RELOAD_DEFAULT, + wxWEBVIEW_RELOAD_DEFAULT, /** Reload the current view without accessing the cache */ - wxWEB_VIEW_RELOAD_NO_CACHE + wxWEBVIEW_RELOAD_NO_CACHE }; - /** - * List of available backends for wxWebView - */ -enum wxWebViewBackend + Find flags used when searching for text on page. +*/ +enum wxWebViewFindFlags { - /** Value that may be passed to wxWebView to let it pick an appropriate - * engine for the current platform*/ - wxWEB_VIEW_BACKEND_DEFAULT, + /** Causes the search to restart when end or beginning reached */ + wxWEBVIEW_FIND_WRAP = 0x0001, + + /** Matches an entire word when searching */ + wxWEBVIEW_FIND_ENTIRE_WORD = 0x0002, + + /** Match case, i.e. case sensitive searching */ + wxWEBVIEW_FIND_MATCH_CASE = 0x0004, + + /** Highlights the search results */ + wxWEBVIEW_FIND_HIGHLIGHT_RESULT = 0x0008, - /** The WebKit web engine */ - wxWEB_VIEW_BACKEND_WEBKIT, + /** Searches for phrase in backward direction */ + wxWEBVIEW_FIND_BACKWARDS = 0x0010, - /** Use Microsoft Internet Explorer as web engine */ - wxWEB_VIEW_BACKEND_IE + /** The default flag, which is simple searching */ + wxWEBVIEW_FIND_DEFAULT = 0 }; + /** - @class wxWebHistoryItem - + @class wxWebViewHistoryItem + A simple class that contains the URL and title of an element of the history - of a wxWebView. - - @library{wxweb} - @category{web} - + of a wxWebView. + + @since 2.9.3 + @library{wxwebview} + @category{webview} + @see wxWebView */ -class wxWebHistoryItem +class wxWebViewHistoryItem { 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 title of the page. */ wxString GetTitle(); }; +/** + @class wxWebViewFactory + + An abstract factory class for creating wxWebView backends. Each + implementation of wxWebView should have its own factory. + + @since 2.9.5 + @library{wxwebview} + @category{webview} + + @see wxWebView + */ +class wxWebViewFactory : public wxObject +{ +public: + /** + Function to create a new wxWebView with two-step creation, + wxWebView::Create should be called on the returned object. + @return the created wxWebView + */ + virtual wxWebView* Create() = 0; + + /** + Function to create a new wxWebView with parameters. + @param parent Parent window for the control + @param id ID of this control + @param url Initial URL to load + @param pos Position of the control + @param size Size of the control + @return the created wxWebView + */ + virtual wxWebView* Create(wxWindow* parent, + wxWindowID id, + const wxString& url = wxWebViewDefaultURLStr, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = 0, + const wxString& name = wxWebViewNameStr) = 0; +}; + +/** + @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 - - This control may be used to render web (HTML / CSS / javascript) documents. - Capabilities of the HTML renderer will depend upon the backed. - @c wxWEB_VIEW_BACKEND_IE uses the the Trident rendering engine, which - is also used by Internet Explorer. It is important to note that by default - it emulates Internet Explorer 7, this can be chaged with a registry - setting, see + This control may be used to render web (HTML / CSS / javascript) documents. + 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 wxWEBVIEW_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 + WebBrowser + control, which this backend uses, emulate Internet Explorer 7. This can be + changed with a registry setting, see - this article for more information. - - Note that errors are generally reported asynchronously though the - @c wxEVT_COMMAND_WEB_VIEW_ERROR event described below. - - @beginEventEmissionTable{wxWebNavigationEvent} - @event{EVT_WEB_VIEW_NAVIGATING(id, func)} - Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying + this article for more information. This backend has full support for + custom schemes and virtual file systems. + + @par wxWEBVIEW_WEBKIT (GTK) + + Under GTK the WebKit backend uses + WebKitGTK+. 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 wxWEBVIEW_WEBKIT (OSX) + + The OSX WebKit backend uses Apple's + WebView + 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_WEBVIEW_LOADED notifies + when the page or a sub-frame has finished loading and + @c wxEVT_WEBVIEW_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. + + wxWebViewFSHandler is provided to access the virtual file system encapsulated by + wxFileSystem. The wxMemoryFSHandler documentation gives an example of how this + may be used. + + wxWebViewArchiveHandler is provided to allow the navigation of pages inside a zip + archive. It supports paths of the form: + @c scheme:///C:/example/docs.zip;protocol=zip/main.htm + + @beginEventEmissionTable{wxWebViewEvent} + @event{EVT_WEBVIEW_NAVIGATING(id, func)} + Process a @c wxEVT_WEBVIEW_NAVIGATING event, generated before trying to get a resource. This event may be vetoed to prevent navigating to this resource. Note that if the displayed HTML document has several frames, one such event will be generated per frame. - @event{EVT_WEB_VIEW_NAVIGATED(id, func)} - Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was + @event{EVT_WEBVIEW_NAVIGATED(id, func)} + Process a @c wxEVT_WEBVIEW_NAVIGATED event generated after it was confirmed that a resource would be requested. This event may not be vetoed. Note that if the displayed HTML document has several frames, one such event 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. Note that if the displayed HTML document has + @event{EVT_WEBVIEW_LOADED(id, func)} + Process a @c wxEVT_WEBVIEW_LOADED event generated when the document + 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_ERRROR(id, func)} - Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation + @event{EVT_WEBVIEW_ERROR(id, func)} + Process a @c wxEVT_WEBVIEW_ERROR event generated when a navigation error occurs. The integer associated with this event will be a wxWebNavigationError item. The string associated with this event may contain a backend-specific more 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. You must handle this event if you want anything to + @event{EVT_WEBVIEW_NEWWINDOW(id, func)} + Process a @c wxEVT_WEBVIEW_NEWWINDOW event, generated when a new + 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_WEBVIEW_TITLE_CHANGED(id, func)} + Process a @c wxEVT_WEBVIEW_TITLE_CHANGED event, generated when + the page title changes. Use GetString to get the title. @endEventTable - - @library{wxweb} - @category{ctrl,web} + + @since 2.9.3 + @library{wxwebview} + @category{ctrl,webview} + @see wxWebViewHandler, wxWebViewEvent */ class wxWebView : public wxControl { @@ -171,75 +308,117 @@ public: */ virtual bool Create(wxWindow* parent, wxWindowID id, - const wxString& url, - const wxPoint& pos, - const wxSize& size, - long style, - const wxString& name) = 0; - - /** - Factory function to create a new wxWebView for two-step creation - (you need to call wxWebView::Create on the returned object) - @param backend which web engine to use as backend for wxWebView - @return the created wxWebView, or NULL if the requested backend is - not available + 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 with two-step creation, + wxWebView::Create should be called on the returned object. + @param backend The backend web rendering engine to use. + @c wxWebViewBackendDefault, @c wxWebViewBackendIE and + @c wxWebViewBackendWebKit are predefined where appropriate. + @return The created wxWebView + @since 2.9.5 */ - static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT); - + static wxWebView* New(const wxString& backend = wxWebViewBackendDefault); + /** - Factory function to create a new wxWebView - @param parent parent window to create this view in + Factory function to create a new wxWebView using a wxWebViewFactory. + @param parent Parent window for the control @param id ID of this control - @param url URL to load by default in the web view - @param pos position to create this control at - (you may use wxDefaultPosition if you use sizers) - @param size size to create this control with - (you may use wxDefaultSize if you use sizers) - @param backend which web engine to use as backend for wxWebView - @return the created wxWebView, or NULL if the requested backend + @param url Initial URL to load + @param pos Position of the control + @param size Size of the control + @param backend The backend web rendering engine to use. + @c wxWebViewBackendDefault, @c wxWebViewBackendIE and + @c wxWebViewBackendWebKit are predefined where appropriate. + @return The created wxWebView, or @c NULL if the requested backend is not available + @since 2.9.5 */ static wxWebView* New(wxWindow* parent, - wxWindowID id, - const wxString& url = wxWebViewDefaultURLStr, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT, - long style = 0, - const wxString& name = wxWebViewNameStr); + wxWindowID id, + const wxString& url = wxWebViewDefaultURLStr, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + const wxString& backend = wxWebViewBackendDefault, + long style = 0, + const wxString& name = wxWebViewNameStr); + + /** + Allows the registering of new backend for wxWebView. @a backend can be + used as an argument to New(). + @param backend The name for the new backend to be registered under + @param factory A shared pointer to the factory which creates the + appropriate backend. + @since 2.9.5 + */ + static void RegisterFactory(const wxString& backend, + wxSharedPtr factory); /** 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. */ - virtual wxString GetCurrentURL() = 0; + virtual wxString GetCurrentURL() const = 0; + + /** + Return the pointer to the native backend used by this control. + + This method can be used to retrieve the pointer to the native rendering + engine used by this control. The return value needs to be down-casted + to the appropriate type depending on the platform: under Windows, it's + a pointer to IWebBrowser2 interface, under OS X it's a WebView pointer + and under GTK it's a WebKitWebView. + + For example, you could set the WebKit options using this method: + @code + #include + + #ifdef __WXGTK__ + WebKitWebView* + wv = static_cast(m_window->GetNativeBackend()); + + WebKitWebSettings* settings = webkit_web_view_get_settings(wv); + g_object_set(G_OBJECT(settings), + "enable-frame-flattening", TRUE, + NULL); + #endif + @endcode + + @since 2.9.5 + */ + virtual void* GetNativeBackend() 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. */ - virtual wxString GetPageSource() = 0; - + virtual wxString GetPageSource() const = 0; + /** Get the text of the current page. */ - virtual wxString GetPageText() = 0; - + 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() = 0; + virtual bool IsEditable() const = 0; /** Load a web page from a URL @@ -248,7 +427,7 @@ public: 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 @@ -256,17 +435,25 @@ public: */ virtual void Print() = 0; + /** + Registers a custom scheme handler. + @param handler A shared pointer to a wxWebHandler. + */ + virtual void RegisterHandler(wxSharedPtr 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; - + virtual void Reload(wxWebViewReloadFlags flags = wxWEBVIEW_RELOAD_DEFAULT) = 0; + /** - Runs the given javascript code. + Runs the given javascript code. + @note When using wxWEBVIEW_BACKEND_IE you must wait for the current + page to finish loading before calling RunScript(). */ 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. @@ -279,6 +466,9 @@ public: @param html The string that contains the HTML data to display. @param baseUrl URL assigned to the HTML data, to be used to resolve relative paths, for instance. + @note When using @c wxWEBVIEW_BACKEND_IE you must wait for the current + page to finish loading before calling SetPage(). The baseURL + parameter is not used in this backend. */ virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0; @@ -292,8 +482,8 @@ public: /** Stop the current page loading process, if any. - May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED. - TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports. + May trigger an error event of type @c wxWEBVIEW_NAV_ERR_USER_CANCELLED. + TODO: make @c wxWEBVIEW_NAV_ERR_USER_CANCELLED errors uniform across ports. */ virtual void Stop() = 0; @@ -303,21 +493,27 @@ public: /** 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. + + @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. + + @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; @@ -331,21 +527,42 @@ public: */ virtual void Paste() = 0; + /** + @name Context Menu + */ + + /** + Enable or disable the right click context menu. + + By default the standard context menu is enabled, this method can be + used to disable it or re-enable it later. + + @since 2.9.5 + */ + virtual void EnableContextMenu(bool enable = true); + + /** + Returns @true if a context menu will be shown on right click. + + @since 2.9.5 + */ + virtual bool IsContextMenuEnabled() const; + /** @name History */ - /** + /** 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. */ - virtual bool CanGoForward() = 0; + virtual bool CanGoForward() const = 0; /** Clear the history, this will also remove the visible page. @@ -361,16 +578,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. */ - virtual wxVector > GetBackwardHistory() = 0; + virtual wxVector > 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. */ - virtual wxVector > GetForwardHistory() = 0; + virtual wxVector > GetForwardHistory() = 0; - /** + /** Navigate back in the history of visited pages. Only valid if CanGoBack() returns true. */ @@ -383,40 +600,40 @@ public: virtual void GoForward() = 0; /** - Loads a history item. + Loads a history item. */ - virtual void LoadHistoryItem(wxSharedPtr item) = 0; - + virtual void LoadHistoryItem(wxSharedPtr item) = 0; + /** @name Selection */ - + /** - Clears the current 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 + Deletes the current selection. Note that for @c wxWEBVIEW_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() = 0; - + virtual wxString GetSelectedSource() const = 0; + /** Returns the currently selected text, if any. */ - virtual wxString GetSelectedText() = 0; + virtual wxString GetSelectedText() const = 0; /** Returns @true if there is a current selection. */ - virtual bool HasSelection() = 0; + virtual bool HasSelection() const = 0; /** Selects the entire page. @@ -430,12 +647,12 @@ public: /** 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. */ - virtual bool CanUndo() = 0; + virtual bool CanUndo() const = 0; /** Redos the last action. @@ -447,6 +664,30 @@ public: */ virtual void Undo() = 0; + /** + @name Finding + */ + + /** + Finds a phrase on the current page and if found, the control will + scroll the phrase into view and select it. + @param text The phrase to search for. + @param flags The flags for the search. + @return If search phrase was not found in combination with the flags + then @c wxNOT_FOUND is returned. If called for the first time + with search phrase then the total number of results will be + returned. Then for every time its called with the same search + phrase it will return the number of the current match. + @note This function will restart the search if the flags + @c wxWEBVIEW_FIND_ENTIRE_WORD or @c wxWEBVIEW_FIND_MATCH_CASE + are changed, since this will require a new search. To reset the + search, for example reseting the highlights call the function + with an empty search phrase. This always returns @c wxNOT_FOUND + on the OSX WebKit backend. + @since 2.9.5 + */ + virtual long Find(const wxString& text, wxWebViewFindFlags flags = wxWEBVIEW_FIND_DEFAULT) = 0; + /** @name Zoom */ @@ -463,7 +704,7 @@ public: 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. @@ -491,54 +732,58 @@ 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. - @beginEventEmissionTable{wxWebNavigationEvent} - @event{EVT_WEB_VIEW_NAVIGATING(id, func)} - Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying + @beginEventEmissionTable{wxWebViewEvent} + @event{EVT_WEBVIEW_NAVIGATING(id, func)} + Process a @c wxEVT_WEBVIEW_NAVIGATING event, generated before trying to get a resource. This event may be vetoed to prevent navigating to this resource. Note that if the displayed HTML document has several frames, one such event will be generated per frame. - @event{EVT_WEB_VIEW_NAVIGATED(id, func)} - Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was + @event{EVT_WEBVIEW_NAVIGATED(id, func)} + Process a @c wxEVT_WEBVIEW_NAVIGATED event generated after it was confirmed that a resource would be requested. This event may not be vetoed. Note that if the displayed HTML document has several frames, one such event 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. Note that if the displayed HTML document has + @event{EVT_WEBVIEW_LOADED(id, func)} + Process a @c wxEVT_WEBVIEW_LOADED event generated when the document + 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_ERRROR(id, func)} - Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation + @event{EVT_WEBVIEW_ERROR(id, func)} + Process a @c wxEVT_WEBVIEW_ERROR event generated when a navigation error occurs. - The integer associated with this event will be a wxWebNavigationError item. + The integer associated with this event will be a #wxWebViewNavigationError item. The string associated with this event may contain a backend-specific more 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. You must handle this event if you want anything to + @event{EVT_WEBVIEW_NEWWINDOW(id, func)} + Process a @c wxEVT_WEBVIEW_NEWWINDOW event, generated when a new + 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_WEBVIEW_TITLE_CHANGED(id, func)} + Process a @c wxEVT_WEBVIEW_TITLE_CHANGED event, generated when + the page title changes. Use GetString to get the title. @endEventTable - @library{wxweb} - @category{events,web} + @since 2.9.3 + @library{wxwebview} + @category{events,webview} @see wxWebView */ -class wxWebNavigationEvent : public wxCommandEvent +class wxWebViewEvent : public wxNotifyEvent { public: - wxWebNavigationEvent(); - wxWebNavigationEvent(wxEventType type, int id, const wxString href, - const wxString target, bool canVeto); + wxWebViewEvent(); + wxWebViewEvent(wxEventType type, int id, const wxString href, + const wxString target); /** 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 avaliable. + if the frame is not available. */ const wxString& GetTarget() const; @@ -546,24 +791,12 @@ public: Get the URL being visited */ const wxString& GetURL() const; +}; - virtual wxEvent* Clone() const; - - /** - Get whether this event may be vetoed (stopped/prevented). Only - meaningful for events fired before navigation takes place. - */ - bool CanVeto() 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. Only valid if CanVeto() returned true. - */ - void Veto(); -}; \ No newline at end of file +wxEventType wxEVT_WEBVIEW_NAVIGATING; +wxEventType wxEVT_WEBVIEW_NAVIGATED; +wxEventType wxEVT_WEBVIEW_LOADED; +wxEventType wxEVT_WEBVIEW_ERROR; +wxEventType wxEVT_WEBVIEW_NEWWINDOW; +wxEventType wxEVT_WEBVIEW_TITLE_CHANGED;