X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/152a58083fbe9ad9ff15f41472e0a2fdf9f73fb3..7344108e8a129a3f9b4df5ab0f98a1713db03b89:/interface/wx/webview.h?ds=sidebyside diff --git a/interface/wx/webview.h b/interface/wx/webview.h index fafba64940..20e914e3a5 100644 --- a/interface/wx/webview.h +++ b/interface/wx/webview.h @@ -1,399 +1,658 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: webview.h -// Purpose: interface of wxWebView -// Author: wxWidgets team -// RCS-ID: $Id:$ -// Licence: wxWindows licence -///////////////////////////////////////////////////////////////////////////// - -/** - Zoom levels availiable 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 -}; - -/** - The type of zooming that the web view control can perform -*/ -enum wxWebViewZoomType -{ - /** - The entire layout scales when zooming, including images - */ - wxWEB_VIEW_ZOOM_TYPE_LAYOUT, - /** - Only the text changes in size when zooming, images and other layout - elements retain their initial size - */ - wxWEB_VIEW_ZOOM_TYPE_TEXT -}; - -/** - Types of errors that can cause navigation to fail -*/ -enum wxWebNavigationError -{ - /** Connection error (timeout, etc.) */ - wxWEB_NAV_ERR_CONNECTION, - /** Invalid certificate */ - wxWEB_NAV_ERR_CERTIFICATE, - /** Authentication required */ - wxWEB_NAV_ERR_AUTH, - /** Other security error */ - wxWEB_NAV_ERR_SECURITY, - /** Requested resource not found */ - wxWEB_NAV_ERR_NOT_FOUND, - /** Invalid request/parameters (e.g. bad URL, bad protocol, - unsupported resource type) */ - wxWEB_NAV_ERR_REQUEST, - /** The user cancelled (e.g. in a dialog) */ - wxWEB_NAV_ERR_USER_CANCELLED, - /** Another (exotic) type of error that didn't fit in other categories*/ - wxWEB_NAV_ERR_OTHER -}; - -/** - Type of refresh -*/ -enum wxWebViewReloadFlags -{ - /** Default reload, will access cache */ - wxWEB_VIEW_RELOAD_DEFAULT, - /** Reload the current view without accessing the cache */ - wxWEB_VIEW_RELOAD_NO_CACHE -}; - - -/** - * List of available backends for wxWebView - */ -enum wxWebViewBackend -{ - /** Value that may be passed to wxWebView to let it pick an appropriate - * 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, - - /** Use Microsoft Internet Explorer as web engine */ - wxWEB_VIEW_BACKEND_IE -}; - -/** - @class wxWebView - - 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} - @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 - 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 - 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. - @event{EVT_WEB_VIEW_ERRROR(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. - 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. 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. - @endEventTable - - @library{wxweb} - @category{ctrl} - */ -class wxWebView : public wxControl -{ -public: - - /** - Creation function for two-step creation. - */ - 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 - */ - static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT); - - /** - Factory function to create a new wxWebView - @param parent parent window to create this view in - @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 - is not available - */ - 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); - - - /** - Get whether it is possible to navigate back in the history of - visited pages - */ - virtual bool CanGoBack() = 0; - - /** - Get whether it is possible to navigate forward in the history of - visited pages - */ - virtual bool CanGoForward() = 0; - - /** - Navigate back in the history of visited pages. - Only valid if CanGoBack() returned true. - */ - virtual void GoBack() = 0; - - /** - Navigate forwardin the history of visited pages. - Only valid if CanGoForward() returned true. - */ - virtual void GoForward() = 0; - - /** - Clear the history, this will also remove the visible page. - */ - virtual void ClearHistory() = 0; - - /** - Enable or disable the history. This will also clear the history. - */ - virtual void EnableHistory(bool enable = true) = 0; - - /** - Load a HTMl document (web page) from a URL - @param url the URL where the HTML document to display can be found - @note web engines generally report errors asynchronously, so if you wish - to know whether loading the URL was successful, register to receive - navigation error events - */ - virtual void LoadUrl(const wxString& url) = 0; - - /** - 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. - */ - virtual void Stop() = 0; - - /** - Reload the currently displayed URL. - @param flags A bit array that may optionnally contain reload options - */ - virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0; - - - /** - Get the URL of the currently displayed document - */ - virtual wxString GetCurrentURL() = 0; - - /** - Get the title of the current web page, or its URL/path if title is not - available - */ - virtual wxString GetCurrentTitle() = 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; - - /** - Get the zoom factor of the page - @return How much the HTML document is zoomed (scaleed) - */ - virtual wxWebViewZoom GetZoom() = 0; - - /** - Set the zoom factor of the page - @param zoom How much to zoom (scale) the HTML document - */ - virtual void SetZoom(wxWebViewZoom zoom) = 0; - - /** - Set how to interpret the zoom factor - @param zoomType how the zoom factor should be interpreted by the - HTML engine - @note invoke canSetZoomType() first, some HTML renderers may not - support all zoom types - */ - virtual void SetZoomType(wxWebViewZoomType zoomType) = 0; - - /** - Get how the zoom factor is currently interpreted - @return how the zoom factor is currently interpreted by the HTML engine - */ - virtual wxWebViewZoomType GetZoomType() const = 0; - - /** - Retrieve whether the current HTML engine supports a type of zoom - @param type the type of zoom to test - @return whether this type of zoom is supported by this HTML engine - (and thus can be set through setZoomType()) - */ - virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0; - - /** - Set the displayed page source to the contents of the given string - @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 - */ - virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0; - - /** - Set the displayed page source to the contents of the given stream - @param html the stream to read HTML data from - @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); - } - - /** - Opens a print dialog so that the user may print the currently - displayed page. - */ - virtual void Print() = 0; - - /** - Returns whether the web control is currently busy (e.g. loading a page) - */ - virtual bool IsBusy() = 0; -}; - - - - -/** - @class wxWebNavigationEvent - - 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 - 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 - 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. - @event{EVT_WEB_VIEW_ERRROR(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. - 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. 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. - @endEventTable - - @library{wxweb} - @category{events} - - @see wxWebView -*/ -class wxWebNavigationEvent : public wxCommandEvent -{ -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; } - - /** - Get the target (frame or window) in which the URL that caused this event - is viewed, or an empty string if not available. - */ - 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; - - /** - 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 +///////////////////////////////////////////////////////////////////////////// +// Name: webview.h +// Purpose: interface of wxWebView +// Author: wxWidgets team +// RCS-ID: $Id$ +// Licence: wxWindows licence +///////////////////////////////////////////////////////////////////////////// + +/** + 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 +}; + +/** + The type of zooming that the web view control can perform +*/ +enum wxWebViewZoomType +{ + /** + The entire layout scales when zooming, including images + */ + wxWEB_VIEW_ZOOM_TYPE_LAYOUT, + /** + Only the text changes in size when zooming, images and other layout + elements retain their initial size + */ + wxWEB_VIEW_ZOOM_TYPE_TEXT +}; + +/** + Types of errors that can cause navigation to fail +*/ +enum wxWebViewNavigationError +{ + /** Connection error (timeout, etc.) */ + wxWEB_NAV_ERR_CONNECTION, + /** Invalid certificate */ + wxWEB_NAV_ERR_CERTIFICATE, + /** Authentication required */ + wxWEB_NAV_ERR_AUTH, + /** Other security error */ + wxWEB_NAV_ERR_SECURITY, + /** Requested resource not found */ + wxWEB_NAV_ERR_NOT_FOUND, + /** Invalid request/parameters (e.g. bad URL, bad protocol, + unsupported resource type) */ + wxWEB_NAV_ERR_REQUEST, + /** The user cancelled (e.g. in a dialog) */ + wxWEB_NAV_ERR_USER_CANCELLED, + /** Another (exotic) type of error that didn't fit in other categories*/ + wxWEB_NAV_ERR_OTHER +}; + +/** + Type of refresh +*/ +enum wxWebViewReloadFlags +{ + /** Default reload, will access cache */ + wxWEB_VIEW_RELOAD_DEFAULT, + /** Reload the current view without accessing the cache */ + wxWEB_VIEW_RELOAD_NO_CACHE +}; + +/** + * List of available backends for wxWebView + */ +enum wxWebViewBackend +{ + /** Value that may be passed to wxWebView to let it pick an appropriate + * engine for the current platform*/ + wxWEB_VIEW_BACKEND_DEFAULT, + + /** The WebKit web engine */ + wxWEB_VIEW_BACKEND_WEBKIT, + + /** Use Microsoft Internet Explorer as web engine */ + wxWEB_VIEW_BACKEND_IE +}; + +/** + @class wxWebViewHistoryItem + + A simple class that contains the URL and title of an element of the history + of a wxWebView. + + @since 2.9.3 + @library{wxwebview} + @category{webview} + + @see wxWebView + */ +class wxWebViewHistoryItem +{ +public: + /** + Construtor. + */ + wxWebViewHistoryItem(const wxString& url, const wxString& title); + + /** + @return The url of the page. + */ + wxString GetUrl(); + + /** + @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 + + 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 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 + WebBrowser + control, which this backend uses, emulate Internet Explorer 7. This can be + changed with a registry setting, see + + this 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 + 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 wxWEB_VIEW_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_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 + 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 + 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 + 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. + 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 + 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 + + @since 2.9.3 + @library{wxwebview} + @category{ctrl,webview} + @see wxWebViewHandler, wxWebViewEvent + */ +class wxWebView : public wxControl +{ +public: + + /** + Creation function for two-step creation. + */ + virtual bool 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; + + /** + 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 + */ + static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT); + + /** + Factory function to create a new wxWebView + @param parent parent window to create this view in + @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 + is not available + */ + 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); + + /** + Get the title of the current web page, or its URL/path if title is not + available. + */ + virtual wxString GetCurrentTitle() const = 0; + + /** + Get the URL of the currently displayed document. + */ + 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. + */ + 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). + */ + 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 + @param url The URL of the page to be loaded. + @note Web engines generally report errors asynchronously, so if you wish + to know whether loading the URL was successful, register to receive + navigation error events. + */ + virtual void LoadURL(const wxString& url) = 0; + + /** + Opens a print dialog so that the user may print the currently + displayed page. + */ + 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; + + /** + 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. + @param baseUrl URL assigned to the HTML data, to be used to resolve + relative paths, for instance. + */ + virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0; + + /** + Set the displayed page source to the contents of the given stream. + @param html The stream to read HTML data from. + @param baseUrl URL assigned to the HTML data, to be used to resolve + relative paths, for instance. + */ + virtual void SetPage(wxInputStream& html, wxString baseUrl); + + /** + 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. + */ + virtual void Stop() = 0; + + /** + @name Clipboard + */ + + /** + Returns @true if the current selection can be copied. + + @note This always returns @c true on the OSX WebKit backend. + */ + 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() const = 0; + + /** + Returns @true if data can be pasted. + + @note This always returns @c true on the OSX WebKit backend. + */ + virtual bool CanPaste() const = 0; + + /** + Copies the current selection. + */ + virtual void Copy() = 0; + + /** + Cuts the current selection. + */ + virtual void Cut() = 0; + + /** + Pastes the current data. + */ + virtual void Paste() = 0; + + /** + @name History + */ + + /** + Returns @true if it is possible to navigate backward in the history of + visited pages. + */ + virtual bool CanGoBack() const = 0; + + /** + Returns @true if it is possible to navigate forward in the history of + visited pages. + */ + virtual bool CanGoForward() const = 0; + + /** + Clear the history, this will also remove the visible page. + */ + virtual void ClearHistory() = 0; + + /** + Enable or disable the history. This will also clear the history. + */ + virtual void EnableHistory(bool enable = true) = 0; + + /** + 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; + + /** + 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; + + /** + Navigate back in the history of visited pages. + Only valid if CanGoBack() returns true. + */ + virtual void GoBack() = 0; + + /** + Navigate forward in the history of visited pages. + Only valid if CanGoForward() returns true. + */ + virtual void GoForward() = 0; + + /** + Loads a history item. + */ + virtual void LoadHistoryItem(wxSharedPtr 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 + */ + + /** + Returns @true if there is an action to redo. + */ + virtual bool CanRedo() const = 0; + + /** + Returns @true if there is an action to undo. + */ + virtual bool CanUndo() const = 0; + + /** + Redos the last action. + */ + virtual void Redo() = 0; + + /** + Undos the last action. + */ + virtual void Undo() = 0; + + /** + @name Zoom + */ + + /** + Retrieve whether the current HTML engine supports a zoom type. + @param type The zoom type to test. + @return Whether this type of zoom is supported by this HTML engine + (and thus can be set through SetZoomType()). + */ + virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0; + + /** + Get the zoom factor of the page. + @return The current level of zoom. + */ + virtual wxWebViewZoom GetZoom() const = 0; + + /** + Get how the zoom factor is currently interpreted. + @return How the zoom factor is currently interpreted by the HTML engine. + */ + virtual wxWebViewZoomType GetZoomType() const = 0; + + /** + Set the zoom factor of the page. + @param zoom How much to zoom (scale) the HTML document. + */ + virtual void SetZoom(wxWebViewZoom zoom) = 0; + + /** + Set how to interpret the zoom factor. + @param zoomType How the zoom factor should be interpreted by the + HTML engine. + @note invoke CanSetZoomType() first, some HTML renderers may not + support all zoom types. + */ + virtual void SetZoomType(wxWebViewZoomType zoomType) = 0; +}; + + + + +/** + @class wxWebViewEvent + + A navigation event holds information about events associated with + wxWebView objects. + + @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 + 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 + 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 + 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. + 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 + 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 + + @since 2.9.3 + @library{wxwebview} + @category{events,webview} + + @see wxWebView +*/ +class wxWebViewEvent : public wxNotifyEvent +{ +public: + 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 available. + */ + const wxString& GetTarget() const; + + /** + Get the URL being visited + */ + const wxString& GetURL() const; +}; + + +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;