WebKit/wx/WebFrame.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 WXWEBFRAME_H
  29 #define WXWEBFRAME_H
  30
  31 #include "wx/wxprec.h"
  32 #ifndef WX_PRECOMP
  33     #include "wx/wx.h"
  34 #endif
  35
  36 class WebFramePrivate;
  37 class WebViewFrameData;
  38 class wxWebView;
  39
  40 namespace WebCore {
  41     class ChromeClientWx;
  42     class FrameLoaderClientWx;
  43     class EditorClientWx;
  44     class Frame;
  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 class WXDLLIMPEXP_WEBKIT wxWebViewDOMElementInfo
  62 {
  63 public:
  64     wxWebViewDOMElementInfo();
  65
  66     ~wxWebViewDOMElementInfo() { }
  67
  68     wxString GetTagName() const { return m_tagName; }
  69     void SetTagName(const wxString& name) { m_tagName = name; }
  70
  71     bool IsSelected() const { return m_isSelected; }
  72     void SetSelected(bool sel) { m_isSelected = sel; }
  73
  74     wxString GetText() const { return m_text; }
  75     void SetText(const wxString& text) { m_text = text; }
  76
  77     wxString GetImageSrc() const { return m_imageSrc; }
  78     void SetImageSrc(const wxString& src) { m_imageSrc = src; }
  79
  80     wxString GetLink() const { return m_link; }
  81     void SetLink(const wxString& link) { m_link = link; }
  82
  83 private:
  84     void* m_domElement;
  85     bool m_isSelected;
  86     wxString m_tagName;
  87     wxString m_text;
  88     wxString m_imageSrc;
  89     wxString m_link;
  90 };
  91
  92 class WXDLLIMPEXP_WEBKIT wxWebFrame
  93 {
  94     // ChromeClientWx needs to get the Page* stored by the wxWebView
  95     // for the createWindow function.
  96     friend class WebCore::ChromeClientWx;
  97     friend class WebCore::FrameLoaderClientWx;
  98     friend class WebCore::EditorClientWx;
  99     friend class wxWebView;
 100
 101     wxWebFrame(wxWebView* container, wxWebFrame* parent = NULL, WebViewFrameData* data = NULL);
 102
 103     ~wxWebFrame();
 104
 105     void LoadURL(const wxString& url);
 106     bool GoBack();
 107     bool GoForward();
 108     void Stop();
 109     void Reload();
 110
 111     bool CanGoBack();
 112     bool CanGoForward();
 113
 114     bool CanCut();
 115     bool CanCopy();
 116     bool CanPaste();
 117
 118     void Cut();
 119     void Copy();
 120     void Paste();
 121
 122     bool CanUndo();
 123     bool CanRedo();
 124
 125     void Undo();
 126     void Redo();
 127
 128     wxString GetPageSource();
 129     void SetPageSource(const wxString& source, const wxString& baseUrl = wxEmptyString);
 130
 131     wxString GetInnerText();
 132     wxString GetAsMarkup();
 133     wxString GetExternalRepresentation();
 134
 135     wxString RunScript(const wxString& javascript);
 136
 137     bool FindString(const wxString& string, bool forward = true,
 138         bool caseSensitive = false, bool wrapSelection = true,
 139         bool startInSelection = true);
 140
 141     bool CanIncreaseTextSize() const;
 142     void IncreaseTextSize();
 143     bool CanDecreaseTextSize() const;
 144     void DecreaseTextSize();
 145     void MakeEditable(bool enable);
 146     bool IsEditable() const { return m_isEditable; }
 147
 148     wxString GetPageTitle() const { return m_title; }
 149     void SetPageTitle(const wxString& title) { m_title = title; }
 150
 151     WebCore::Frame* GetFrame();
 152
 153     wxWebViewDOMElementInfo HitTest(const wxPoint& post) const;
 154
 155 private:
 156     float m_textMagnifier;
 157     bool m_isEditable;
 158     bool m_isInitialized;
 159     bool m_beingDestroyed;
 160     WebFramePrivate* m_impl;
 161     wxString m_title;
 162
 163 };
 164
 165 #endif // ifndef WXWEBFRAME_H