git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: webview.h
	3	// Purpose: Common interface and events for web view component
	4	// Author: Marianne Gagnon
	5	// Copyright: (c) 2010 Marianne Gagnon, 2011 Steven Lamerton
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	#ifndef _WX_WEBVIEW_H_
	10	#define _WX_WEBVIEW_H_
	11
	12	#include "wx/defs.h"
	13
	14	#if wxUSE_WEBVIEW
	15
	16	#include "wx/control.h"
	17	#include "wx/event.h"
	18	#include "wx/sstream.h"
	19	#include "wx/sharedptr.h"
	20	#include "wx/vector.h"
	21
	22	#if defined(__WXOSX__)
	23	#include "wx/osx/webviewhistoryitem_webkit.h"
	24	#elif defined(__WXGTK__)
	25	#include "wx/gtk/webviewhistoryitem_webkit.h"
	26	#elif defined(__WXMSW__)
	27	#include "wx/msw/webviewhistoryitem_ie.h"
	28	#else
	29	#error "wxWebView not implemented on this platform."
	30	#endif
	31
	32	class wxFSFile;
	33	class wxFileSystem;
	34	class wxWebView;
	35
	36	enum wxWebViewZoom
	37	{
	38	wxWEBVIEW_ZOOM_TINY,
	39	wxWEBVIEW_ZOOM_SMALL,
	40	wxWEBVIEW_ZOOM_MEDIUM,
	41	wxWEBVIEW_ZOOM_LARGE,
	42	wxWEBVIEW_ZOOM_LARGEST
	43	};
	44
	45	enum wxWebViewZoomType
	46	{
	47	//Scales entire page, including images
	48	wxWEBVIEW_ZOOM_TYPE_LAYOUT,
	49	wxWEBVIEW_ZOOM_TYPE_TEXT
	50	};
	51
	52	enum wxWebViewNavigationError
	53	{
	54	wxWEBVIEW_NAV_ERR_CONNECTION,
	55	wxWEBVIEW_NAV_ERR_CERTIFICATE,
	56	wxWEBVIEW_NAV_ERR_AUTH,
	57	wxWEBVIEW_NAV_ERR_SECURITY,
	58	wxWEBVIEW_NAV_ERR_NOT_FOUND,
	59	wxWEBVIEW_NAV_ERR_REQUEST,
	60	wxWEBVIEW_NAV_ERR_USER_CANCELLED,
	61	wxWEBVIEW_NAV_ERR_OTHER
	62	};
	63
	64	enum wxWebViewReloadFlags
	65	{
	66	//Default, may access cache
	67	wxWEBVIEW_RELOAD_DEFAULT,
	68	wxWEBVIEW_RELOAD_NO_CACHE
	69	};
	70
	71	enum wxWebViewFindFlags
	72	{
	73	wxWEBVIEW_FIND_WRAP = 0x0001,
	74	wxWEBVIEW_FIND_ENTIRE_WORD = 0x0002,
	75	wxWEBVIEW_FIND_MATCH_CASE = 0x0004,
	76	wxWEBVIEW_FIND_HIGHLIGHT_RESULT = 0x0008,
	77	wxWEBVIEW_FIND_BACKWARDS = 0x0010,
	78	wxWEBVIEW_FIND_DEFAULT = 0
	79	};
	80
	81	//Base class for custom scheme handlers
	82	class WXDLLIMPEXP_WEBVIEW wxWebViewHandler
	83	{
	84	public:
	85	wxWebViewHandler(const wxString& scheme) : m_scheme(scheme) {}
	86	virtual ~wxWebViewHandler() {}
	87	virtual wxString GetName() const { return m_scheme; }
	88	virtual wxFSFile* GetFile(const wxString &uri) = 0;
	89	private:
	90	wxString m_scheme;
	91	};
	92
	93	extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewNameStr[];
	94	extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewDefaultURLStr[];
	95	extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewBackendDefault[];
	96	extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewBackendIE[];
	97	extern WXDLLIMPEXP_DATA_WEBVIEW(const char) wxWebViewBackendWebKit[];
	98
	99	class WXDLLIMPEXP_WEBVIEW wxWebViewFactory : public wxObject
	100	{
	101	public:
	102	virtual wxWebView* Create() = 0;
	103	virtual wxWebView* Create(wxWindow* parent,
	104	wxWindowID id,
	105	const wxString& url = wxWebViewDefaultURLStr,
	106	const wxPoint& pos = wxDefaultPosition,
	107	const wxSize& size = wxDefaultSize,
	108	long style = 0,
	109	const wxString& name = wxWebViewNameStr) = 0;
	110	};
	111
	112	WX_DECLARE_STRING_HASH_MAP(wxSharedPtr<wxWebViewFactory>, wxStringWebViewFactoryMap);
	113
	114	class WXDLLIMPEXP_WEBVIEW wxWebView : public wxControl
	115	{
	116	public:
	117	wxWebView()
	118	{
	119	m_showMenu = true;
	120	}
	121
	122	virtual ~wxWebView() {}
	123
	124	virtual bool Create(wxWindow* parent,
	125	wxWindowID id,
	126	const wxString& url = wxWebViewDefaultURLStr,
	127	const wxPoint& pos = wxDefaultPosition,
	128	const wxSize& size = wxDefaultSize,
	129	long style = 0,
	130	const wxString& name = wxWebViewNameStr) = 0;
	131
	132	// Factory methods allowing the use of custom factories registered with
	133	// RegisterFactory
	134	static wxWebView* New(const wxString& backend = wxWebViewBackendDefault);
	135	static wxWebView* New(wxWindow* parent,
	136	wxWindowID id,
	137	const wxString& url = wxWebViewDefaultURLStr,
	138	const wxPoint& pos = wxDefaultPosition,
	139	const wxSize& size = wxDefaultSize,
	140	const wxString& backend = wxWebViewBackendDefault,
	141	long style = 0,
	142	const wxString& name = wxWebViewNameStr);
	143
	144	static void RegisterFactory(const wxString& backend,
	145	wxSharedPtr<wxWebViewFactory> factory);
	146
	147	// General methods
	148	virtual void EnableContextMenu(bool enable = true)
	149	{
	150	m_showMenu = enable;
	151	}
	152	virtual wxString GetCurrentTitle() const = 0;
	153	virtual wxString GetCurrentURL() const = 0;
	154	// TODO: handle choosing a frame when calling GetPageSource()?
	155	virtual wxString GetPageSource() const = 0;
	156	virtual wxString GetPageText() const = 0;
	157	virtual bool IsBusy() const = 0;
	158	virtual bool IsContextMenuEnabled() const { return m_showMenu; }
	159	virtual bool IsEditable() const = 0;
	160	virtual void LoadURL(const wxString& url) = 0;
	161	virtual void Print() = 0;
	162	virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
	163	virtual void Reload(wxWebViewReloadFlags flags = wxWEBVIEW_RELOAD_DEFAULT) = 0;
	164	virtual void RunScript(const wxString& javascript) = 0;
	165	virtual void SetEditable(bool enable = true) = 0;
	166	void SetPage(const wxString& html, const wxString& baseUrl)
	167	{
	168	DoSetPage(html, baseUrl);
	169	}
	170	void SetPage(wxInputStream& html, wxString baseUrl)
	171	{
	172	wxStringOutputStream stream;
	173	stream.Write(html);
	174	DoSetPage(stream.GetString(), baseUrl);
	175	}
	176	virtual void Stop() = 0;
	177
	178	//History
	179	virtual bool CanGoBack() const = 0;
	180	virtual bool CanGoForward() const = 0;
	181	virtual void GoBack() = 0;
	182	virtual void GoForward() = 0;
	183	virtual void ClearHistory() = 0;
	184	virtual void EnableHistory(bool enable = true) = 0;
	185	virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;
	186	virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;
	187	virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
	188
	189	//Zoom
	190	virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
	191	virtual wxWebViewZoom GetZoom() const = 0;
	192	virtual wxWebViewZoomType GetZoomType() const = 0;
	193	virtual void SetZoom(wxWebViewZoom zoom) = 0;
	194	virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
	195
	196	//Selection
	197	virtual void SelectAll() = 0;
	198	virtual bool HasSelection() const = 0;
	199	virtual void DeleteSelection() = 0;
	200	virtual wxString GetSelectedText() const = 0;
	201	virtual wxString GetSelectedSource() const = 0;
	202	virtual void ClearSelection() = 0;
	203
	204	//Clipboard functions
	205	virtual bool CanCut() const = 0;
	206	virtual bool CanCopy() const = 0;
	207	virtual bool CanPaste() const = 0;
	208	virtual void Cut() = 0;
	209	virtual void Copy() = 0;
	210	virtual void Paste() = 0;
	211
	212	//Undo / redo functionality
	213	virtual bool CanUndo() const = 0;
	214	virtual bool CanRedo() const = 0;
	215	virtual void Undo() = 0;
	216	virtual void Redo() = 0;
	217
	218	//Get the pointer to the underlying native engine.
	219	virtual void* GetNativeBackend() const = 0;
	220	//Find function
	221	virtual long Find(const wxString& text, int flags = wxWEBVIEW_FIND_DEFAULT) = 0;
	222
	223	protected:
	224	virtual void DoSetPage(const wxString& html, const wxString& baseUrl) = 0;
	225
	226	private:
	227	static void InitFactoryMap();
	228	static wxStringWebViewFactoryMap::iterator FindFactory(const wxString &backend);
	229
	230	bool m_showMenu;
	231	static wxStringWebViewFactoryMap m_factoryMap;
	232
	233	wxDECLARE_ABSTRACT_CLASS(wxWebView);
	234	};
	235
	236	class WXDLLIMPEXP_WEBVIEW wxWebViewEvent : public wxNotifyEvent
	237	{
	238	public:
	239	wxWebViewEvent() {}
	240	wxWebViewEvent(wxEventType type, int id, const wxString url,
	241	const wxString target)
	242	: wxNotifyEvent(type, id), m_url(url), m_target(target)
	243	{}
	244
	245
	246	const wxString& GetURL() const { return m_url; }
	247	const wxString& GetTarget() const { return m_target; }
	248
	249	virtual wxEvent* Clone() const { return new wxWebViewEvent(*this); }
	250	private:
	251	wxString m_url;
	252	wxString m_target;
	253
	254	wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWebViewEvent);
	255	};
	256
	257	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_WEBVIEW_NAVIGATING, wxWebViewEvent );
	258	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_WEBVIEW_NAVIGATED, wxWebViewEvent );
	259	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_WEBVIEW_LOADED, wxWebViewEvent );
	260	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_WEBVIEW_ERROR, wxWebViewEvent );
	261	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_WEBVIEW_NEWWINDOW, wxWebViewEvent );
	262	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEBVIEW, wxEVT_WEBVIEW_TITLE_CHANGED, wxWebViewEvent );
	263
	264	typedef void (wxEvtHandler::*wxWebViewEventFunction)
	265	(wxWebViewEvent&);
	266
	267	#define wxWebViewEventHandler(func) \
	268	wxEVENT_HANDLER_CAST(wxWebViewEventFunction, func)
	269
	270	#define EVT_WEBVIEW_NAVIGATING(id, fn) \
	271	wx__DECLARE_EVT1(wxEVT_WEBVIEW_NAVIGATING, id, \
	272	wxWebViewEventHandler(fn))
	273
	274	#define EVT_WEBVIEW_NAVIGATED(id, fn) \
	275	wx__DECLARE_EVT1(wxEVT_WEBVIEW_NAVIGATED, id, \
	276	wxWebViewEventHandler(fn))
	277
	278	#define EVT_WEBVIEW_LOADED(id, fn) \
	279	wx__DECLARE_EVT1(wxEVT_WEBVIEW_LOADED, id, \
	280	wxWebViewEventHandler(fn))
	281
	282	#define EVT_WEBVIEW_ERROR(id, fn) \
	283	wx__DECLARE_EVT1(wxEVT_WEBVIEW_ERROR, id, \
	284	wxWebViewEventHandler(fn))
	285
	286	#define EVT_WEBVIEW_NEWWINDOW(id, fn) \
	287	wx__DECLARE_EVT1(wxEVT_WEBVIEW_NEWWINDOW, id, \
	288	wxWebViewEventHandler(fn))
	289
	290	#define EVT_WEBVIEW_TITLE_CHANGED(id, fn) \
	291	wx__DECLARE_EVT1(wxEVT_WEBVIEW_TITLE_CHANGED, id, \
	292	wxWebViewEventHandler(fn))
	293
	294	// old wxEVT_COMMAND_* constants
	295	#define wxEVT_COMMAND_WEBVIEW_NAVIGATING wxEVT_WEBVIEW_NAVIGATING
	296	#define wxEVT_COMMAND_WEBVIEW_NAVIGATED wxEVT_WEBVIEW_NAVIGATED
	297	#define wxEVT_COMMAND_WEBVIEW_LOADED wxEVT_WEBVIEW_LOADED
	298	#define wxEVT_COMMAND_WEBVIEW_ERROR wxEVT_WEBVIEW_ERROR
	299	#define wxEVT_COMMAND_WEBVIEW_NEWWINDOW wxEVT_WEBVIEW_NEWWINDOW
	300	#define wxEVT_COMMAND_WEBVIEW_TITLE_CHANGED wxEVT_WEBVIEW_TITLE_CHANGED
	301
	302	#endif // wxUSE_WEBVIEW
	303
	304	#endif // _WX_WEBVIEW_H_