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