include/wx/osx/webview_webkit.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        include/wx/osx/webkit.h
   3 // Purpose:     wxWebViewWebKit - embeddable web kit control,
   4 //                             OS X implementation of web view component
   5 // Author:      Jethro Grassie / Kevin Ollivier / Marianne Gagnon
   6 // Modified by:
   7 // Created:     2004-4-16
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) Jethro Grassie / Kevin Ollivier / Marianne Gagnon
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_WEBKIT_H
  14 #define _WX_WEBKIT_H
  15
  16 #include "wx/setup.h"
  17
  18 #if wxUSE_WEBVIEW_WEBKIT && (defined(__WXOSX_COCOA__) \
  19                          ||  defined(__WXOSX_CARBON__))
  20
  21 #include "wx/control.h"
  22 #include "wx/webview.h"
  23
  24 // ----------------------------------------------------------------------------
  25 // Web Kit Control
  26 // ----------------------------------------------------------------------------
  27
  28 class wxMacControl;
  29 class wxWidgetCocoaImpl;
  30
  31 class WXDLLIMPEXP_WEB wxWebViewWebKit : public wxWebView
  32 {
  33 public:
  34     wxDECLARE_DYNAMIC_CLASS(wxWebViewWebKit);
  35
  36     wxWebViewWebKit() {}
  37     wxWebViewWebKit(wxWindow *parent,
  38                     wxWindowID winID = wxID_ANY,
  39                     const wxString& strURL = wxWebViewDefaultURLStr,
  40                     const wxPoint& pos = wxDefaultPosition,
  41                     const wxSize& size = wxDefaultSize, long style = 0,
  42                     const wxString& name = wxWebViewNameStr)
  43     {
  44         Create(parent, winID, strURL, pos, size, style, name);
  45     }
  46     bool Create(wxWindow *parent,
  47                 wxWindowID winID = wxID_ANY,
  48                 const wxString& strURL = wxWebViewDefaultURLStr,
  49                 const wxPoint& pos = wxDefaultPosition,
  50                 const wxSize& size = wxDefaultSize, long style = 0,
  51                 const wxString& name = wxWebViewNameStr);
  52     virtual ~wxWebViewWebKit();
  53
  54     void InternalLoadURL(const wxString &url);
  55
  56     virtual bool CanGoBack();
  57     virtual bool CanGoForward();
  58     virtual void GoBack();
  59     virtual void GoForward();
  60     virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT);
  61     virtual void Stop();
  62     virtual wxString GetPageSource();
  63     virtual wxString GetPageText() { return ""; }
  64     virtual void SetPageTitle(const wxString& title) { m_pageTitle = title; }
  65     virtual wxString GetPageTitle(){ return m_pageTitle; }
  66
  67     //We do not want to hide the other overloads
  68     using wxWebView::SetPage;
  69     virtual void SetPage(const wxString& html, const wxString& baseUrl);
  70
  71     virtual void Print();
  72
  73     virtual void LoadUrl(const wxString& url);
  74     virtual wxString GetCurrentURL();
  75     virtual wxString GetCurrentTitle();
  76     virtual wxWebViewZoom GetZoom();
  77     virtual void SetZoom(wxWebViewZoom zoom);
  78
  79     virtual void SetZoomType(wxWebViewZoomType zoomType);
  80     virtual wxWebViewZoomType GetZoomType() const;
  81     virtual bool CanSetZoomType(wxWebViewZoomType type) const;
  82
  83     virtual bool IsBusy() { return m_busy; }
  84
  85     //History functions
  86     virtual void ClearHistory();
  87     virtual void EnableHistory(bool enable = true);
  88     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory();
  89     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory();
  90     virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item);
  91
  92     //Undo / redo functionality
  93     virtual bool CanUndo();
  94     virtual bool CanRedo();
  95     virtual void Undo();
  96     virtual void Redo();
  97
  98     //Clipboard functions
  99     virtual bool CanCut() { return false; }
 100     virtual bool CanCopy() { return false; }
 101     virtual bool CanPaste() { return false; }
 102     virtual void Cut();
 103     virtual void Copy();
 104     virtual void Paste();
 105
 106     //Editing functions
 107     virtual void SetEditable(bool enable = true);
 108     virtual bool IsEditable();
 109
 110     //Selection
 111     virtual void DeleteSelection();
 112     virtual bool HasSelection();
 113     virtual void SelectAll() {};
 114     virtual wxString GetSelectedText();
 115     virtual wxString GetSelectedSource() { return ""; }
 116     virtual void ClearSelection() {}
 117
 118     void RunScript(const wxString& javascript);
 119
 120     //Virtual Filesystem Support
 121     virtual void RegisterHandler(wxWebHandler* WXUNUSED(handler)) {};
 122
 123     // ---- methods not from the parent (common) interface
 124     bool  CanGetPageSource();
 125
 126     void  SetScrollPos(int pos);
 127     int   GetScrollPos();
 128
 129     bool  CanIncreaseTextSize();
 130     void  IncreaseTextSize();
 131     bool  CanDecreaseTextSize();
 132     void  DecreaseTextSize();
 133
 134     float GetWebkitZoom();
 135     void  SetWebkitZoom(float zoom);
 136
 137     // don't hide base class virtuals
 138     virtual void SetScrollPos( int orient, int pos, bool refresh = true )
 139         { return wxControl::SetScrollPos(orient, pos, refresh); }
 140     virtual int GetScrollPos( int orient ) const
 141         { return wxControl::GetScrollPos(orient); }
 142
 143     //we need to resize the webview when the control size changes
 144     void OnSize(wxSizeEvent &event);
 145     void OnMove(wxMoveEvent &event);
 146     void OnMouseEvents(wxMouseEvent &event);
 147
 148     bool m_busy;
 149
 150 protected:
 151     DECLARE_EVENT_TABLE()
 152     void MacVisibilityChanged();
 153
 154 private:
 155     wxWindow *m_parent;
 156     wxWindowID m_windowID;
 157     wxString m_pageTitle;
 158
 159     struct objc_object *m_webView;
 160
 161     // we may use this later to setup our own mouse events,
 162     // so leave it in for now.
 163     void* m_webKitCtrlEventHandler;
 164     //It should be WebView*, but WebView is an Objective-C class
 165     //TODO: look into using DECLARE_WXCOCOA_OBJC_CLASS rather than this.
 166
 167 #if wxOSX_USE_CARBON
 168     wxMacControl *m_peer;
 169 #else
 170     wxWidgetCocoaImpl *m_peer;
 171 #endif
 172 };
 173
 174 #endif // wxUSE_WEBKIT
 175
 176 #endif // _WX_WEBKIT_H_