[Qt] [WK2] Expose onNavigationRequested signal instead of expecting a slot be defined...
[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(NavigationRequestAction)
60     Q_ENUMS(ErrorType)
61
62 public:
63     enum NavigationRequestAction {
64         AcceptRequest,
65         IgnoreRequest,
66         DownloadRequest
67     };
68
69     enum ErrorType {
70         EngineError,
71         NetworkError,
72         HttpError,
73         DownloadError
74     };
75     QQuickWebView(QQuickItem* parent = 0);
76     virtual ~QQuickWebView();
77
78     QUrl url() const;
79     QString title() const;
80     int loadProgress() const;
81
82     bool canGoBack() const;
83     bool canGoForward() const;
84     bool canStop() const;
85     bool canReload() const;
86
87     QWebPreferences* preferences() const;
88     QQuickWebPage* page();
89
90     QQuickWebViewExperimental* experimental() const;
91     static QQuickWebViewAttached* qmlAttachedProperties(QObject*);
92
93 public Q_SLOTS:
94     void load(const QUrl&);
95     void postMessage(const QString&);
96     void loadHtml(const QString& html, const QUrl& baseUrl = QUrl());
97
98     void goBack();
99     void goForward();
100     void stop();
101     void reload();
102
103 Q_SIGNALS:
104     void titleChanged(const QString& title);
105     void statusBarMessageChanged(const QString& message);
106     void loadStarted();
107     void loadSucceeded();
108     void loadFailed(QQuickWebView::ErrorType errorType, int errorCode, const QUrl& url);
109     void loadProgressChanged(int progress);
110     void urlChanged(const QUrl& url);
111     void messageReceived(const QVariantMap& message);
112     void downloadRequested(QWebDownloadItem* downloadItem);
113     void linkHovered(const QUrl& url, const QString& title);
114     void viewModeChanged();
115     void navigationStateChanged();
116     void navigationRequested(QObject* request);
117
118 protected:
119     virtual void geometryChanged(const QRectF&, const QRectF&);
120     virtual void focusInEvent(QFocusEvent*);
121     virtual void focusOutEvent(QFocusEvent*);
122     virtual void touchEvent(QTouchEvent* event);
123
124 private:
125     Q_DECLARE_PRIVATE(QQuickWebView)
126
127     QQuickWebView(WKContextRef, WKPageGroupRef, QQuickItem* parent = 0);
128     WKPageRef pageRef() const;
129
130     Q_PRIVATE_SLOT(d_func(), void _q_viewportUpdated());
131     Q_PRIVATE_SLOT(d_func(), void _q_viewportTrajectoryVectorChanged(const QPointF&));
132     Q_PRIVATE_SLOT(d_func(), void _q_onOpenPanelFilesSelected());
133     Q_PRIVATE_SLOT(d_func(), void _q_onOpenPanelFinished(int result));
134     Q_PRIVATE_SLOT(d_func(), void _q_onVisibleChanged());
135     // Hides QObject::d_ptr allowing us to use the convenience macros.
136     QScopedPointer<QQuickWebViewPrivate> d_ptr;
137     QQuickWebViewExperimental* m_experimental;
138
139     friend class QtWebPageLoadClient;
140     friend class QtWebPagePolicyClient;
141     friend class QtWebPageProxy;
142     friend class QtWebPageUIClient;
143     friend class WTR::PlatformWebView;
144     friend class QQuickWebViewExperimental;
145 };
146
147 QML_DECLARE_TYPE(QQuickWebView)
148
149 class QWEBKIT_EXPORT QQuickWebViewAttached : public QObject {
150     Q_OBJECT
151     Q_PROPERTY(QQuickWebView* view READ view NOTIFY viewChanged FINAL)
152
153 public:
154     QQuickWebViewAttached(QObject* object);
155     QQuickWebView* view() const { return m_view; }
156     void setView(QQuickWebView*);
157
158 Q_SIGNALS:
159     void viewChanged();
160
161 private:
162     QQuickWebView* m_view;
163 };
164
165 QML_DECLARE_TYPEINFO(QQuickWebView, QML_HAS_ATTACHED_PROPERTIES)
166
167 class QWEBKIT_EXPORT QQuickWebViewExperimental : public QObject {
168     Q_OBJECT
169     Q_PROPERTY(QDeclarativeComponent* alertDialog READ alertDialog WRITE setAlertDialog NOTIFY alertDialogChanged)
170     Q_PROPERTY(QDeclarativeComponent* confirmDialog READ confirmDialog WRITE setConfirmDialog NOTIFY confirmDialogChanged)
171     Q_PROPERTY(QDeclarativeComponent* promptDialog READ promptDialog WRITE setPromptDialog NOTIFY promptDialogChanged)
172
173 public:
174     QQuickWebViewExperimental(QQuickWebView* webView);
175     virtual ~QQuickWebViewExperimental();
176
177     QDeclarativeComponent* alertDialog() const;
178     void setAlertDialog(QDeclarativeComponent*);
179     QDeclarativeComponent* confirmDialog() const;
180     void setConfirmDialog(QDeclarativeComponent*);
181     QDeclarativeComponent* promptDialog() const;
182     void setPromptDialog(QDeclarativeComponent*);
183
184 public Q_SLOTS:
185     void setUseTraditionalDesktopBehaviour(bool enable);
186
187 Q_SIGNALS:
188     void alertDialogChanged();
189     void confirmDialogChanged();
190     void promptDialogChanged();
191
192 private:
193     QQuickWebView* q_ptr;
194     QQuickWebViewPrivate* d_ptr;
195
196     Q_DECLARE_PRIVATE(QQuickWebView)
197     Q_DECLARE_PUBLIC(QQuickWebView)
198 };
199
200 #endif // qquickwebview_p_h