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             { return wxVector<wxSharedPtr<wxWebHistoryItem> >(); }
  90     virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory()
  91             { return wxVector<wxSharedPtr<wxWebHistoryItem> >(); }
  92     virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> WXUNUSED(item)) {}
  93
  94     //Undo / redo functionality
  95     virtual bool CanUndo() { return false; }
  96     virtual bool CanRedo() { return false; }
  97     virtual void Undo() {}
  98     virtual void Redo() {}
  99
 100     //Clipboard functions
 101     virtual bool CanCut() { return false; }
 102     virtual bool CanCopy() { return false; }
 103     virtual bool CanPaste() { return false; }
 104     virtual void Cut();
 105     virtual void Copy();
 106     virtual void Paste();
 107
 108     //Editing functions
 109     virtual void SetEditable(bool enable = true);
 110     virtual bool IsEditable();
 111
 112     //Selection
 113     virtual void DeleteSelection();
 114     virtual bool HasSelection();
 115     virtual void SelectAll() {};
 116     virtual wxString GetSelectedText();
 117     virtual wxString GetSelectedSource() { return ""; }
 118     virtual void ClearSelection() {}
 119
 120     void RunScript(const wxString& javascript);
 121
 122     //Virtual Filesystem Support
 123     virtual void RegisterHandler(wxWebHandler* WXUNUSED(handler)) {};
 124
 125     // ---- methods not from the parent (common) interface
 126     bool  CanGetPageSource();
 127
 128     void  SetScrollPos(int pos);
 129     int   GetScrollPos();
 130
 131     wxString GetSelection();
 132
 133     bool  CanIncreaseTextSize();
 134     void  IncreaseTextSize();
 135     bool  CanDecreaseTextSize();
 136     void  DecreaseTextSize();
 137
 138     float GetWebkitZoom();
 139     void  SetWebkitZoom(float zoom);
 140
 141     // don't hide base class virtuals
 142     virtual void SetScrollPos( int orient, int pos, bool refresh = true )
 143         { return wxControl::SetScrollPos(orient, pos, refresh); }
 144     virtual int GetScrollPos( int orient ) const
 145         { return wxControl::GetScrollPos(orient); }
 146
 147     //we need to resize the webview when the control size changes
 148     void OnSize(wxSizeEvent &event);
 149     void OnMove(wxMoveEvent &event);
 150     void OnMouseEvents(wxMouseEvent &event);
 151
 152     bool m_busy;
 153
 154 protected:
 155     DECLARE_EVENT_TABLE()
 156     void MacVisibilityChanged();
 157
 158 private:
 159     wxWindow *m_parent;
 160     wxWindowID m_windowID;
 161     wxString m_pageTitle;
 162
 163     struct objc_object *m_webView;
 164
 165     // we may use this later to setup our own mouse events,
 166     // so leave it in for now.
 167     void* m_webKitCtrlEventHandler;
 168     //It should be WebView*, but WebView is an Objective-C class
 169     //TODO: look into using DECLARE_WXCOCOA_OBJC_CLASS rather than this.
 170
 171 #if wxOSX_USE_CARBON
 172     wxMacControl *m_peer;
 173 #else
 174     wxWidgetCocoaImpl *m_peer;
 175 #endif
 176 };
 177
 178 #endif // wxUSE_WEBKIT
 179
 180 #endif // _WX_WEBKIT_H_