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