7c8841a843960e6a08295014e101b8c6e68f9db1
[WebKit.git] / Source / WebKit2 / UIProcess / API / qt / qquickwebview_p.h
1 /*
2  * Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies)
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this program; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef qquickwebview_p_h
22 #define qquickwebview_p_h
23
24 #include "qwebkitglobal.h"
25 #include <QtDeclarative/qquickitem.h>
26
27 class QDeclarativeComponent;
28 class QQuickWebPage;
29 class QQuickWebViewAttached;
30 class QQuickWebViewPrivate;
31 class QQuickWebViewExperimental;
32 class QWebDownloadItem;
33 class QWebPreferences;
34
35 namespace WTR {
36 class PlatformWebView;
37 }
38
39 typedef const struct OpaqueWKContext* WKContextRef;
40 typedef const struct OpaqueWKPageGroup* WKPageGroupRef;
41 typedef const struct OpaqueWKPage* WKPageRef;
42
43 QT_BEGIN_NAMESPACE
44 class QPainter;
45 class QUrl;
46 QT_END_NAMESPACE
47
48 class QWEBKIT_EXPORT QQuickWebView : public QQuickItem {
49     Q_OBJECT
50     Q_PROPERTY(QString title READ title NOTIFY titleChanged)
51     Q_PROPERTY(QUrl url READ url NOTIFY urlChanged)
52     Q_PROPERTY(int loadProgress READ loadProgress NOTIFY loadProgressChanged)
53     Q_PROPERTY(bool canGoBack READ canGoBack NOTIFY navigationStateChanged FINAL)
54     Q_PROPERTY(bool canGoForward READ canGoForward NOTIFY navigationStateChanged FINAL)
55     Q_PROPERTY(bool canStop READ canStop NOTIFY navigationStateChanged FINAL)
56     Q_PROPERTY(bool canReload READ canReload NOTIFY navigationStateChanged FINAL)
57     Q_PROPERTY(QWebPreferences* preferences READ preferences CONSTANT FINAL)
58     Q_PROPERTY(QQuickWebPage* page READ page CONSTANT FINAL)
59     Q_ENUMS(NavigationPolicy)
60     Q_ENUMS(ErrorType)
61 public:
62     enum NavigationPolicy {
63         UsePolicy,
64         DownloadPolicy,
65         IgnorePolicy
66     };
67
68     enum ErrorType {
69         EngineError,
70         NetworkError,
71         HttpError,
72         DownloadError
73     };
74     QQuickWebView(QQuickItem* parent = 0);
75     virtual ~QQuickWebView();
76
77     QUrl url() const;
78     QString title() const;
79     int loadProgress() const;
80
81     bool canGoBack() const;
82     bool canGoForward() const;
83     bool canStop() const;
84     bool canReload() const;
85
86     QWebPreferences* preferences() const;
87     QQuickWebPage* page();
88
89     QQuickWebViewExperimental* experimental() const;
90     static QQuickWebViewAttached* qmlAttachedProperties(QObject*);
91
92 public Q_SLOTS:
93     void load(const QUrl&);
94     void postMessage(const QString&);
95     void loadHtml(const QString& html, const QUrl& baseUrl = QUrl());
96
97     void goBack();
98     void goForward();
99     void stop();
100     void reload();
101
102 Q_SIGNALS:
103     void titleChanged(const QString& title);
104     void statusBarMessageChanged(const QString& message);
105     void loadStarted();
106     void loadSucceeded();
107     void loadFailed(QQuickWebView::ErrorType errorType, int errorCode, const QUrl& url);
108     void loadProgressChanged(int progress);
109     void urlChanged(const QUrl& url);
110     void messageReceived(const QVariantMap& message);
111     void downloadRequested(QWebDownloadItem* downloadItem);
112     void linkHovered(const QUrl& url, const QString& title);
113     void viewModeChanged();
114     void navigationStateChanged();
115
116 protected:
117     virtual void geometryChanged(const QRectF&, const QRectF&);
118     virtual void focusInEvent(QFocusEvent*);
119     virtual void focusOutEvent(QFocusEvent*);
120     virtual void touchEvent(QTouchEvent* event);
121
122 private:
123     Q_DECLARE_PRIVATE(QQuickWebView)
124
125     QQuickWebView(WKContextRef, WKPageGroupRef, QQuickItem* parent = 0);
126     WKPageRef pageRef() const;
127
128     Q_PRIVATE_SLOT(d_func(), void _q_viewportUpdated());
129     Q_PRIVATE_SLOT(d_func(), void _q_viewportTrajectoryVectorChanged(const QPointF&));
130     Q_PRIVATE_SLOT(d_func(), void _q_onOpenPanelFilesSelected());
131     Q_PRIVATE_SLOT(d_func(), void _q_onOpenPanelFinished(int result));
132     Q_PRIVATE_SLOT(d_func(), void _q_onVisibleChanged());
133     // Hides QObject::d_ptr allowing us to use the convenience macros.
134     QScopedPointer<QQuickWebViewPrivate> d_ptr;
135     QQuickWebViewExperimental* m_experimental;
136
137     friend class QtWebPageProxy;
138     friend class QtWebPageUIClient;
139     friend class WTR::PlatformWebView;
140     friend class QQuickWebViewExperimental;
141 };
142
143 QML_DECLARE_TYPE(QQuickWebView)
144
145 class QWEBKIT_EXPORT QQuickWebViewAttached : public QObject {
146     Q_OBJECT
147     Q_PROPERTY(QQuickWebView* view READ view NOTIFY viewChanged FINAL)
148
149 public:
150     QQuickWebViewAttached(QObject* object);
151     QQuickWebView* view() const { return m_view; }
152     void setView(QQuickWebView*);
153
154 Q_SIGNALS:
155     void viewChanged();
156
157 private:
158     QQuickWebView* m_view;
159 };
160
161 QML_DECLARE_TYPEINFO(QQuickWebView, QML_HAS_ATTACHED_PROPERTIES)
162
163 class QWEBKIT_EXPORT QQuickWebViewExperimental : public QObject {
164     Q_OBJECT
165     Q_PROPERTY(QDeclarativeComponent* alertDialog READ alertDialog WRITE setAlertDialog NOTIFY alertDialogChanged)
166     Q_PROPERTY(QDeclarativeComponent* confirmDialog READ confirmDialog WRITE setConfirmDialog NOTIFY confirmDialogChanged)
167     Q_PROPERTY(QDeclarativeComponent* promptDialog READ promptDialog WRITE setPromptDialog NOTIFY promptDialogChanged)
168
169 public:
170     QQuickWebViewExperimental(QQuickWebView* webView);
171     virtual ~QQuickWebViewExperimental();
172
173     QDeclarativeComponent* alertDialog() const;
174     void setAlertDialog(QDeclarativeComponent*);
175     QDeclarativeComponent* confirmDialog() const;
176     void setConfirmDialog(QDeclarativeComponent*);
177     QDeclarativeComponent* promptDialog() const;
178     void setPromptDialog(QDeclarativeComponent*);
179
180 public Q_SLOTS:
181     void setUseTraditionalDesktopBehaviour(bool enable);
182
183 Q_SIGNALS:
184     void alertDialogChanged();
185     void confirmDialogChanged();
186     void promptDialogChanged();
187
188 private:
189     QQuickWebView* q_ptr;
190     QQuickWebViewPrivate* d_ptr;
191
192     Q_DECLARE_PRIVATE(QQuickWebView)
193     Q_DECLARE_PUBLIC(QQuickWebView)
194 };
195
196 #endif // qquickwebview_p_h