89c06dbe7a10e549dc2a19b2e7f389f48488b4b5
[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 class WebViewPrivate;
37 class WebViewFrameData;
38 class wxWebFrame;
39
40 namespace WebCore {
41     class ChromeClientWx;
42     class FrameLoaderClientWx;
43 }
44
45 #ifndef SWIG
46
47 #if WXMAKINGDLL_WEBKIT
48 #define WXDLLIMPEXP_WEBKIT WXEXPORT
49 #elif defined(WXUSINGDLL_WEBKIT)
50 #define WXDLLIMPEXP_WEBKIT WXIMPORT
51 #else
52 #define WXDLLIMPEXP_WEBKIT
53 #endif
54
55 #else 
56 #define WXDLLIMPEXP_WEBKIT
57 #endif // SWIG
58
59 extern WXDLLIMPEXP_WEBKIT const wxChar* wxWebViewNameStr;
60
61 class WXDLLIMPEXP_WEBKIT wxWebView : public wxWindow
62 {
63     // ChromeClientWx needs to get the Page* stored by the wxWebView
64     // for the createWindow function. 
65     friend class WebCore::ChromeClientWx;
66     friend class WebCore::FrameLoaderClientWx;
67
68 public:
69     // ctor(s)
70 #if SWIG
71     %pythonAppend wxWebView    "self._setOORInfo(self)"
72     %pythonAppend wxWebView()  ""
73 #endif
74
75     wxWebView(wxWindow* parent, int id = wxID_ANY,
76               const wxPoint& point = wxDefaultPosition,
77               const wxSize& size = wxDefaultSize,
78               long style = 0,
79               const wxString& name = wxWebViewNameStr); // For wxWebView internal data passing
80 #if SWIG
81     %rename(PreWebView) wxWebView();
82 #else
83     wxWebView();
84 #endif
85     
86     bool Create(wxWindow* parent, int id = wxID_ANY,
87                 const wxPoint& point = wxDefaultPosition,
88                 const wxSize& size = wxDefaultSize,
89                 long style = 0,
90                 const wxString& name = wxWebViewNameStr); // For wxWebView internal data passing
91     
92 #ifndef SWIG
93     ~wxWebView();
94 #endif
95     
96     void LoadURL(const wxString& url);
97     bool GoBack();
98     bool GoForward();
99     void Stop();
100     void Reload();
101
102     bool CanGoBack();
103     bool CanGoForward();
104     
105     bool CanCut();
106     bool CanCopy();
107     bool CanPaste();
108     
109     void Cut();
110     void Copy();
111     void Paste();
112     
113     //bool CanGetPageSource();
114     wxString GetPageSource();
115     void SetPageSource(const wxString& source, const wxString& baseUrl = wxEmptyString);
116     
117     wxString GetInnerText();
118     wxString GetAsMarkup();
119     wxString GetExternalRepresentation();
120     
121     void SetTransparent(bool transparent);
122     bool IsTransparent() const;
123     
124     wxString RunScript(const wxString& javascript);
125     
126     bool CanIncreaseTextSize() const;
127     void IncreaseTextSize();
128     bool CanDecreaseTextSize() const;
129     void DecreaseTextSize();
130     void MakeEditable(bool enable);
131     bool IsEditable() const { return m_isEditable; }
132
133     wxString GetPageTitle() const { return m_title; }
134     void SetPageTitle(const wxString& title) { m_title = title; }
135     
136     wxWebFrame* GetMainFrame() { return m_mainFrame; }
137
138 protected:
139
140     // event handlers (these functions should _not_ be virtual)
141     void OnPaint(wxPaintEvent& event);
142     void OnSize(wxSizeEvent& event);
143     void OnMouseEvents(wxMouseEvent& event);
144     void OnKeyEvents(wxKeyEvent& event);
145     void OnSetFocus(wxFocusEvent& event);
146     void OnKillFocus(wxFocusEvent& event);
147     void OnActivate(wxActivateEvent& event);
148     
149 private:
150     // any class wishing to process wxWindows events must use this macro
151 #ifndef SWIG
152     DECLARE_EVENT_TABLE()
153     DECLARE_DYNAMIC_CLASS(wxWebView)
154 #endif
155     float m_textMagnifier;
156     bool m_isEditable;
157     bool m_isInitialized;
158     bool m_beingDestroyed;
159     WebViewPrivate* m_impl;
160     wxWebFrame* m_mainFrame;
161     wxString m_title;
162     
163 };
164
165 // ----------------------------------------------------------------------------
166 // Web Kit Events
167 // ----------------------------------------------------------------------------
168
169 enum {
170     wxWEBVIEW_LOAD_STARTED = 1,
171     wxWEBVIEW_LOAD_NEGOTIATING = 2,
172     wxWEBVIEW_LOAD_REDIRECTING = 4,
173     wxWEBVIEW_LOAD_TRANSFERRING = 8,
174     wxWEBVIEW_LOAD_STOPPED = 16,
175     wxWEBVIEW_LOAD_FAILED = 32,
176     wxWEBVIEW_LOAD_DL_COMPLETED = 64,
177     wxWEBVIEW_LOAD_DOC_COMPLETED = 128,
178     wxWEBVIEW_LOAD_ONLOAD_HANDLED = 256,
179     wxWEBVIEW_LOAD_WINDOW_OBJECT_CLEARED = 512
180 };
181
182 enum {
183     wxWEBVIEW_NAV_LINK_CLICKED = 1,
184     wxWEBVIEW_NAV_BACK_NEXT = 2,
185     wxWEBVIEW_NAV_FORM_SUBMITTED = 4,
186     wxWEBVIEW_NAV_RELOAD = 8,
187     wxWEBVIEW_NAV_FORM_RESUBMITTED = 16,
188     wxWEBVIEW_NAV_OTHER = 32
189 };
190
191 class WXDLLIMPEXP_WEBKIT wxWebViewDOMElementInfo
192 {
193 public: 
194     wxWebViewDOMElementInfo();
195
196     ~wxWebViewDOMElementInfo() { }
197     
198     wxString GetTagName() const { return m_tagName; }
199     void SetTagName(const wxString& name) { m_tagName = name; }
200
201     bool IsSelected() const { return m_isSelected; }
202     void SetSelected(bool sel) { m_isSelected = sel; }
203  
204     wxString GetText() const { return m_text; }
205     void SetText(const wxString& text) { m_text = text; }
206  
207     wxString GetImageSrc() const { return m_imageSrc; }
208     void SetImageSrc(const wxString& src) { m_imageSrc = src; }
209  
210     wxString GetLink() const { return m_link; }
211     void SetLink(const wxString& link) { m_link = link; }
212
213 private:
214     void* m_domElement;
215     bool m_isSelected;
216     wxString m_tagName;
217     wxString m_text;
218     wxString m_imageSrc;
219     wxString m_link;
220 };
221
222 class WXDLLIMPEXP_WEBKIT wxWebViewBeforeLoadEvent : public wxCommandEvent
223 {
224 #ifndef SWIG
225     DECLARE_DYNAMIC_CLASS( wxWebViewBeforeLoadEvent )
226 #endif
227
228 public:
229     bool IsCancelled() const { return m_cancelled; }
230     void Cancel(bool cancel = true) { m_cancelled = cancel; }
231     wxString GetURL() const { return m_url; }
232     void SetURL(const wxString& url) { m_url = url; }
233     void SetNavigationType(int navType) { m_navType = navType; }
234     int GetNavigationType() const { return m_navType; }
235
236     wxWebViewBeforeLoadEvent( wxWindow* win = (wxWindow*) NULL );
237     wxEvent *Clone(void) const { return new wxWebViewBeforeLoadEvent(*this); }
238
239 private:
240     bool m_cancelled;
241     wxString m_url;
242     int m_navType;
243 };
244
245 class WXDLLIMPEXP_WEBKIT wxWebViewLoadEvent : public wxCommandEvent
246 {
247 #ifndef SWIG
248     DECLARE_DYNAMIC_CLASS( wxWebViewLoadEvent )
249 #endif
250
251 public:
252     int GetState() const { return m_state; }
253     void SetState(const int state) { m_state = state; }
254     wxString GetURL() const { return m_url; }
255     void SetURL(const wxString& url) { m_url = url; }
256
257     wxWebViewLoadEvent( wxWindow* win = (wxWindow*) NULL );
258     wxEvent *Clone(void) const { return new wxWebViewLoadEvent(*this); }
259
260 private:
261     int m_state;
262     wxString m_url;
263 };
264
265 class WXDLLIMPEXP_WEBKIT wxWebViewNewWindowEvent : public wxCommandEvent
266 {
267 #ifndef SWIG
268     DECLARE_DYNAMIC_CLASS( wxWebViewNewWindowEvent )
269 #endif
270
271 public:
272     wxString GetURL() const { return m_url; }
273     void SetURL(const wxString& url) { m_url = url; }
274     wxString GetTargetName() const { return m_targetName; }
275     void SetTargetName(const wxString& name) { m_targetName = name; }
276
277     wxWebViewNewWindowEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
278     wxEvent *Clone(void) const { return new wxWebViewNewWindowEvent(*this); }
279
280 private:
281     wxString m_url;
282     wxString m_targetName;
283 };
284
285 class WXDLLIMPEXP_WEBKIT wxWebViewRightClickEvent : public wxCommandEvent
286 {
287 #ifndef SWIG
288     DECLARE_DYNAMIC_CLASS( wxWebViewRightClickEvent )
289 #endif
290
291 public:
292     wxWebViewRightClickEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
293     wxEvent *Clone(void) const { return new wxWebViewRightClickEvent(*this); }
294     
295     wxWebViewDOMElementInfo GetInfo() const { return m_info; }
296     void SetInfo(wxWebViewDOMElementInfo info) { m_info = info; }
297     
298     wxPoint GetPosition() const { return m_position; }
299     void SetPosition(wxPoint pos) { m_position = pos; }
300
301 private:
302     wxWebViewDOMElementInfo m_info;
303     wxPoint m_position;
304 };
305
306 class WXDLLIMPEXP_WEBKIT wxWebViewConsoleMessageEvent : public wxCommandEvent
307 {
308 #ifndef SWIG
309     DECLARE_DYNAMIC_CLASS( wxWebViewConsoleMessageEvent )
310 #endif
311
312 public:
313     wxString GetMessage() const { return m_message; }
314     void SetMessage(const wxString& message) { m_message = message; }
315     
316     unsigned int GetLineNumber() const { return m_lineNumber; }
317     void SetLineNumber(unsigned int lineNumber) { m_lineNumber = lineNumber; }
318     
319     wxString GetSourceID() const { return m_sourceID; }
320     void SetSourceID(const wxString& sourceID) { m_sourceID = sourceID; }
321
322     wxWebViewConsoleMessageEvent( wxWindow* win = (wxWindow*) NULL );
323     wxEvent *Clone(void) const { return new wxWebViewConsoleMessageEvent(*this); }
324
325 private:
326     unsigned int m_lineNumber;
327     wxString m_message;
328     wxString m_sourceID;
329 };
330
331 class WXDLLIMPEXP_WEBKIT wxWebViewReceivedTitleEvent : public wxCommandEvent
332 {
333 #ifndef SWIG
334     DECLARE_DYNAMIC_CLASS( wxWebViewReceivedTitleEvent )
335 #endif
336
337 public:
338     wxString GetTitle() const { return m_title; }
339     void SetTitle(const wxString& title) { m_title = title; }
340
341     wxWebViewReceivedTitleEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
342     wxEvent *Clone(void) const { return new wxWebViewReceivedTitleEvent(*this); }
343
344 private:
345     wxString m_title;
346 };
347
348
349 typedef void (wxEvtHandler::*wxWebViewLoadEventFunction)(wxWebViewLoadEvent&);
350 typedef void (wxEvtHandler::*wxWebViewBeforeLoadEventFunction)(wxWebViewBeforeLoadEvent&);
351 typedef void (wxEvtHandler::*wxWebViewNewWindowEventFunction)(wxWebViewNewWindowEvent&);
352 typedef void (wxEvtHandler::*wxWebViewRightClickEventFunction)(wxWebViewRightClickEvent&);
353 typedef void (wxEvtHandler::*wxWebViewConsoleMessageEventFunction)(wxWebViewConsoleMessageEvent&);
354 typedef void (wxEvtHandler::*wxWebViewReceivedTitleEventFunction)(wxWebViewReceivedTitleEvent&);
355
356 #ifndef SWIG
357 BEGIN_DECLARE_EVENT_TYPES()
358     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_BEFORE_LOAD, wxID_ANY)
359     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_LOAD, wxID_ANY)
360     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_NEW_WINDOW, wxID_ANY)
361     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_RIGHT_CLICK, wxID_ANY)
362     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_CONSOLE_MESSAGE, wxID_ANY)
363     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_RECEIVED_TITLE, wxID_ANY)
364 END_DECLARE_EVENT_TYPES()
365 #endif
366
367 #define EVT_WEBVIEW_LOAD(winid, func)                       \
368             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_LOAD, \
369                             winid, \
370                             wxID_ANY, \
371                             (wxObjectEventFunction)   \
372                             (wxWebViewLoadEventFunction) & func, \
373                             static_cast<wxObject*>(NULL)),
374                             
375 #define EVT_WEBVIEW_BEFORE_LOAD(winid, func)                       \
376             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_BEFORE_LOAD, \
377                             winid, \
378                             wxID_ANY, \
379                             (wxObjectEventFunction)   \
380                             (wxWebViewBeforeLoadEventFunction) & func, \
381                             static_cast<wxObject*>(NULL)),
382                             
383 #define EVT_WEBVIEW_NEW_WINDOW(winid, func)                       \
384             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_NEW_WINDOW, \
385                             winid, \
386                             wxID_ANY, \
387                             (wxObjectEventFunction)   \
388                             (wxWebViewNewWindowEventFunction) & func, \
389                             static_cast<wxObject*>(NULL)),
390
391 #define EVT_WEBVIEW_RIGHT_CLICK(winid, func)                       \
392             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_RIGHT_CLICK, \
393                             winid, \
394                             wxID_ANY, \
395                             (wxObjectEventFunction)   \
396                             (wxWebViewRightClickEventFunction) & func, \
397                             static_cast<wxObject*>(NULL)),
398                             
399 #define EVT_WEBVIEW_CONSOLE_MESSAGE(winid, func)                       \
400             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_CONSOLE_MESSAGE, \
401                             winid, \
402                             wxID_ANY, \
403                             (wxObjectEventFunction)   \
404                             (wxWebViewConsoleMessageEventFunction) & func, \
405                             static_cast<wxObject*>(NULL)),
406
407 #define EVT_WEBVIEW_RECEIVED_TITLE(winid, func)                       \
408             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_RECEIVED_TITLE, \
409                             winid, \
410                             wxID_ANY, \
411                             (wxObjectEventFunction)   \
412                             (wxWebViewReceivedTitleEventFunction) & func, \
413                             static_cast<wxObject*>(NULL)),
414
415 #endif // ifndef WXWEBVIEW_H