Reviewed by Kevin Ollivier.
[WebKit.git] / 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 WebViewPrivate;
37 class WebViewFrameData;
38 class wxWebView;
39
40 namespace WebCore {
41     class ChromeClientWx;
42     class FrameLoaderClientWx;
43     class Frame;
44 }
45
46 #ifndef SWIG
47
48 #if WXMAKINGDLL_WEBKIT
49 #define WXDLLIMPEXP_WEBKIT WXEXPORT
50 #elif defined(WXUSINGDLL_WEBKIT)
51 #define WXDLLIMPEXP_WEBKIT WXIMPORT
52 #else
53 #define WXDLLIMPEXP_WEBKIT
54 #endif
55
56 #else 
57 #define WXDLLIMPEXP_WEBKIT
58 #endif // SWIG
59
60 class WXDLLIMPEXP_WEBKIT wxWebFrame
61 {
62     // ChromeClientWx needs to get the Page* stored by the wxWebView
63     // for the createWindow function. 
64     friend class WebCore::ChromeClientWx;
65     friend class WebCore::FrameLoaderClientWx;
66     friend class wxWebView;
67
68     wxWebFrame(wxWebView* container, wxWebFrame* parent = NULL, WebViewFrameData* data = NULL);
69     
70     ~wxWebFrame();
71     
72     void LoadURL(const wxString& url);
73     bool GoBack();
74     bool GoForward();
75     void Stop();
76     void Reload();
77     
78     bool CanGoBack();
79     bool CanGoForward();
80     
81     bool CanCut();
82     bool CanCopy();
83     bool CanPaste();
84     
85     void Cut();
86     void Copy();
87     void Paste();
88     
89     wxString GetPageSource();
90     void SetPageSource(const wxString& source, const wxString& baseUrl = wxEmptyString);
91     
92     wxString GetInnerText();
93     wxString GetAsMarkup();
94     wxString GetExternalRepresentation();
95     
96     wxString RunScript(const wxString& javascript);
97     
98     bool CanIncreaseTextSize() const;
99     void IncreaseTextSize();
100     bool CanDecreaseTextSize() const;
101     void DecreaseTextSize();
102     void MakeEditable(bool enable);
103     bool IsEditable() const { return m_isEditable; }
104
105     wxString GetPageTitle() const { return m_title; }
106     void SetPageTitle(const wxString& title) { m_title = title; }
107     
108     WebCore::Frame* GetFrame();
109     
110 private:
111     float m_textMagnifier;
112     bool m_isEditable;
113     bool m_isInitialized;
114     bool m_beingDestroyed;
115     WebViewPrivate* m_impl;
116     wxString m_title;
117     
118 };
119
120 #endif // ifndef WXWEBFRAME_H