Reviewed by Kevin Ollivier.
[WebKit.git] / WebKit / wx / WebView.h
1 /*
2  * Copyright (C) 2007 Kevin Ollivier <kevino@theolliviers.com>
3  *
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27  
28 #ifndef WXWEBVIEW_H
29 #define WXWEBVIEW_H
30
31 #include "wx/wxprec.h"
32 #ifndef WX_PRECOMP
33     #include "wx/wx.h"
34 #endif
35
36 #include "WebFrame.h"
37
38 class WebViewPrivate;
39 class WebViewFrameData;
40 class wxWebFrame;
41
42 namespace WebCore {
43     class ChromeClientWx;
44     class FrameLoaderClientWx;
45 }
46
47 #ifndef SWIG
48
49 #if WXMAKINGDLL_WEBKIT
50 #define WXDLLIMPEXP_WEBKIT WXEXPORT
51 #elif defined(WXUSINGDLL_WEBKIT)
52 #define WXDLLIMPEXP_WEBKIT WXIMPORT
53 #else
54 #define WXDLLIMPEXP_WEBKIT
55 #endif
56
57 #else 
58 #define WXDLLIMPEXP_WEBKIT
59 #endif // SWIG
60
61 extern WXDLLIMPEXP_WEBKIT const wxChar* wxWebViewNameStr;
62
63 class WXDLLIMPEXP_WEBKIT wxWebView : public wxWindow
64 {
65     // ChromeClientWx needs to get the Page* stored by the wxWebView
66     // for the createWindow function. 
67     friend class WebCore::ChromeClientWx;
68     friend class WebCore::FrameLoaderClientWx;
69
70 public:
71     // ctor(s)
72 #if SWIG
73     %pythonAppend wxWebView    "self._setOORInfo(self)"
74     %pythonAppend wxWebView()  ""
75 #endif
76
77     wxWebView(wxWindow* parent, int id = wxID_ANY,
78               const wxPoint& point = wxDefaultPosition,
79               const wxSize& size = wxDefaultSize,
80               long style = 0,
81               const wxString& name = wxWebViewNameStr); // For wxWebView internal data passing
82 #if SWIG
83     %rename(PreWebView) wxWebView();
84 #else
85     wxWebView();
86 #endif
87     
88     bool Create(wxWindow* parent, int id = wxID_ANY,
89                 const wxPoint& point = wxDefaultPosition,
90                 const wxSize& size = wxDefaultSize,
91                 long style = 0,
92                 const wxString& name = wxWebViewNameStr); // For wxWebView internal data passing
93     
94 #ifndef SWIG
95     ~wxWebView();
96 #endif
97     
98     void LoadURL(const wxString& url);
99     bool GoBack();
100     bool GoForward();
101     void Stop();
102     void Reload();
103
104     bool CanGoBack();
105     bool CanGoForward();
106     
107     bool CanCut();
108     bool CanCopy();
109     bool CanPaste();
110     
111     void Cut();
112     void Copy();
113     void Paste();
114     
115     //bool CanGetPageSource();
116     wxString GetPageSource();
117     void SetPageSource(const wxString& source, const wxString& baseUrl = wxEmptyString);
118     
119     wxString GetInnerText();
120     wxString GetAsMarkup();
121     wxString GetExternalRepresentation();
122     
123     void SetTransparent(bool transparent);
124     bool IsTransparent() const;
125     
126     wxString RunScript(const wxString& javascript);
127
128     bool FindString(const wxString& string, bool forward = true,
129         bool caseSensitive = false, bool wrapSelection = true,
130         bool startInSelection = true);
131     
132     bool CanIncreaseTextSize() const;
133     void IncreaseTextSize();
134     bool CanDecreaseTextSize() const;
135     void DecreaseTextSize();
136     void MakeEditable(bool enable);
137     bool IsEditable() const { return m_isEditable; }
138
139     wxString GetPageTitle() const { return m_title; }
140     void SetPageTitle(const wxString& title) { m_title = title; }
141     
142     wxWebFrame* GetMainFrame() { return m_mainFrame; }
143
144     wxWebViewDOMElementInfo HitTest(const wxPoint& post) const;
145
146 protected:
147
148     // event handlers (these functions should _not_ be virtual)
149     void OnPaint(wxPaintEvent& event);
150     void OnSize(wxSizeEvent& event);
151     void OnMouseEvents(wxMouseEvent& event);
152     void OnKeyEvents(wxKeyEvent& event);
153     void OnSetFocus(wxFocusEvent& event);
154     void OnKillFocus(wxFocusEvent& event);
155     void OnActivate(wxActivateEvent& event);
156     
157 private:
158     // any class wishing to process wxWindows events must use this macro
159 #ifndef SWIG
160     DECLARE_EVENT_TABLE()
161     DECLARE_DYNAMIC_CLASS(wxWebView)
162 #endif
163     float m_textMagnifier;
164     bool m_isEditable;
165     bool m_isInitialized;
166     bool m_beingDestroyed;
167     WebViewPrivate* m_impl;
168     wxWebFrame* m_mainFrame;
169     wxString m_title;
170     
171 };
172
173 // ----------------------------------------------------------------------------
174 // Web Kit Events
175 // ----------------------------------------------------------------------------
176
177 enum {
178     wxWEBVIEW_LOAD_STARTED = 1,
179     wxWEBVIEW_LOAD_NEGOTIATING = 2,
180     wxWEBVIEW_LOAD_REDIRECTING = 4,
181     wxWEBVIEW_LOAD_TRANSFERRING = 8,
182     wxWEBVIEW_LOAD_STOPPED = 16,
183     wxWEBVIEW_LOAD_FAILED = 32,
184     wxWEBVIEW_LOAD_DL_COMPLETED = 64,
185     wxWEBVIEW_LOAD_DOC_COMPLETED = 128,
186     wxWEBVIEW_LOAD_ONLOAD_HANDLED = 256,
187     wxWEBVIEW_LOAD_WINDOW_OBJECT_CLEARED = 512
188 };
189
190 enum {
191     wxWEBVIEW_NAV_LINK_CLICKED = 1,
192     wxWEBVIEW_NAV_BACK_NEXT = 2,
193     wxWEBVIEW_NAV_FORM_SUBMITTED = 4,
194     wxWEBVIEW_NAV_RELOAD = 8,
195     wxWEBVIEW_NAV_FORM_RESUBMITTED = 16,
196     wxWEBVIEW_NAV_OTHER = 32
197 };
198
199 class WXDLLIMPEXP_WEBKIT wxWebViewBeforeLoadEvent : public wxCommandEvent
200 {
201 #ifndef SWIG
202     DECLARE_DYNAMIC_CLASS( wxWebViewBeforeLoadEvent )
203 #endif
204
205 public:
206     bool IsCancelled() const { return m_cancelled; }
207     void Cancel(bool cancel = true) { m_cancelled = cancel; }
208     wxString GetURL() const { return m_url; }
209     void SetURL(const wxString& url) { m_url = url; }
210     void SetNavigationType(int navType) { m_navType = navType; }
211     int GetNavigationType() const { return m_navType; }
212
213     wxWebViewBeforeLoadEvent( wxWindow* win = (wxWindow*) NULL );
214     wxEvent *Clone(void) const { return new wxWebViewBeforeLoadEvent(*this); }
215
216 private:
217     bool m_cancelled;
218     wxString m_url;
219     int m_navType;
220 };
221
222 class WXDLLIMPEXP_WEBKIT wxWebViewLoadEvent : public wxCommandEvent
223 {
224 #ifndef SWIG
225     DECLARE_DYNAMIC_CLASS( wxWebViewLoadEvent )
226 #endif
227
228 public:
229     int GetState() const { return m_state; }
230     void SetState(const int state) { m_state = state; }
231     wxString GetURL() const { return m_url; }
232     void SetURL(const wxString& url) { m_url = url; }
233
234     wxWebViewLoadEvent( wxWindow* win = (wxWindow*) NULL );
235     wxEvent *Clone(void) const { return new wxWebViewLoadEvent(*this); }
236
237 private:
238     int m_state;
239     wxString m_url;
240 };
241
242 class WXDLLIMPEXP_WEBKIT wxWebViewNewWindowEvent : public wxCommandEvent
243 {
244 #ifndef SWIG
245     DECLARE_DYNAMIC_CLASS( wxWebViewNewWindowEvent )
246 #endif
247
248 public:
249     wxString GetURL() const { return m_url; }
250     void SetURL(const wxString& url) { m_url = url; }
251     wxString GetTargetName() const { return m_targetName; }
252     void SetTargetName(const wxString& name) { m_targetName = name; }
253
254     wxWebViewNewWindowEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
255     wxEvent *Clone(void) const { return new wxWebViewNewWindowEvent(*this); }
256
257 private:
258     wxString m_url;
259     wxString m_targetName;
260 };
261
262 class WXDLLIMPEXP_WEBKIT wxWebViewRightClickEvent : public wxCommandEvent
263 {
264 #ifndef SWIG
265     DECLARE_DYNAMIC_CLASS( wxWebViewRightClickEvent )
266 #endif
267
268 public:
269     wxWebViewRightClickEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
270     wxEvent *Clone(void) const { return new wxWebViewRightClickEvent(*this); }
271     
272     wxWebViewDOMElementInfo GetInfo() const { return m_info; }
273     void SetInfo(wxWebViewDOMElementInfo info) { m_info = info; }
274     
275     wxPoint GetPosition() const { return m_position; }
276     void SetPosition(wxPoint pos) { m_position = pos; }
277
278 private:
279     wxWebViewDOMElementInfo m_info;
280     wxPoint m_position;
281 };
282
283 class WXDLLIMPEXP_WEBKIT wxWebViewConsoleMessageEvent : public wxCommandEvent
284 {
285 #ifndef SWIG
286     DECLARE_DYNAMIC_CLASS( wxWebViewConsoleMessageEvent )
287 #endif
288
289 public:
290     wxString GetMessage() const { return m_message; }
291     void SetMessage(const wxString& message) { m_message = message; }
292     
293     unsigned int GetLineNumber() const { return m_lineNumber; }
294     void SetLineNumber(unsigned int lineNumber) { m_lineNumber = lineNumber; }
295     
296     wxString GetSourceID() const { return m_sourceID; }
297     void SetSourceID(const wxString& sourceID) { m_sourceID = sourceID; }
298
299     wxWebViewConsoleMessageEvent( wxWindow* win = (wxWindow*) NULL );
300     wxEvent *Clone(void) const { return new wxWebViewConsoleMessageEvent(*this); }
301
302 private:
303     unsigned int m_lineNumber;
304     wxString m_message;
305     wxString m_sourceID;
306 };
307
308 class WXDLLIMPEXP_WEBKIT wxWebViewReceivedTitleEvent : public wxCommandEvent
309 {
310 #ifndef SWIG
311     DECLARE_DYNAMIC_CLASS( wxWebViewReceivedTitleEvent )
312 #endif
313
314 public:
315     wxString GetTitle() const { return m_title; }
316     void SetTitle(const wxString& title) { m_title = title; }
317
318     wxWebViewReceivedTitleEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
319     wxEvent *Clone(void) const { return new wxWebViewReceivedTitleEvent(*this); }
320
321 private:
322     wxString m_title;
323 };
324
325
326 typedef void (wxEvtHandler::*wxWebViewLoadEventFunction)(wxWebViewLoadEvent&);
327 typedef void (wxEvtHandler::*wxWebViewBeforeLoadEventFunction)(wxWebViewBeforeLoadEvent&);
328 typedef void (wxEvtHandler::*wxWebViewNewWindowEventFunction)(wxWebViewNewWindowEvent&);
329 typedef void (wxEvtHandler::*wxWebViewRightClickEventFunction)(wxWebViewRightClickEvent&);
330 typedef void (wxEvtHandler::*wxWebViewConsoleMessageEventFunction)(wxWebViewConsoleMessageEvent&);
331 typedef void (wxEvtHandler::*wxWebViewReceivedTitleEventFunction)(wxWebViewReceivedTitleEvent&);
332
333 #ifndef SWIG
334 BEGIN_DECLARE_EVENT_TYPES()
335     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_BEFORE_LOAD, wxID_ANY)
336     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_LOAD, wxID_ANY)
337     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_NEW_WINDOW, wxID_ANY)
338     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_RIGHT_CLICK, wxID_ANY)
339     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_CONSOLE_MESSAGE, wxID_ANY)
340     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_RECEIVED_TITLE, wxID_ANY)
341 END_DECLARE_EVENT_TYPES()
342 #endif
343
344 #define EVT_WEBVIEW_LOAD(winid, func)                       \
345             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_LOAD, \
346                             winid, \
347                             wxID_ANY, \
348                             (wxObjectEventFunction)   \
349                             (wxWebViewLoadEventFunction) & func, \
350                             static_cast<wxObject*>(NULL)),
351                             
352 #define EVT_WEBVIEW_BEFORE_LOAD(winid, func)                       \
353             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_BEFORE_LOAD, \
354                             winid, \
355                             wxID_ANY, \
356                             (wxObjectEventFunction)   \
357                             (wxWebViewBeforeLoadEventFunction) & func, \
358                             static_cast<wxObject*>(NULL)),
359                             
360 #define EVT_WEBVIEW_NEW_WINDOW(winid, func)                       \
361             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_NEW_WINDOW, \
362                             winid, \
363                             wxID_ANY, \
364                             (wxObjectEventFunction)   \
365                             (wxWebViewNewWindowEventFunction) & func, \
366                             static_cast<wxObject*>(NULL)),
367
368 #define EVT_WEBVIEW_RIGHT_CLICK(winid, func)                       \
369             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_RIGHT_CLICK, \
370                             winid, \
371                             wxID_ANY, \
372                             (wxObjectEventFunction)   \
373                             (wxWebViewRightClickEventFunction) & func, \
374                             static_cast<wxObject*>(NULL)),
375                             
376 #define EVT_WEBVIEW_CONSOLE_MESSAGE(winid, func)                       \
377             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_CONSOLE_MESSAGE, \
378                             winid, \
379                             wxID_ANY, \
380                             (wxObjectEventFunction)   \
381                             (wxWebViewConsoleMessageEventFunction) & func, \
382                             static_cast<wxObject*>(NULL)),
383
384 #define EVT_WEBVIEW_RECEIVED_TITLE(winid, func)                       \
385             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_RECEIVED_TITLE, \
386                             winid, \
387                             wxID_ANY, \
388                             (wxObjectEventFunction)   \
389                             (wxWebViewReceivedTitleEventFunction) & func, \
390                             static_cast<wxObject*>(NULL)),
391
392 #endif // ifndef WXWEBVIEW_H