[Qt] [WK2] Support customizing popup menus with QML
[WebKit-https.git] / Source / WebKit2 / UIProcess / qt / WebPopupMenuProxyQt.cpp
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "WebPopupMenuProxyQt.h"
29
30 #include "PlatformPopupMenuData.h"
31 #include "WebPopupItem.h"
32 #include "qquickwebview_p.h"
33 #include "qquickwebview_p_p.h"
34 #include <QtCore/QAbstractListModel>
35 #include <QtDeclarative/QDeclarativeContext>
36 #include <QtDeclarative/QDeclarativeEngine>
37
38 using namespace WebCore;
39
40 namespace WebKit {
41
42 static QHash<int, QByteArray> createRoleNamesHash();
43
44 class PopupMenuItemModel : public QAbstractListModel {
45     Q_OBJECT
46
47 public:
48     enum Roles {
49         GroupRole = Qt::UserRole,
50         EnabledRole = Qt::UserRole + 1,
51         SelectedRole = Qt::UserRole + 2,
52         IsSeparatorRole = Qt::UserRole + 3
53     };
54
55     PopupMenuItemModel(const Vector<WebPopupItem>&, int selectedOriginalIndex);
56     virtual int rowCount(const QModelIndex& parent = QModelIndex()) const { return m_items.size(); }
57     virtual QVariant data(const QModelIndex&, int role = Qt::DisplayRole) const;
58
59     Q_INVOKABLE void select(int);
60
61     int selectedOriginalIndex() const;
62
63 private:
64     struct Item {
65         Item(const WebPopupItem& webPopupItem, const QString& group, int originalIndex, bool selected)
66             : text(webPopupItem.m_text)
67             , toolTip(webPopupItem.m_toolTip)
68             , group(group)
69             , originalIndex(originalIndex)
70             , enabled(webPopupItem.m_isEnabled)
71             , selected(selected)
72             , isSeparator(webPopupItem.m_type == WebPopupItem::Separator)
73         { }
74
75         QString text;
76         QString toolTip;
77         QString group;
78         // Keep track of originalIndex because we don't add the label (group) items to our vector.
79         int originalIndex;
80         bool enabled;
81         bool selected;
82         bool isSeparator;
83     };
84
85     void buildItems(const Vector<WebPopupItem>& webPopupItems, int selectedOriginalIndex);
86
87     Vector<Item> m_items;
88     int m_selectedModelIndex;
89 };
90
91 class ItemSelectorContextObject : public QObject {
92     Q_OBJECT
93     Q_PROPERTY(QRect elementRect READ elementRect CONSTANT FINAL)
94     Q_PROPERTY(QObject* items READ items CONSTANT FINAL)
95
96 public:
97     ItemSelectorContextObject(const IntRect& elementRect, const Vector<WebPopupItem>&, int selectedIndex);
98
99     QRect elementRect() const { return m_elementRect; }
100     PopupMenuItemModel* items() { return &m_items; }
101
102     Q_INVOKABLE void accept(int index = -1);
103     Q_INVOKABLE void reject() { emit rejected(); }
104
105 Q_SIGNALS:
106     void acceptedWithOriginalIndex(int);
107     void rejected();
108
109 private:
110     QRect m_elementRect;
111     PopupMenuItemModel m_items;
112 };
113
114 ItemSelectorContextObject::ItemSelectorContextObject(const IntRect& elementRect, const Vector<WebPopupItem>& webPopupItems, int selectedIndex)
115     : m_elementRect(elementRect)
116     , m_items(webPopupItems, selectedIndex)
117 {
118 }
119
120 void ItemSelectorContextObject::accept(int index)
121 {
122     if (index != -1)
123         m_items.select(index);
124     int originalIndex = m_items.selectedOriginalIndex();
125     emit acceptedWithOriginalIndex(originalIndex);
126 }
127
128 static QHash<int, QByteArray> createRoleNamesHash()
129 {
130     QHash<int, QByteArray> roles;
131     roles[Qt::DisplayRole] = "text";
132     roles[Qt::ToolTipRole] = "tooltip";
133     roles[PopupMenuItemModel::GroupRole] = "group";
134     roles[PopupMenuItemModel::EnabledRole] = "enabled";
135     roles[PopupMenuItemModel::SelectedRole] = "selected";
136     roles[PopupMenuItemModel::IsSeparatorRole] = "isSeparator";
137     return roles;
138 }
139
140 PopupMenuItemModel::PopupMenuItemModel(const Vector<WebPopupItem>& webPopupItems, int selectedOriginalIndex)
141     : m_selectedModelIndex(-1)
142 {
143     static QHash<int, QByteArray> roles = createRoleNamesHash();
144     setRoleNames(roles);
145     buildItems(webPopupItems, selectedOriginalIndex);
146 }
147
148 QVariant PopupMenuItemModel::data(const QModelIndex& index, int role) const
149 {
150     if (!index.isValid() || index.row() < 0 || index.row() >= m_items.size())
151         return QVariant();
152
153     const Item& item = m_items[index.row()];
154     if (item.isSeparator) {
155         if (role == IsSeparatorRole)
156             return true;
157         return QVariant();
158     }
159
160     switch (role) {
161     case Qt::DisplayRole:
162         return item.text;
163     case Qt::ToolTipRole:
164         return item.toolTip;
165     case GroupRole:
166         return item.group;
167     case EnabledRole:
168         return item.enabled;
169     case SelectedRole:
170         return item.selected;
171     case IsSeparatorRole:
172         return false;
173     }
174
175     return QVariant();
176 }
177
178 void PopupMenuItemModel::select(int index)
179 {
180     int oldIndex = m_selectedModelIndex;
181     if (index == oldIndex)
182         return;
183     if (index < 0 || index >= m_items.size())
184         return;
185     Item& item = m_items[index];
186     if (!item.enabled)
187         return;
188
189     Item& oldItem = m_items[oldIndex];
190     oldItem.selected = false;
191     item.selected = true;
192     m_selectedModelIndex = index;
193
194     emit dataChanged(this->index(oldIndex), this->index(oldIndex));
195     emit dataChanged(this->index(index), this->index(index));
196 }
197
198 int PopupMenuItemModel::selectedOriginalIndex() const
199 {
200     if (m_selectedModelIndex == -1)
201         return -1;
202     return m_items[m_selectedModelIndex].originalIndex;
203 }
204
205 void PopupMenuItemModel::buildItems(const Vector<WebPopupItem>& webPopupItems, int selectedOriginalIndex)
206 {
207     QString currentGroup;
208     m_items.reserveInitialCapacity(webPopupItems.size());
209     for (int i = 0; i < webPopupItems.size(); i++) {
210         const WebPopupItem& webPopupItem = webPopupItems[i];
211         if (webPopupItem.m_isLabel) {
212             currentGroup = webPopupItem.m_text;
213             continue;
214         }
215         const bool selected = i == selectedOriginalIndex;
216         if (selected)
217             m_selectedModelIndex = m_items.size();
218         m_items.append(Item(webPopupItem, currentGroup, i, selected));
219     }
220 }
221
222 WebPopupMenuProxyQt::WebPopupMenuProxyQt(WebPopupMenuProxy::Client* client, QQuickWebView* webView)
223     : WebPopupMenuProxy(client)
224     , m_webView(webView)
225 {
226 }
227
228 WebPopupMenuProxyQt::~WebPopupMenuProxyQt()
229 {
230 }
231
232 void WebPopupMenuProxyQt::showPopupMenu(const IntRect& rect, WebCore::TextDirection, double, const Vector<WebPopupItem>& items, const PlatformPopupMenuData&, int32_t selectedIndex)
233 {
234     m_selectedIndex = selectedIndex;
235
236     ItemSelectorContextObject* contextObject = new ItemSelectorContextObject(rect, items, m_selectedIndex);
237     createItem(contextObject);
238     if (!m_itemSelector) {
239         notifyValueChanged();
240         return;
241     }
242 }
243
244 void WebPopupMenuProxyQt::hidePopupMenu()
245 {
246     m_itemSelector.clear();
247     m_context.clear();
248     notifyValueChanged();
249 }
250
251 void WebPopupMenuProxyQt::selectIndex(int index)
252 {
253     m_selectedIndex = index;
254 }
255
256 void WebPopupMenuProxyQt::createItem(QObject* contextObject)
257 {
258     QDeclarativeComponent* component = m_webView->experimental()->itemSelector();
259     if (!component) {
260         delete contextObject;
261         return;
262     }
263
264     createContext(component, contextObject);
265     QObject* object = component->beginCreate(m_context.get());
266     if (!object) {
267         m_context.clear();
268         return;
269     }
270
271     m_itemSelector = adoptPtr(qobject_cast<QQuickItem*>(object));
272     if (!m_itemSelector) {
273         m_context.clear();
274         m_itemSelector.clear();
275         return;
276     }
277
278     connect(contextObject, SIGNAL(acceptedWithOriginalIndex(int)), SLOT(selectIndex(int)));
279
280     // We enqueue these because they are triggered by m_itemSelector and will lead to its destruction.
281     connect(contextObject, SIGNAL(acceptedWithOriginalIndex(int)), SLOT(hidePopupMenu()), Qt::QueuedConnection);
282     connect(contextObject, SIGNAL(rejected()), SLOT(hidePopupMenu()), Qt::QueuedConnection);
283
284     QQuickWebViewPrivate::get(m_webView)->setViewInAttachedProperties(m_itemSelector.get());
285     component->completeCreate();
286
287     m_itemSelector->setParentItem(m_webView);
288 }
289
290 void WebPopupMenuProxyQt::createContext(QDeclarativeComponent* component, QObject* contextObject)
291 {
292     QDeclarativeContext* baseContext = component->creationContext();
293     if (!baseContext)
294         baseContext = QDeclarativeEngine::contextForObject(m_webView);
295     m_context = adoptPtr(new QDeclarativeContext(baseContext));
296
297     contextObject->setParent(m_context.get());
298     m_context->setContextProperty(QLatin1String("model"), contextObject);
299     m_context->setContextObject(contextObject);
300 }
301
302 void WebPopupMenuProxyQt::notifyValueChanged()
303 {
304     if (m_client) {
305         m_client->valueChangedForPopupMenu(this, m_selectedIndex);
306         invalidate();
307     }
308 }
309
310 } // namespace WebKit
311
312 // Since we define QObjects in WebPopupMenuProxyQt.cpp, this will trigger moc to run on .cpp.
313 #include "WebPopupMenuProxyQt.moc"
314
315 // And we can't compile the moc for WebPopupMenuProxyQt.h by itself, since it doesn't include "config.h"
316 #include "moc_WebPopupMenuProxyQt.cpp"