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