2009-01-10 Darin Adler <darin@apple.com>
[WebKit-https.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 OnContextMenuEvents(wxContextMenuEvent& event);
153     void OnMenuSelectEvents(wxCommandEvent& event);
154     void OnKeyEvents(wxKeyEvent& event);
155     void OnSetFocus(wxFocusEvent& event);
156     void OnKillFocus(wxFocusEvent& event);
157     void OnActivate(wxActivateEvent& event);
158     
159 private:
160     // any class wishing to process wxWindows events must use this macro
161 #ifndef SWIG
162     DECLARE_EVENT_TABLE()
163     DECLARE_DYNAMIC_CLASS(wxWebView)
164 #endif
165     float m_textMagnifier;
166     bool m_isEditable;
167     bool m_isInitialized;
168     bool m_beingDestroyed;
169     WebViewPrivate* m_impl;
170     wxWebFrame* m_mainFrame;
171     wxString m_title;
172     
173 };
174
175 // ----------------------------------------------------------------------------
176 // Web Kit Events
177 // ----------------------------------------------------------------------------
178
179 enum {
180     wxWEBVIEW_LOAD_STARTED = 1,
181     wxWEBVIEW_LOAD_NEGOTIATING = 2,
182     wxWEBVIEW_LOAD_REDIRECTING = 4,
183     wxWEBVIEW_LOAD_TRANSFERRING = 8,
184     wxWEBVIEW_LOAD_STOPPED = 16,
185     wxWEBVIEW_LOAD_FAILED = 32,
186     wxWEBVIEW_LOAD_DL_COMPLETED = 64,
187     wxWEBVIEW_LOAD_DOC_COMPLETED = 128,
188     wxWEBVIEW_LOAD_ONLOAD_HANDLED = 256,
189     wxWEBVIEW_LOAD_WINDOW_OBJECT_CLEARED = 512
190 };
191
192 enum {
193     wxWEBVIEW_NAV_LINK_CLICKED = 1,
194     wxWEBVIEW_NAV_BACK_NEXT = 2,
195     wxWEBVIEW_NAV_FORM_SUBMITTED = 4,
196     wxWEBVIEW_NAV_RELOAD = 8,
197     wxWEBVIEW_NAV_FORM_RESUBMITTED = 16,
198     wxWEBVIEW_NAV_OTHER = 32
199 };
200
201 class WXDLLIMPEXP_WEBKIT wxWebViewBeforeLoadEvent : public wxCommandEvent
202 {
203 #ifndef SWIG
204     DECLARE_DYNAMIC_CLASS( wxWebViewBeforeLoadEvent )
205 #endif
206
207 public:
208     bool IsCancelled() const { return m_cancelled; }
209     void Cancel(bool cancel = true) { m_cancelled = cancel; }
210     wxString GetURL() const { return m_url; }
211     void SetURL(const wxString& url) { m_url = url; }
212     void SetNavigationType(int navType) { m_navType = navType; }
213     int GetNavigationType() const { return m_navType; }
214
215     wxWebViewBeforeLoadEvent( wxWindow* win = (wxWindow*) NULL );
216     wxEvent *Clone(void) const { return new wxWebViewBeforeLoadEvent(*this); }
217
218 private:
219     bool m_cancelled;
220     wxString m_url;
221     int m_navType;
222 };
223
224 class WXDLLIMPEXP_WEBKIT wxWebViewLoadEvent : public wxCommandEvent
225 {
226 #ifndef SWIG
227     DECLARE_DYNAMIC_CLASS( wxWebViewLoadEvent )
228 #endif
229
230 public:
231     int GetState() const { return m_state; }
232     void SetState(const int state) { m_state = state; }
233     wxString GetURL() const { return m_url; }
234     void SetURL(const wxString& url) { m_url = url; }
235
236     wxWebViewLoadEvent( wxWindow* win = (wxWindow*) NULL );
237     wxEvent *Clone(void) const { return new wxWebViewLoadEvent(*this); }
238
239 private:
240     int m_state;
241     wxString m_url;
242 };
243
244 class WXDLLIMPEXP_WEBKIT wxWebViewNewWindowEvent : public wxCommandEvent
245 {
246 #ifndef SWIG
247     DECLARE_DYNAMIC_CLASS( wxWebViewNewWindowEvent )
248 #endif
249
250 public:
251     wxString GetURL() const { return m_url; }
252     void SetURL(const wxString& url) { m_url = url; }
253     wxString GetTargetName() const { return m_targetName; }
254     void SetTargetName(const wxString& name) { m_targetName = name; }
255
256     wxWebViewNewWindowEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
257     wxEvent *Clone(void) const { return new wxWebViewNewWindowEvent(*this); }
258
259 private:
260     wxString m_url;
261     wxString m_targetName;
262 };
263
264 class WXDLLIMPEXP_WEBKIT wxWebViewRightClickEvent : public wxCommandEvent
265 {
266 #ifndef SWIG
267     DECLARE_DYNAMIC_CLASS( wxWebViewRightClickEvent )
268 #endif
269
270 public:
271     wxWebViewRightClickEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
272     wxEvent *Clone(void) const { return new wxWebViewRightClickEvent(*this); }
273     
274     wxWebViewDOMElementInfo GetInfo() const { return m_info; }
275     void SetInfo(wxWebViewDOMElementInfo info) { m_info = info; }
276     
277     wxPoint GetPosition() const { return m_position; }
278     void SetPosition(wxPoint pos) { m_position = pos; }
279
280 private:
281     wxWebViewDOMElementInfo m_info;
282     wxPoint m_position;
283 };
284
285 class WXDLLIMPEXP_WEBKIT wxWebViewConsoleMessageEvent : public wxCommandEvent
286 {
287 #ifndef SWIG
288     DECLARE_DYNAMIC_CLASS( wxWebViewConsoleMessageEvent )
289 #endif
290
291 public:
292     wxString GetMessage() const { return m_message; }
293     void SetMessage(const wxString& message) { m_message = message; }
294     
295     unsigned int GetLineNumber() const { return m_lineNumber; }
296     void SetLineNumber(unsigned int lineNumber) { m_lineNumber = lineNumber; }
297     
298     wxString GetSourceID() const { return m_sourceID; }
299     void SetSourceID(const wxString& sourceID) { m_sourceID = sourceID; }
300
301     wxWebViewConsoleMessageEvent( wxWindow* win = (wxWindow*) NULL );
302     wxEvent *Clone(void) const { return new wxWebViewConsoleMessageEvent(*this); }
303
304 private:
305     unsigned int m_lineNumber;
306     wxString m_message;
307     wxString m_sourceID;
308 };
309
310 class WXDLLIMPEXP_WEBKIT wxWebViewReceivedTitleEvent : public wxCommandEvent
311 {
312 #ifndef SWIG
313     DECLARE_DYNAMIC_CLASS( wxWebViewReceivedTitleEvent )
314 #endif
315
316 public:
317     wxString GetTitle() const { return m_title; }
318     void SetTitle(const wxString& title) { m_title = title; }
319
320     wxWebViewReceivedTitleEvent( wxWindow* win = static_cast<wxWindow*>(NULL));
321     wxEvent *Clone(void) const { return new wxWebViewReceivedTitleEvent(*this); }
322
323 private:
324     wxString m_title;
325 };
326
327
328 typedef void (wxEvtHandler::*wxWebViewLoadEventFunction)(wxWebViewLoadEvent&);
329 typedef void (wxEvtHandler::*wxWebViewBeforeLoadEventFunction)(wxWebViewBeforeLoadEvent&);
330 typedef void (wxEvtHandler::*wxWebViewNewWindowEventFunction)(wxWebViewNewWindowEvent&);
331 typedef void (wxEvtHandler::*wxWebViewRightClickEventFunction)(wxWebViewRightClickEvent&);
332 typedef void (wxEvtHandler::*wxWebViewConsoleMessageEventFunction)(wxWebViewConsoleMessageEvent&);
333 typedef void (wxEvtHandler::*wxWebViewReceivedTitleEventFunction)(wxWebViewReceivedTitleEvent&);
334
335 #ifndef SWIG
336 BEGIN_DECLARE_EVENT_TYPES()
337     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_BEFORE_LOAD, wxID_ANY)
338     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_LOAD, wxID_ANY)
339     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_NEW_WINDOW, wxID_ANY)
340     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_RIGHT_CLICK, wxID_ANY)
341     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_CONSOLE_MESSAGE, wxID_ANY)
342     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_WEBKIT, wxEVT_WEBVIEW_RECEIVED_TITLE, wxID_ANY)
343 END_DECLARE_EVENT_TYPES()
344 #endif
345
346 #define EVT_WEBVIEW_LOAD(winid, func)                       \
347             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_LOAD, \
348                             winid, \
349                             wxID_ANY, \
350                             (wxObjectEventFunction)   \
351                             (wxWebViewLoadEventFunction) & func, \
352                             static_cast<wxObject*>(NULL)),
353                             
354 #define EVT_WEBVIEW_BEFORE_LOAD(winid, func)                       \
355             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_BEFORE_LOAD, \
356                             winid, \
357                             wxID_ANY, \
358                             (wxObjectEventFunction)   \
359                             (wxWebViewBeforeLoadEventFunction) & func, \
360                             static_cast<wxObject*>(NULL)),
361                             
362 #define EVT_WEBVIEW_NEW_WINDOW(winid, func)                       \
363             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_NEW_WINDOW, \
364                             winid, \
365                             wxID_ANY, \
366                             (wxObjectEventFunction)   \
367                             (wxWebViewNewWindowEventFunction) & func, \
368                             static_cast<wxObject*>(NULL)),
369
370 #define EVT_WEBVIEW_RIGHT_CLICK(winid, func)                       \
371             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_RIGHT_CLICK, \
372                             winid, \
373                             wxID_ANY, \
374                             (wxObjectEventFunction)   \
375                             (wxWebViewRightClickEventFunction) & func, \
376                             static_cast<wxObject*>(NULL)),
377                             
378 #define EVT_WEBVIEW_CONSOLE_MESSAGE(winid, func)                       \
379             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_CONSOLE_MESSAGE, \
380                             winid, \
381                             wxID_ANY, \
382                             (wxObjectEventFunction)   \
383                             (wxWebViewConsoleMessageEventFunction) & func, \
384                             static_cast<wxObject*>(NULL)),
385
386 #define EVT_WEBVIEW_RECEIVED_TITLE(winid, func)                       \
387             DECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBVIEW_RECEIVED_TITLE, \
388                             winid, \
389                             wxID_ANY, \
390                             (wxObjectEventFunction)   \
391                             (wxWebViewReceivedTitleEventFunction) & func, \
392                             static_cast<wxObject*>(NULL)),
393
394 #endif // ifndef WXWEBVIEW_H