X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7d8d6163ad4e9aeea1d18341462c23693a42b9a3..bf973818a376aea7edf29ec264982fcde7423c78:/interface/wx/webview.h diff --git a/interface/wx/webview.h b/interface/wx/webview.h index e4641504df..b69d38076d 100644 --- 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 { @@ -37,7 +37,7 @@ enum wxWebViewZoomType /** Types of errors that can cause navigation to fail */ -enum wxWebNavigationError +enum wxWebViewNavigationError { /** Connection error (timeout, etc.) */ wxWEB_NAV_ERR_CONNECTION, @@ -87,23 +87,24 @@ enum wxWebViewBackend }; /** - @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} + @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. @@ -122,8 +123,9 @@ public: The base class for handling custom schemes in wxWebView, for example to allow virtual file system support. - @library{wxweb} - @category{web} + @since 2.9.3 + @library{wxwebview} + @category{webview} @see wxWebView */ @@ -144,7 +146,7 @@ public: /** @return The name of the scheme, as passed to the constructor. */ - virtual wxString GetName() const = 0; + virtual wxString GetName() const; }; /** @@ -209,9 +211,9 @@ public: 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:/exmaple/docs.zip;protocol=zip/main.htm + @c file:///C:/example/docs.zip;protocol=zip/main.htm - @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 @@ -226,7 +228,7 @@ public: 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_ERRROR(id, func)} + @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. @@ -241,9 +243,10 @@ public: the page title changes. Use GetString to get the title. @endEventTable - @library{wxweb} - @category{ctrl,web} - @see wxWebHandler, wxWebNavigationEvent + @since 2.9.3 + @library{wxwebview} + @category{ctrl,webview} + @see wxWebViewHandler, wxWebViewEvent */ class wxWebView : public wxControl { @@ -254,11 +257,11 @@ public: */ 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 @@ -295,34 +298,34 @@ public: 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; /** 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). */ - 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 @@ -331,7 +334,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 @@ -393,23 +396,23 @@ public: /** Returns @true if the current selection can be copied. - @note This always returns @c false on the OSX WebKit backend. + @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 false on the OSX WebKit backend. + @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 false on the OSX WebKit backend. + @note This always returns @c true on the OSX WebKit backend. */ - virtual bool CanPaste() = 0; + virtual bool CanPaste() const = 0; /** Copies the current selection. @@ -434,13 +437,13 @@ public: 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. @@ -456,14 +459,14 @@ 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 loaded page. */ - virtual wxVector > GetForwardHistory() = 0; + virtual wxVector > GetForwardHistory() = 0; /** Navigate back in the history of visited pages. @@ -480,7 +483,7 @@ public: /** Loads a history item. */ - virtual void LoadHistoryItem(wxSharedPtr item) = 0; + virtual void LoadHistoryItem(wxSharedPtr item) = 0; /** @name Selection @@ -501,17 +504,17 @@ public: /** 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. @@ -525,12 +528,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. @@ -558,7 +561,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. @@ -586,12 +589,12 @@ public: /** - @class wxWebNavigationEvent + @class wxWebViewEvent A navigation event holds information about events associated with 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 @@ -606,7 +609,7 @@ public: 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_ERRROR(id, func)} + @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. @@ -620,23 +623,24 @@ public: Process a @c wxEVT_COMMAND_WEB_VIEW_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; @@ -644,24 +648,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_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;