1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Common interface and events for web view component
4 // Author: Marianne Gagnon
6 // Copyright: (c) 2010 Marianne Gagnon, 2011 Steven Lamerton
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 #ifndef _WX_WEB_VIEW_H_
11 #define _WX_WEB_VIEW_H_
17 #include "wx/control.h"
19 #include "wx/sstream.h"
20 #include "wx/sharedptr.h"
21 #include "wx/vector.h"
23 #include "wx/osx/webviewhistoryitem_webkit.h"
24 #include "wx/gtk/webviewhistoryitem_webkit.h"
25 #include "wx/msw/webviewhistoryitem_ie.h"
33 wxWEB_VIEW_ZOOM_SMALL
,
34 wxWEB_VIEW_ZOOM_MEDIUM
,
35 wxWEB_VIEW_ZOOM_LARGE
,
36 wxWEB_VIEW_ZOOM_LARGEST
39 enum wxWebViewZoomType
41 //Scales entire page, including images
42 wxWEB_VIEW_ZOOM_TYPE_LAYOUT
,
43 wxWEB_VIEW_ZOOM_TYPE_TEXT
46 enum wxWebViewNavigationError
48 wxWEB_NAV_ERR_CONNECTION
,
49 wxWEB_NAV_ERR_CERTIFICATE
,
51 wxWEB_NAV_ERR_SECURITY
,
52 wxWEB_NAV_ERR_NOT_FOUND
,
53 wxWEB_NAV_ERR_REQUEST
,
54 wxWEB_NAV_ERR_USER_CANCELLED
,
58 enum wxWebViewReloadFlags
60 //Default, may access cache
61 wxWEB_VIEW_RELOAD_DEFAULT
,
62 wxWEB_VIEW_RELOAD_NO_CACHE
67 wxWEB_VIEW_BACKEND_DEFAULT
,
68 wxWEB_VIEW_BACKEND_WEBKIT
,
72 //Base class for custom scheme handlers
73 class WXDLLIMPEXP_WEB wxWebViewHandler
76 wxWebViewHandler(const wxString
& scheme
) : m_scheme(scheme
) {}
77 virtual wxString
GetName() const { return m_scheme
; }
78 virtual wxFSFile
* GetFile(const wxString
&uri
) = 0;
83 extern WXDLLIMPEXP_DATA_WEB(const char) wxWebViewNameStr
[];
84 extern WXDLLIMPEXP_DATA_WEB(const char) wxWebViewDefaultURLStr
[];
86 class WXDLLIMPEXP_WEB wxWebView
: public wxControl
90 virtual bool Create(wxWindow
* parent
,
96 const wxString
& name
) = 0;
98 static wxWebView
* New(wxWebViewBackend backend
= wxWEB_VIEW_BACKEND_DEFAULT
);
99 static wxWebView
* New(wxWindow
* parent
,
101 const wxString
& url
= wxWebViewDefaultURLStr
,
102 const wxPoint
& pos
= wxDefaultPosition
,
103 const wxSize
& size
= wxDefaultSize
,
104 wxWebViewBackend backend
= wxWEB_VIEW_BACKEND_DEFAULT
,
106 const wxString
& name
= wxWebViewNameStr
);
109 virtual wxString
GetCurrentTitle() const = 0;
110 virtual wxString
GetCurrentURL() const = 0;
111 // TODO: handle choosing a frame when calling GetPageSource()?
112 virtual wxString
GetPageSource() const = 0;
113 virtual wxString
GetPageText() const = 0;
114 virtual bool IsBusy() const = 0;
115 virtual bool IsEditable() const = 0;
116 virtual void LoadURL(const wxString
& url
) = 0;
117 virtual void Print() = 0;
118 virtual void RegisterHandler(wxSharedPtr
<wxWebViewHandler
> handler
) = 0;
119 virtual void Reload(wxWebViewReloadFlags flags
= wxWEB_VIEW_RELOAD_DEFAULT
) = 0;
120 virtual void RunScript(const wxString
& javascript
) = 0;
121 virtual void SetEditable(bool enable
= true) = 0;
122 virtual void SetPage(const wxString
& html
, const wxString
& baseUrl
) = 0;
123 virtual void SetPage(wxInputStream
& html
, wxString baseUrl
)
125 wxStringOutputStream stream
;
127 SetPage(stream
.GetString(), baseUrl
);
129 virtual void Stop() = 0;
132 virtual bool CanGoBack() const = 0;
133 virtual bool CanGoForward() const = 0;
134 virtual void GoBack() = 0;
135 virtual void GoForward() = 0;
136 virtual void ClearHistory() = 0;
137 virtual void EnableHistory(bool enable
= true) = 0;
138 virtual wxVector
<wxSharedPtr
<wxWebViewHistoryItem
> > GetBackwardHistory() = 0;
139 virtual wxVector
<wxSharedPtr
<wxWebViewHistoryItem
> > GetForwardHistory() = 0;
140 virtual void LoadHistoryItem(wxSharedPtr
<wxWebViewHistoryItem
> item
) = 0;
143 virtual bool CanSetZoomType(wxWebViewZoomType type
) const = 0;
144 virtual wxWebViewZoom
GetZoom() const = 0;
145 virtual wxWebViewZoomType
GetZoomType() const = 0;
146 virtual void SetZoom(wxWebViewZoom zoom
) = 0;
147 virtual void SetZoomType(wxWebViewZoomType zoomType
) = 0;
150 virtual void SelectAll() = 0;
151 virtual bool HasSelection() const = 0;
152 virtual void DeleteSelection() = 0;
153 virtual wxString
GetSelectedText() const = 0;
154 virtual wxString
GetSelectedSource() const = 0;
155 virtual void ClearSelection() = 0;
157 //Clipboard functions
158 virtual bool CanCut() const = 0;
159 virtual bool CanCopy() const = 0;
160 virtual bool CanPaste() const = 0;
161 virtual void Cut() = 0;
162 virtual void Copy() = 0;
163 virtual void Paste() = 0;
165 //Undo / redo functionality
166 virtual bool CanUndo() const = 0;
167 virtual bool CanRedo() const = 0;
168 virtual void Undo() = 0;
169 virtual void Redo() = 0;
171 wxDECLARE_ABSTRACT_CLASS(wxWebView
);
174 class WXDLLIMPEXP_WEB wxWebViewEvent
: public wxNotifyEvent
178 wxWebViewEvent(wxEventType type
, int id
, const wxString url
,
179 const wxString target
)
180 : wxNotifyEvent(type
, id
), m_url(url
), m_target(target
)
184 const wxString
& GetURL() const { return m_url
; }
185 const wxString
& GetTarget() const { return m_target
; }
187 virtual wxEvent
* Clone() const { return new wxWebViewEvent(*this); }
192 wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWebViewEvent
);
195 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB
, wxEVT_COMMAND_WEB_VIEW_NAVIGATING
, wxWebViewEvent
);
196 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB
, wxEVT_COMMAND_WEB_VIEW_NAVIGATED
, wxWebViewEvent
);
197 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB
, wxEVT_COMMAND_WEB_VIEW_LOADED
, wxWebViewEvent
);
198 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB
, wxEVT_COMMAND_WEB_VIEW_ERROR
, wxWebViewEvent
);
199 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB
, wxEVT_COMMAND_WEB_VIEW_NEWWINDOW
, wxWebViewEvent
);
200 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_WEB
, wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED
, wxWebViewEvent
);
202 typedef void (wxEvtHandler::*wxWebViewEventFunction
)
205 #define wxWebViewEventHandler(func) \
206 wxEVENT_HANDLER_CAST(wxWebViewEventFunction, func)
208 #define EVT_WEB_VIEW_NAVIGATING(id, fn) \
209 wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NAVIGATING, id, \
210 wxWebViewEventHandler(fn))
212 #define EVT_WEB_VIEW_NAVIGATED(id, fn) \
213 wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NAVIGATED, id, \
214 wxWebViewEventHandler(fn))
216 #define EVT_WEB_VIEW_LOADED(id, fn) \
217 wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_LOADED, id, \
218 wxWebViewEventHandler(fn))
220 #define EVT_WEB_VIEW_ERRROR(id, fn) \
221 wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_ERROR, id, \
222 wxWebViewEventHandler(fn))
224 #define EVT_WEB_VIEW_NEWWINDOW(id, fn) \
225 wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_NEWWINDOW, id, \
226 wxWebViewEventHandler(fn))
228 #define EVT_WEB_VIEW_TITLE_CHANGED(id, fn) \
229 wx__DECLARE_EVT1(wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED, id, \
230 wxWebViewEventHandler(fn))
232 #endif // wxUSE_WEBVIEW
234 #endif // _WX_WEB_VIEW_H_