cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tidy up webview.h. Remove all of the doxygen comments which have now been moved to the interface file. Organise method declarations more sensibly.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/SOC2011_WEBVIEW@68759 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Steve Lamerton 2011-08-17 10:49:17 +00:00
parent fba4c7c91b
commit 9af5122202
1 changed files with 32 additions and 226 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

258
include/wx/webview.h
View File

@ -27,10 +27,6 @@
class wxFSFile;
class wxFileSystem;
/**
* Zoom level in web view component
*/
enum wxWebViewZoom
{
wxWEB_VIEW_ZOOM_TINY,
@ -40,63 +36,36 @@ enum wxWebViewZoom
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 */
//Scales entire page, 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 */
//Default, may 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
};
@ -118,9 +87,6 @@ class WXDLLIMPEXP_WEB wxWebView : public wxControl
{
public:
/**
* Creation function for two-step creation.
*/
virtual bool Create(wxWindow* parent,
wxWindowID id,
const wxString& url,
@ -129,29 +95,7 @@ public:
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);
// TODO: clarify what styles can do, or remove this flag
/**
* 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,
@ -161,137 +105,48 @@ public:
long style = 0,
const wxString& name = wxWebViewNameStr);
/** Get whether it is possible to navigate back in the history of
* visited pages
*/
virtual bool CanGoBack() const = 0;
/** Get whether it is possible to navigate forward in the history of
* visited pages
*/
virtual bool CanGoForward() const = 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;
/**
* 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;
virtual void ClearHistory() = 0;
virtual void EnableHistory(bool enable = true) = 0;
virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;
virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;
virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
/**
* Stop the current page loading process, if any.
* May trigger an error event of type wxWEB_NAV_ERR_USER_CANCELLED.
* TODO: make 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() const = 0;
/**
* Get the title of the current web page, or its URL/path if title is not
* available
*/
//General methods
virtual wxString GetCurrentTitle() const = 0;
virtual wxString GetCurrentURL() const = 0;
// TODO: handle choosing a frame when calling GetPageSource()?
/**
* 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;
virtual wxString GetPageText() const = 0;
/**
* Get the zoom factor of the page
* @return How much the HTML document is zoomed (scaleed)
*/
virtual wxWebViewZoom GetZoom() 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;
/**
* 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;
// TODO: allow 'SetPage' to find files (e.g. images) from a virtual file
// system if possible
/**
* 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 bool IsBusy() const = 0;
virtual bool IsEditable() const = 0;
virtual void LoadUrl(const wxString& url) = 0;
virtual void Print() = 0;
virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
virtual void RunScript(const wxString& javascript) = 0;
virtual void SetEditable(bool enable = true) = 0;
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);
}
virtual void Stop() = 0;
virtual void SetEditable(bool enable = true) = 0;
virtual bool IsEditable() const = 0;
//History
virtual bool CanGoBack() const = 0;
virtual bool CanGoForward() const = 0;
virtual void GoBack() = 0;
virtual void GoForward() = 0;
virtual void ClearHistory() = 0;
virtual void EnableHistory(bool enable = true) = 0;
virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;
virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;
virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
//Zoom
virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
virtual wxWebViewZoom GetZoom() const = 0;
virtual wxWebViewZoomType GetZoomType() const = 0;
virtual void SetZoom(wxWebViewZoom zoom) = 0;
virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
//Selection
virtual void SelectAll() = 0;
virtual bool HasSelection() const = 0;
virtual void DeleteSelection() = 0;
@ -299,34 +154,6 @@ public:
virtual wxString GetSelectedSource() const = 0;
virtual void ClearSelection() = 0;
virtual void RunScript(const wxString& javascript) = 0;
// TODO:
// void EnableJavascript(bool enabled); // maybe?
// // maybe?
// void SetScrollPos(int pos); // maybe?
// int GetScrollPos(); // maybe?
// wxString GetStatusText(); // maybe?
// void SetStatusText(wxString text); // maybe?
// * status text changed event?
// * title changed event?
// virtual bool IsOfflineMode() = 0; // maybe?
// virtual void SetOfflineMode(bool offline) = 0; // maybe?
/**
* 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() const = 0;
//Clipboard functions
virtual bool CanCut() const = 0;
virtual bool CanCopy() const = 0;
@ -341,9 +168,6 @@ public:
virtual void Undo() = 0;
virtual void Redo() = 0;
//Virtual Filesystem Support
virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
wxDECLARE_ABSTRACT_CLASS(wxWebView);
};
@ -361,33 +185,15 @@ public:
m_canVeto = canVeto;
}
/**
* Get the URL being visited
*/
const wxString& GetURL() const { return m_url; }
/**
* 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& GetURL() const { return m_url; }
const wxString& GetTarget() const { return m_target; }
// default copy ctor, assignment operator and dtor are ok
virtual wxEvent* Clone() const { return new wxWebViewEvent(*this); }
/** Get whether this event may be vetoed (stopped/prevented). Only
* meaningful for events fired before navigation takes place.
*/
bool CanVeto() const { return m_canVeto; }
/** Whether this event was vetoed (stopped/prevented). Only meaningful for
* events fired before navigation takes place.
*/
bool IsVetoed() const { return m_vetoed; }
/** Veto (prevent/stop) this event. Only meaningful for events fired
* before navigation takes place. Only valid if CanVeto() returned true.
*/
void Veto() { wxASSERT(m_canVeto); m_vetoed = true; }
private: