include/wx/html/webkit.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/html/webkit.h
   3 // Purpose:     wxWebKitCtrl - embeddable web kit control
   4 // Author:      Jethro Grassie / Kevin Ollivier
   5 // Modified by:
   6 // Created:     2004-4-16
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Jethro Grassie / Kevin Ollivier
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_WEBKIT_H
  13 #define _WX_WEBKIT_H
  14
  15 #if wxUSE_WEBKIT
  16
  17 #if !defined(__WXMAC__) && !defined(__WXCOCOA__)
  18 #error "wxWebKitCtrl not implemented for this platform"
  19 #endif
  20
  21 #include "wx/control.h"
  22
  23 // ----------------------------------------------------------------------------
  24 // Web Kit Control
  25 // ----------------------------------------------------------------------------
  26
  27 extern WXDLLIMPEXP_DATA_CORE(const char) wxWebKitCtrlNameStr[];
  28
  29 class WXDLLIMPEXP_CORE wxWebKitCtrl : public wxControl
  30 {
  31 public:
  32     DECLARE_DYNAMIC_CLASS(wxWebKitCtrl)
  33
  34     wxWebKitCtrl() {};
  35     wxWebKitCtrl(wxWindow *parent,
  36                     wxWindowID winID,
  37                     const wxString& strURL,
  38                     const wxPoint& pos = wxDefaultPosition,
  39                     const wxSize& size = wxDefaultSize, long style = 0,
  40                     const wxValidator& validator = wxDefaultValidator,
  41                     const wxString& name = wxWebKitCtrlNameStr)
  42     {
  43         Create(parent, winID, strURL, pos, size, style, validator, name);
  44     };
  45     bool Create(wxWindow *parent,
  46                 wxWindowID winID,
  47                 const wxString& strURL,
  48                 const wxPoint& pos = wxDefaultPosition,
  49                 const wxSize& size = wxDefaultSize, long style = 0,
  50                 const wxValidator& validator = wxDefaultValidator,
  51                 const wxString& name = wxWebKitCtrlNameStr);
  52     virtual ~wxWebKitCtrl();
  53
  54     void LoadURL(const wxString &url);
  55
  56     bool CanGoBack();
  57     bool CanGoForward();
  58     bool GoBack();
  59     bool GoForward();
  60     void Reload();
  61     void Stop();
  62     bool CanGetPageSource();
  63     wxString GetPageSource();
  64     void SetPageSource(const wxString& source, const wxString& baseUrl = wxEmptyString);
  65     wxString GetPageURL(){ return m_currentURL; }
  66     void SetPageTitle(const wxString& title) { m_pageTitle = title; }
  67     wxString GetPageTitle(){ return m_pageTitle; }
  68
  69     // since these worked in 2.6, add wrappers
  70     void SetTitle(const wxString& title) { SetPageTitle(title); }
  71     wxString GetTitle() { return GetPageTitle(); }
  72
  73     wxString GetSelection();
  74
  75     bool CanIncreaseTextSize();
  76     void IncreaseTextSize();
  77     bool CanDecreaseTextSize();
  78     void DecreaseTextSize();
  79
  80     void Print(bool showPrompt = false);
  81
  82     void MakeEditable(bool enable = true);
  83     bool IsEditable();
  84
  85     wxString RunScript(const wxString& javascript);
  86
  87     void SetScrollPos(int pos);
  88     int GetScrollPos();
  89
  90     // don't hide base class virtuals
  91     virtual void SetScrollPos( int orient, int pos, bool refresh = true )
  92         { return wxControl::SetScrollPos(orient, pos, refresh); }
  93     virtual int GetScrollPos( int orient ) const
  94         { return wxControl::GetScrollPos(orient); }
  95
  96     //we need to resize the webview when the control size changes
  97     void OnSize(wxSizeEvent &event);
  98     void OnMove(wxMoveEvent &event);
  99     void OnMouseEvents(wxMouseEvent &event);
 100 protected:
 101     DECLARE_EVENT_TABLE()
 102     void MacVisibilityChanged();
 103
 104 private:
 105     wxWindow *m_parent;
 106     wxWindowID m_windowID;
 107     wxString m_currentURL;
 108     wxString m_pageTitle;
 109
 110     struct objc_object *m_webView;
 111
 112     // we may use this later to setup our own mouse events,
 113     // so leave it in for now.
 114     void* m_webKitCtrlEventHandler;
 115     //It should be WebView*, but WebView is an Objective-C class
 116     //TODO: look into using DECLARE_WXCOCOA_OBJC_CLASS rather than this.
 117 };
 118
 119 // ----------------------------------------------------------------------------
 120 // Web Kit Events
 121 // ----------------------------------------------------------------------------
 122
 123 enum {
 124     wxWEBKIT_STATE_START = 1,
 125     wxWEBKIT_STATE_NEGOTIATING = 2,
 126     wxWEBKIT_STATE_REDIRECTING = 4,
 127     wxWEBKIT_STATE_TRANSFERRING = 8,
 128     wxWEBKIT_STATE_STOP = 16,
 129         wxWEBKIT_STATE_FAILED = 32
 130 };
 131
 132 enum {
 133     wxWEBKIT_NAV_LINK_CLICKED = 1,
 134     wxWEBKIT_NAV_BACK_NEXT = 2,
 135     wxWEBKIT_NAV_FORM_SUBMITTED = 4,
 136     wxWEBKIT_NAV_RELOAD = 8,
 137     wxWEBKIT_NAV_FORM_RESUBMITTED = 16,
 138     wxWEBKIT_NAV_OTHER = 32
 139
 140 };
 141
 142
 143
 144 class WXDLLIMPEXP_CORE wxWebKitBeforeLoadEvent : public wxCommandEvent
 145 {
 146     DECLARE_DYNAMIC_CLASS( wxWebKitBeforeLoadEvent )
 147
 148 public:
 149     bool IsCancelled() { return m_cancelled; }
 150     void Cancel(bool cancel = true) { m_cancelled = cancel; }
 151     wxString GetURL() { return m_url; }
 152     void SetURL(const wxString& url) { m_url = url; }
 153     void SetNavigationType(int navType) { m_navType = navType; }
 154     int GetNavigationType() { return m_navType; }
 155
 156     wxWebKitBeforeLoadEvent( wxWindow* win = NULL );
 157     wxEvent *Clone(void) const { return new wxWebKitBeforeLoadEvent(*this); }
 158
 159 protected:
 160     bool m_cancelled;
 161     wxString m_url;
 162     int m_navType;
 163 };
 164
 165 class WXDLLIMPEXP_CORE wxWebKitStateChangedEvent : public wxCommandEvent
 166 {
 167     DECLARE_DYNAMIC_CLASS( wxWebKitStateChangedEvent )
 168
 169 public:
 170     int GetState() { return m_state; }
 171     void SetState(const int state) { m_state = state; }
 172     wxString GetURL() { return m_url; }
 173     void SetURL(const wxString& url) { m_url = url; }
 174
 175     wxWebKitStateChangedEvent( wxWindow* win = NULL );
 176     wxEvent *Clone(void) const { return new wxWebKitStateChangedEvent(*this); }
 177
 178 protected:
 179     int m_state;
 180     wxString m_url;
 181 };
 182
 183
 184 class WXDLLIMPEXP_CORE wxWebKitNewWindowEvent : public wxCommandEvent
 185 {
 186     DECLARE_DYNAMIC_CLASS( wxWebViewNewWindowEvent )
 187 public:
 188     wxString GetURL() const { return m_url; }
 189     void SetURL(const wxString& url) { m_url = url; }
 190     wxString GetTargetName() const { return m_targetName; }
 191     void SetTargetName(const wxString& name) { m_targetName = name; }
 192
 193     wxWebKitNewWindowEvent( wxWindow* win = (wxWindow*)(NULL));
 194     wxEvent *Clone(void) const { return new wxWebKitNewWindowEvent(*this); }
 195
 196 private:
 197     wxString m_url;
 198     wxString m_targetName;
 199 };
 200
 201 typedef void (wxEvtHandler::*wxWebKitStateChangedEventFunction)(wxWebKitStateChangedEvent&);
 202 typedef void (wxEvtHandler::*wxWebKitBeforeLoadEventFunction)(wxWebKitBeforeLoadEvent&);
 203 typedef void (wxEvtHandler::*wxWebKitNewWindowEventFunction)(wxWebKitNewWindowEvent&);
 204
 205 #define wxWebKitStateChangedEventHandler( func ) \
 206     wxEVENT_HANDLER_CAST( wxWebKitStateChangedEventFunction, func )
 207
 208 #define wxWebKitBeforeLoadEventHandler( func ) \
 209     wxEVENT_HANDLER_CAST( wxWebKitBeforeLoadEventFunction, func )
 210
 211 #define wxWebKitNewWindowEventHandler( func ) \
 212     wxEVENT_HANDLER_CAST( wxWebKitNewWindowEventFunction, func )
 213
 214 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_WEBKIT_STATE_CHANGED, wxWebKitStateChangedEvent );
 215 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_WEBKIT_BEFORE_LOAD, wxWebKitBeforeLoadEvent );
 216 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_WEBKIT_NEW_WINDOW, wxWebKitNewWindowEvent );
 217
 218 #define EVT_WEBKIT_STATE_CHANGED(func) \
 219             wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBKIT_STATE_CHANGED, \
 220                             wxID_ANY, \
 221                             wxID_ANY, \
 222                             wxWebKitStateChangedEventHandler( func ), \
 223                             NULL ),
 224
 225 #define EVT_WEBKIT_BEFORE_LOAD(func) \
 226             wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBKIT_BEFORE_LOAD, \
 227                             wxID_ANY, \
 228                             wxID_ANY, \
 229                             wxWebKitBeforeLoadEventHandler( func ), \
 230                             NULL ),
 231
 232 #define EVT_WEBKIT_NEW_WINDOW(func)                              \
 233             wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_WEBKIT_NEW_WINDOW, \
 234                             wxID_ANY, \
 235                             wxID_ANY, \
 236                             wxWebKitNewWindowEventFunction( func ), \
 237                             NULL ),
 238 #endif // wxUSE_WEBKIT
 239
 240 #endif
 241     // _WX_WEBKIT_H_