0d2a3b2fd3e48fb26c7eee022e87763b50015db9
[WebKit-https.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 <QtQuick/qquickitem.h>
26
27 class QWebNavigationRequest;
28 class QDeclarativeComponent;
29 class QQuickWebPage;
30 class QQuickWebViewAttached;
31 class QQuickWebViewPrivate;
32 class QQuickWebViewExperimental;
33 class QWebDownloadItem;
34 class QWebPreferences;
35 class QWebPermissionRequest;
36
37 namespace WTR {
38 class PlatformWebView;
39 }
40
41 typedef const struct OpaqueWKContext* WKContextRef;
42 typedef const struct OpaqueWKPageGroup* WKPageGroupRef;
43 typedef const struct OpaqueWKPage* WKPageRef;
44
45 QT_BEGIN_NAMESPACE
46 class QPainter;
47 class QUrl;
48 QT_END_NAMESPACE
49
50 class QWEBKIT_EXPORT QQuickWebView : public QQuickItem {
51     Q_OBJECT
52     Q_PROPERTY(QString title READ title NOTIFY titleChanged)
53     Q_PROPERTY(QUrl url READ url NOTIFY urlChanged)
54     Q_PROPERTY(int loadProgress READ loadProgress NOTIFY loadProgressChanged)
55     Q_PROPERTY(bool canGoBack READ canGoBack NOTIFY navigationStateChanged FINAL)
56     Q_PROPERTY(bool canGoForward READ canGoForward NOTIFY navigationStateChanged FINAL)
57     Q_PROPERTY(bool loading READ loading NOTIFY navigationStateChanged FINAL)
58     Q_PROPERTY(bool canReload READ canReload NOTIFY navigationStateChanged FINAL)
59     Q_PROPERTY(QWebPreferences* preferences READ preferences CONSTANT FINAL)
60     Q_PROPERTY(QQuickWebPage* page READ page CONSTANT FINAL)
61     Q_ENUMS(NavigationRequestAction)
62     Q_ENUMS(ErrorType)
63
64 public:
65     enum NavigationRequestAction {
66         AcceptRequest,
67         IgnoreRequest,
68         DownloadRequest
69     };
70
71     enum ErrorType {
72         EngineError,
73         NetworkError,
74         HttpError,
75         DownloadError
76     };
77     QQuickWebView(QQuickItem* parent = 0);
78     virtual ~QQuickWebView();
79
80     QUrl url() const;
81     QString title() const;
82     int loadProgress() const;
83
84     bool canGoBack() const;
85     bool canGoForward() const;
86     bool loading() const;
87     bool canReload() const;
88
89     QWebPreferences* preferences() const;
90     QQuickWebPage* page();
91
92     QQuickWebViewExperimental* experimental() const;
93     static QQuickWebViewAttached* qmlAttachedProperties(QObject*);
94
95     static void platformInitialize(); // Only needed by WTR.
96
97 public Q_SLOTS:
98     void load(const QUrl&);
99     void postMessage(const QString&);
100     void loadHtml(const QString& html, const QUrl& baseUrl = QUrl());
101
102     void goBack();
103     void goForward();
104     void stop();
105     void reload();
106
107 Q_SIGNALS:
108     void titleChanged(const QString& title);
109     void statusBarMessageChanged(const QString& message);
110     void loadStarted();
111     void loadSucceeded();
112     void loadFailed(QQuickWebView::ErrorType errorType, int errorCode, const QUrl& url);
113     void loadProgressChanged(int progress);
114     void urlChanged(const QUrl& url);
115     void messageReceived(const QVariantMap& message);
116     void linkHovered(const QUrl& url, const QString& title);
117     void navigationStateChanged();
118     void navigationRequested(QWebNavigationRequest* request);
119
120 protected:
121     virtual void geometryChanged(const QRectF&, const QRectF&);
122     virtual void focusInEvent(QFocusEvent*);
123     virtual void focusOutEvent(QFocusEvent*);
124     virtual void touchEvent(QTouchEvent* event);
125
126 private:
127     Q_DECLARE_PRIVATE(QQuickWebView)
128
129     QQuickWebView(WKContextRef, WKPageGroupRef, QQuickItem* parent = 0);
130     WKPageRef pageRef() const;
131
132     Q_PRIVATE_SLOT(d_func(), void _q_suspend());
133     Q_PRIVATE_SLOT(d_func(), void _q_resume());
134     Q_PRIVATE_SLOT(d_func(), void _q_viewportTrajectoryVectorChanged(const QPointF&));
135     Q_PRIVATE_SLOT(d_func(), void _q_onOpenPanelFilesSelected());
136     Q_PRIVATE_SLOT(d_func(), void _q_onOpenPanelFinished(int result));
137     Q_PRIVATE_SLOT(d_func(), void _q_onVisibleChanged());
138     // Hides QObject::d_ptr allowing us to use the convenience macros.
139     QScopedPointer<QQuickWebViewPrivate> d_ptr;
140     QQuickWebViewExperimental* m_experimental;
141
142     friend class QtWebPageLoadClient;
143     friend class QtWebPagePolicyClient;
144     friend class QtWebPageProxy;
145     friend class QtWebPageUIClient;
146     friend class WTR::PlatformWebView;
147     friend class QQuickWebViewExperimental;
148 };
149
150 QML_DECLARE_TYPE(QQuickWebView)
151
152 class QWEBKIT_EXPORT QQuickWebViewAttached : public QObject {
153     Q_OBJECT
154     Q_PROPERTY(QQuickWebView* view READ view NOTIFY viewChanged FINAL)
155
156 public:
157     QQuickWebViewAttached(QObject* object);
158     QQuickWebView* view() const { return m_view; }
159     void setView(QQuickWebView*);
160
161 Q_SIGNALS:
162     void viewChanged();
163
164 private:
165     QQuickWebView* m_view;
166 };
167
168 QML_DECLARE_TYPEINFO(QQuickWebView, QML_HAS_ATTACHED_PROPERTIES)
169
170 class QWEBKIT_EXPORT QQuickWebViewExperimental : public QObject {
171     Q_OBJECT
172     Q_PROPERTY(QDeclarativeComponent* alertDialog READ alertDialog WRITE setAlertDialog NOTIFY alertDialogChanged)
173     Q_PROPERTY(QDeclarativeComponent* confirmDialog READ confirmDialog WRITE setConfirmDialog NOTIFY confirmDialogChanged)
174     Q_PROPERTY(QDeclarativeComponent* promptDialog READ promptDialog WRITE setPromptDialog NOTIFY promptDialogChanged)
175     Q_PROPERTY(QDeclarativeComponent* itemSelector READ itemSelector WRITE setItemSelector NOTIFY itemSelectorChanged)
176     Q_PROPERTY(bool useTraditionalDesktopBehaviour READ useTraditionalDesktopBehaviour WRITE setUseTraditionalDesktopBehaviour)
177
178 public:
179     QQuickWebViewExperimental(QQuickWebView* webView);
180     virtual ~QQuickWebViewExperimental();
181
182     QDeclarativeComponent* alertDialog() const;
183     void setAlertDialog(QDeclarativeComponent*);
184     QDeclarativeComponent* confirmDialog() const;
185     void setConfirmDialog(QDeclarativeComponent*);
186     QDeclarativeComponent* promptDialog() const;
187     void setPromptDialog(QDeclarativeComponent*);
188     QDeclarativeComponent* itemSelector() const;
189     void setItemSelector(QDeclarativeComponent*);
190
191     bool useTraditionalDesktopBehaviour() const;
192
193 public Q_SLOTS:
194     void setUseTraditionalDesktopBehaviour(bool enable);
195
196 Q_SIGNALS:
197     void alertDialogChanged();
198     void confirmDialogChanged();
199     void promptDialogChanged();
200     void itemSelectorChanged();
201     void downloadRequested(QWebDownloadItem* downloadItem);
202     void permissionRequested(QWebPermissionRequest* permission);
203
204 private:
205     QQuickWebView* q_ptr;
206     QQuickWebViewPrivate* d_ptr;
207
208     friend class QtWebPageProxy;
209     friend class QtWebPageUIClient;
210
211     Q_DECLARE_PRIVATE(QQuickWebView)
212     Q_DECLARE_PUBLIC(QQuickWebView)
213 };
214
215 #endif // qquickwebview_p_h