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