Merge lp:~stolowski/unity-api/single-preview into lp:unity-api

[Paweł Stołowski]

Removed PreviewStackInterface. Changed ScopeInterface to return single preview.

Removed PreviewStackInterface. Changed ScopeInterface to return single preview.

[lp:~stolowski/unity-api/single-preview]

209. By Paweł Stołowski on 2016-02-17

Merged trunk

210. By Paweł Stołowski on 2016-02-17

Bump version

211. By Paweł Stołowski on 2016-02-18

Merged activation-progress

Unmerged revisions

=== modified file 'debian/changelog'
--- debian/changelog	2016-02-11 23:53:29 +0000
+++ debian/changelog	2016-02-18 15:46:52 +0000
@@ -1,3 +1,10 @@
+unity-api (7.107) UNRELEASED; urgency=medium
+
+  * Removed PreviewStackInterface, modified ScopeInterface to return
+    PreviewModelInterface on preview().
+
+ -- Pawel Stolowski <[e-mail]>  Wed, 17 Feb 2016 17:46:13 +0100
+
 unity-api (7.106+16.04.20160211.1-0ubuntu1) xenial; urgency=medium
 
   [ Daniel d'Andrada ]
 
=== modified file 'include/unity/shell/scopes/CMakeLists.txt'
--- include/unity/shell/scopes/CMakeLists.txt	2015-11-30 09:18:57 +0000
+++ include/unity/shell/scopes/CMakeLists.txt	2016-02-18 15:46:52 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 9)
+set(VERSION 10)
 set(PKGCONFIG_NAME "unity-shell-scopes")
 set(PKGCONFIG_DESCRIPTION "Unity shell Scopes APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")
 
=== removed file 'include/unity/shell/scopes/PreviewStackInterface.h'
--- include/unity/shell/scopes/PreviewStackInterface.h	2014-05-19 09:24:42 +0000
+++ include/unity/shell/scopes/PreviewStackInterface.h	1970-01-01 00:00:00 +0000
@@ -1,99 +0,0 @@
-/*
- * Copyright (C) 2014 Canonical, Ltd.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#ifndef UNITY_SHELL_SCOPES_PREVIEWSTACKINTERFACE_H
-#define UNITY_SHELL_SCOPES_PREVIEWSTACKINTERFACE_H
-
-#include <unity/SymbolExport.h>
-
-#include <QAbstractListModel>
-
-namespace unity
-{
-namespace shell
-{
-namespace scopes
-{
-
-class PreviewModelInterface;
-
-/**
- * @brief A master model for previews.
- *
- * Each item in this model represents an individual preview, where each is stacked
- * on top of the previous one. Item on index 0 is always the one on the very bottom
- * of the stack.
- */
-class UNITY_API PreviewStackInterface : public QAbstractListModel
-{
-    Q_OBJECT
-
-    Q_ENUMS(Roles)
-
-    /**
-     * @brief Number of columns the individual previews should expose.
-     *
-     * Previews can be laid out in a different number of columns - for example the number
-     * of desired columns can change when changing orientation of the display and
-     * therefore there's more horizontal space available.
-     */
-    Q_PROPERTY(int widgetColumnCount READ widgetColumnCount WRITE setWidgetColumnCount NOTIFY widgetColumnCountChanged)
-
-protected:
-    /// @cond
-    explicit PreviewStackInterface(QObject* parent = 0) : QAbstractListModel(parent) { }
-    /// @endcond
-
-public:
-    /**
-     * @brief The roles supported by this model.
-     */
-    enum Roles {
-        RolePreviewModel
-    };
-
-    /**
-     * @brief Get preview model at a particular index.
-     *
-     * Return PreviewModelInterface instance at a particular index or nullptr
-     * if the index is out of bounds.
-     */
-    Q_INVOKABLE virtual unity::shell::scopes::PreviewModelInterface* getPreviewModel(int index) const = 0;
-
-    // @cond
-    virtual void setWidgetColumnCount(int columnCount) = 0;
-    virtual int widgetColumnCount() const = 0;
-    QHash<int, QByteArray> roleNames() const override
-    {
-        QHash<int, QByteArray> roles;
-        roles[RolePreviewModel] = "previewModel";
-        return roles;
-    }
-    // @endcond
-
-Q_SIGNALS:
-    // @cond
-    void widgetColumnCountChanged();
-    // @endcond
-};
-
-}
-}
-}
-
-Q_DECLARE_METATYPE(unity::shell::scopes::PreviewStackInterface*)
-
-#endif
 
=== modified file 'include/unity/shell/scopes/ScopeInterface.h'
--- include/unity/shell/scopes/ScopeInterface.h	2015-10-05 12:54:22 +0000
+++ include/unity/shell/scopes/ScopeInterface.h	2016-02-18 15:46:52 +0000
@@ -30,7 +30,7 @@
 {
 
 class CategoriesInterface;
-class PreviewStackInterface;
+class PreviewModelInterface;
 class NavigationInterface;
 class SettingsModelInterface;
 
@@ -74,6 +74,11 @@
     Q_PROPERTY(bool searchInProgress READ searchInProgress NOTIFY searchInProgressChanged)
 
     /**
+     * @brief Boolean specifying whether an activation request is currently running.
+     */
+    Q_PROPERTY(bool activationInProgress READ activationInProgress NOTIFY activationInProgressChanged)
+
+    /**
      * @brief Boolean specifying whether the scope is favourited.
      */
     Q_PROPERTY(bool favorite READ favorite WRITE setFavorite NOTIFY favoriteChanged)
@@ -173,6 +178,7 @@
     virtual QString searchHint() const = 0;
     virtual QString shortcut() const = 0;
     virtual bool searchInProgress() const = 0;
+    virtual bool activationInProgress() const = 0;
     virtual bool favorite() const = 0;
     virtual CategoriesInterface* categories() const = 0;
     virtual SettingsModelInterface* settings() const = 0;
@@ -203,10 +209,10 @@
     /**
      * @brief Method used to preview a result.
      *
-     * Returns a new PreviewStackInterface instance. It's caller's responsibility
+     * Returns a new PreviewModelInterface instance. It's caller's responsibility
      * to free it.
      */
-    Q_INVOKABLE virtual unity::shell::scopes::PreviewStackInterface* preview(QVariant const& result, QString const& categoryId) = 0;
+    Q_INVOKABLE virtual unity::shell::scopes::PreviewModelInterface* preview(QVariant const& result, QString const& categoryId) = 0;
 
     /**
      * @brief Cancels the current activation.
@@ -256,6 +262,7 @@
     void descriptionChanged();
     void searchHintChanged();
     void searchInProgressChanged();
+    void activationInProgressChanged();
     void favoriteChanged();
     void shortcutChanged();
     void categoriesChanged();
 
=== modified file 'test/qmltest/mocks/plugins/Unity/Scopes/CMakeLists.txt'
--- test/qmltest/mocks/plugins/Unity/Scopes/CMakeLists.txt	2014-07-25 15:17:40 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/CMakeLists.txt	2016-02-18 15:46:52 +0000
@@ -15,7 +15,6 @@
     Mocks/MockDepartment.cpp
     Mocks/MockResultsModel.cpp
     Mocks/MockPreviewModel.cpp
-    Mocks/MockPreviewStack.cpp
     Mocks/MockPreviewWidgetModel.cpp
     Mocks/MockScope.cpp
     Mocks/MockScopes.cpp
@@ -25,7 +24,6 @@
     ${CMAKE_SOURCE_DIR}/include/unity/shell/scopes/ResultsModelInterface.h
     ${CMAKE_SOURCE_DIR}/include/unity/shell/scopes/PreviewModelInterface.h
     ${CMAKE_SOURCE_DIR}/include/unity/shell/scopes/PreviewWidgetModelInterface.h
-    ${CMAKE_SOURCE_DIR}/include/unity/shell/scopes/PreviewStackInterface.h
     ${CMAKE_SOURCE_DIR}/include/unity/shell/scopes/ScopeInterface.h
     ${CMAKE_SOURCE_DIR}/include/unity/shell/scopes/ScopesInterface.h
     ${CMAKE_SOURCE_DIR}/include/unity/shell/scopes/SettingsModelInterface.h
 
=== removed file 'test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockPreviewStack.cpp'
--- test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockPreviewStack.cpp	2014-05-19 11:45:10 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockPreviewStack.cpp	1970-01-01 00:00:00 +0000
@@ -1,63 +0,0 @@
-/*
- * Copyright (C) 2014 Canonical, Ltd.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-// self
-#include "MockPreviewStack.h"
-
-// local
-#include "MockPreviewModel.h"
-
-MockPreviewStack::MockPreviewStack(QObject* parent)
- : unity::shell::scopes::PreviewStackInterface(parent)
-{
-    m_previews << new MockPreviewModel(this);
-}
-
-void MockPreviewStack::setWidgetColumnCount(int columnCount)
-{
-    if (columnCount != 1) {
-        qFatal("MockPreviewStack::setWidgetColumnCount != 1 not implemented");
-    }
-}
-
-int MockPreviewStack::widgetColumnCount() const
-{
-    return 1;
-}
-
-int MockPreviewStack::rowCount(const QModelIndex&) const
-{
-    return m_previews.size();
-}
-
-unity::shell::scopes::PreviewModelInterface* MockPreviewStack::getPreviewModel(int index) const
-{
-    if (index >= m_previews.size()) {
-        return nullptr;
-    }
-
-    return m_previews.at(index);
-}
-
-QVariant MockPreviewStack::data(const QModelIndex& index, int role) const
-{
-    switch (role) {
-        case RolePreviewModel:
-            return QVariant::fromValue(m_previews.at(index.row()));
-        default:
-            return QVariant();
-    }
-}
 
=== removed file 'test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockPreviewStack.h'
--- test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockPreviewStack.h	2014-05-19 11:45:10 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockPreviewStack.h	1970-01-01 00:00:00 +0000
@@ -1,47 +0,0 @@
-/*
- * Copyright (C) 2014 Canonical, Ltd.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-
-#ifndef MOCKPREVIEWSTACK_H
-#define MOCKPREVIEWSTACK_H
-
-#include <unity/shell/scopes/PreviewStackInterface.h>
-
-#include <QSharedPointer>
-#include <QVariantMap>
-
-class MockPreviewModel;
-
-class MockPreviewStack : public unity::shell::scopes::PreviewStackInterface
-{
-    Q_OBJECT
-
-public:
-    explicit MockPreviewStack (QObject* parent = 0);
-
-    QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;
-    int rowCount(const QModelIndex& parent = QModelIndex()) const override;
-
-    Q_INVOKABLE unity::shell::scopes::PreviewModelInterface* getPreviewModel(int index) const override;
-
-    void setWidgetColumnCount(int columnCount) override;
-    int widgetColumnCount() const override;
-
-private:
-    QList<MockPreviewModel*> m_previews;
-};
-
-#endif
 
=== modified file 'test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.cpp'
--- test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.cpp	2015-10-05 12:54:22 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.cpp	2016-02-18 15:46:52 +0000
@@ -16,7 +16,7 @@
 
 #include "MockScope.h"
 #include "MockCategories.h"
-#include "MockPreviewStack.h"
+#include "MockPreviewModel.h"
 #include "MockDepartment.h"
 #include "MockSettingsModel.h"
 
@@ -77,6 +77,10 @@
     return m_searching;
 }
 
+bool MockScope::activationInProgress() const {
+    return false;
+}
+
 unity::shell::scopes::CategoriesInterface* MockScope::categories() const {
     return m_categories;
 }
@@ -172,14 +176,14 @@
     Q_UNUSED(actionId);
 }
 
-unity::shell::scopes::PreviewStackInterface* MockScope::preview(QVariant const& result, QString const& categoryId)
+unity::shell::scopes::PreviewModelInterface* MockScope::preview(QVariant const& result, QString const& categoryId)
 {
     Q_UNUSED(result);
     Q_UNUSED(categoryId);
 
     // This probably leaks, do we don't care
     // it's a  test after all
-    return new MockPreviewStack;
+    return new MockPreviewModel;
 }
 
 unity::shell::scopes::NavigationInterface* MockScope::getNavigation(QString const& navigationId)
 
=== modified file 'test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.h'
--- test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.h	2015-10-05 12:54:22 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/Mocks/MockScope.h	2016-02-18 15:46:52 +0000
@@ -36,6 +36,7 @@
     bool favorite() const override;
     QString shortcut() const override;
     bool searchInProgress() const override;
+    bool activationInProgress() const override;
     unity::shell::scopes::CategoriesInterface* categories() const override;
     unity::shell::scopes::SettingsModelInterface* settings() const override;
     QString searchQuery() const override;
@@ -59,7 +60,7 @@
 
     Q_INVOKABLE void activate(QVariant const& result, QString const& categoryId) override;
     Q_INVOKABLE void activateAction(QVariant const& result, QString const& categoryId, QString const& actionId) override;
-    Q_INVOKABLE unity::shell::scopes::PreviewStackInterface* preview(QVariant const& result, QString const& categoryId) override;
+    Q_INVOKABLE unity::shell::scopes::PreviewModelInterface* preview(QVariant const& result, QString const& categoryId) override;
     Q_INVOKABLE void cancelActivation() override;
     Q_INVOKABLE void closeScope(unity::shell::scopes::ScopeInterface* scope) override;
     Q_INVOKABLE unity::shell::scopes::NavigationInterface* getNavigation(QString const& departmentId) override;
 
=== modified file 'test/qmltest/mocks/plugins/Unity/Scopes/TestScopesPlugin.cpp'
--- test/qmltest/mocks/plugins/Unity/Scopes/TestScopesPlugin.cpp	2014-07-25 15:17:40 +0000
+++ test/qmltest/mocks/plugins/Unity/Scopes/TestScopesPlugin.cpp	2016-02-18 15:46:52 +0000
@@ -24,7 +24,6 @@
 #include "ResultsModelInterface.h"
 #include "PreviewModelInterface.h"
 #include "PreviewWidgetModelInterface.h"
-#include "PreviewStackInterface.h"
 #include "SettingsModelInterface.h"
 #include "Mocks/MockScopes.h"
 #include "Mocks/MockScope.h"
@@ -36,8 +35,7 @@
     qmlRegisterUncreatableType<unity::shell::scopes::CategoriesInterface>(uri, 0, 2, "Categories", "Can't create Categories object in QML. Get them from Scope instance.");
     qmlRegisterUncreatableType<unity::shell::scopes::NavigationInterface>(uri, 0, 2, "Navigation", "Can't create Navigation object in QML. Get them from Scope instance.");
     qmlRegisterUncreatableType<unity::shell::scopes::ResultsModelInterface>(uri, 0, 2, "ResultsModel", "Can't create new ResultsModel in QML. Get them from Categories instance.");
-    qmlRegisterUncreatableType<unity::shell::scopes::PreviewModelInterface>(uri, 0, 2, "PreviewModel", "Can't create new PreviewModel in QML. Get them from PreviewStack instance.");
+    qmlRegisterUncreatableType<unity::shell::scopes::PreviewModelInterface>(uri, 0, 2, "PreviewModel", "Can't create new PreviewModel in QML. Get them from Scope instance.");
     qmlRegisterUncreatableType<unity::shell::scopes::PreviewWidgetModelInterface>(uri, 0, 2, "PreviewWidgetModel", "Can't create new PreviewWidgetModel in QML. Get them from PreviewModel instance.");
-    qmlRegisterUncreatableType<unity::shell::scopes::PreviewStackInterface>(uri, 0, 2, "PreviewStack", "Can't create new PreviewStack in QML. Get them from Scope instance.");
     qmlRegisterUncreatableType<unity::shell::scopes::SettingsModelInterface>(uri, 0, 2, "Settings", "Can't create new Settings in QML. Get them from Scope instance.");
 }
 
=== modified file 'test/qmltest/unity/shell/scopes/tst_Scopes.qml'
--- test/qmltest/unity/shell/scopes/tst_Scopes.qml	2015-10-09 08:30:31 +0000
+++ test/qmltest/unity/shell/scopes/tst_Scopes.qml	2016-02-18 15:46:52 +0000
@@ -343,72 +343,11 @@
     }
 
     Verifier {
-        id: previewStackVerifier
-
-        Repeater {
-             id: previewStackRepeater
-             model: preview
-             delegate: Item {
-                 property var roles: model
-             }
-        }
-
-        function test_previewStack_data() {
-            return [
-                { tag: "PreviewStack[object]", type: "object" },
-                { tag: "PreviewStack[PreviewStackInterface]", type: "unity::shell::scopes::PreviewStackInterface" },
-            ];
-        }
-
-        function test_previewStack(data) {
-            object = previewStackRepeater.model;
-            name = "PreviewStack";
-            verifyData(data);
-        }
-
-        function test_previewStack_roles_data() {
-            return [
-                { tag: "Model.roles[previewModel]", role: "previewModel", type: "object" }
-            ];
-        }
-
-        function test_previewStack_roles(data) {
-            object = previewStackRepeater.itemAt(0).roles;
-            name = "PreviewStack";
-            verifyData(data);
-        }
-
-        function test_previewStack_properties_data() {
-            return [
-                { tag: "Item.properties[widgetColumnCount]", constant: "widgetColumnCount", type: "number" }
-            ];
-        }
-
-        function test_previewStack_properties(data) {
-            object = previewStackRepeater.model;
-            name = "PreviewStack";
-            verifyData(data);
-        }
-
-        function test_previewStack_methods_data() {
-            return [
-                { tag: "Model.methods[get]", method: "getPreviewModel" }
-            ];
-        }
-
-        function test_previewStack_methods(data) {
-            object = previewStackRepeater.model;
-            name = "PreviewStack"
-            verifyData(data);
-        }
-    }
-
-    Verifier {
         id: previewModelVerifier
 
         Repeater {
              id: previewModelRepeater
-             model: preview.getPreviewModel(0)
+             model: preview
              delegate: Item {
                  property var roles: model
                  property var columnModel: model.columnModel