Merge lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/shortcuts into lp:ubuntu-ui-toolkit/staging

[Cris Dywan]

Implement Action.shortcut property

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1537
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1925/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3259/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/653/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/655/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/652/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3257/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1925/rebuild

review: Needs Fixing (continuous-integration)

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/shortcuts]

1538. By Cris Dywan on 2015-06-22

Fix doc comment for UCAction::shortcut

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1538
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1927/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/3265
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/655
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/657
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/657/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/654
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2727
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3263
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/3263/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21354

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1927/rebuild

review: Needs Fixing (continuous-integration)

[Zsombor Egri (zsombi)]

Got some comments inline, check 'em.

review: Needs Fixing

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/shortcuts]

1539. By Cris Dywan on 2015-07-03

More explicit type check and multi modifier test case

[Cris Dywan (kalikiana)]

> if object is expected to be a QQuickItem,
> you should cast to it and that has a window()
> that you can use to get the window context...?

No. The action itself is in fact a QObject. We're walking up the parents to find a window.

> Shouldn't we also check whether the action is enabled?

No need, trigger() has a check already.

> What about testing also Alt+Ctrl, Shift+Ctrl and Alt+Shift+Ctrl?
> Or should we just assume that Qt shortcut system works with those?

Basically yeah, I don't think we want to duplicate their tests since we don't add any functionality. But I added another one with Atl+Shift+Ctrl just to be sure we'll know if anything obvious breaks in a Qt upgrade.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1539
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1964/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/692
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/694
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/694/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/691

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1964/rebuild

review: Approve (continuous-integration)

[Zsombor Egri (zsombi)]

One more thing we forgot!

review: Needs Fixing

[Zsombor Egri (zsombi)]

To summarise what we talked on Mumble:
- actions to be grouped in ActionContext
- Action activation to be bound to ActionContext.active
- text input action context activation to be bound with activeFocus
- Page active to drive ActionContext.active

review: Needs Fixing

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/shortcuts]

1540. By Cris Dywan on 2015-07-07

New shortcut property needs to go on revision 3

1541. By Cris Dywan on 2015-07-07

Register UCAction revision 1 to 1.3 and shortcut to 1

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1540
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1968/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/696/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/698/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/695/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1968/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1541
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1970/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/698/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/700/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/697/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1970/rebuild

review: Needs Fixing (continuous-integration)

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/shortcuts]

1542. By Cris Dywan on 2015-07-07

Update components.api

[Zsombor Egri (zsombi)]

All good now, let's get it merged.

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'components.api'
--- components.api	2015-06-22 23:24:26 +0000
+++ components.api	2015-07-07 19:08:50 +0000
@@ -8,7 +8,7 @@
     signal clicked()
     signal pressAndHold()
     property bool pressed
-Ubuntu.Components.Action 1.0 0.1: QtObject
+Ubuntu.Components.Action 1.3 1.0 0.1: QtObject
     property string description
     property bool enabled
     property string iconName
@@ -20,6 +20,7 @@
     function trigger()
     property string name
     property Type parameterType
+    property var shortcut
     property string text
     property bool visible
 Ubuntu.Components.Action.Type: Enum

=== modified file 'examples/ubuntu-ui-toolkit-gallery/Buttons.qml'
--- examples/ubuntu-ui-toolkit-gallery/Buttons.qml	2015-04-29 07:21:29 +0000
+++ examples/ubuntu-ui-toolkit-gallery/Buttons.qml	2015-07-07 19:08:50 +0000
@@ -48,8 +48,14 @@
 
             Button {
                 objectName: "button_color"
-                text: i18n.tr("Call")
-                color: UbuntuColors.green
+                width: units.gu(20)
+                action: Action {
+                    text: i18n.tr("Call %1").arg(shortcut)
+                    shortcut: 'Ctrl+C'
+                    property bool flipped
+                    onTriggered: flipped = !flipped
+                }
+                color: action.flipped ? UbuntuColors.blue : UbuntuColors.green
             }
         }
 

=== modified file 'modules/Ubuntu/Components/plugin/plugin.cpp'
--- modules/Ubuntu/Components/plugin/plugin.cpp	2015-05-26 17:54:51 +0000
+++ modules/Ubuntu/Components/plugin/plugin.cpp	2015-07-07 19:08:50 +0000
@@ -213,6 +213,7 @@
     qmlRegisterSingletonType<UCNamespaceV13>(uri, 1, 3, "Ubuntu", registerUbuntuNamespace13);
     qmlRegisterType<UCStyledItemBase, 2>(uri, 1, 3, "StyledItem");
     qmlRegisterCustomType<UCStyleHints>(uri, 1, 3, "StyleHints", new UCStyleHintsParser);
+    qmlRegisterType<UCAction, 1>(uri, 1, 3, "Action");
 }
 
 void UbuntuComponentsPlugin::initializeEngine(QQmlEngine *engine, const char *uri)

=== modified file 'modules/Ubuntu/Components/plugin/ucaction.cpp'
--- modules/Ubuntu/Components/plugin/ucaction.cpp	2014-11-28 13:30:05 +0000
+++ modules/Ubuntu/Components/plugin/ucaction.cpp	2015-07-07 19:08:50 +0000
@@ -17,6 +17,10 @@
 #include "ucaction.h"
 
 #include <QtDebug>
+#include <QtQml/QQmlInfo>
+#include <QtQuick/qquickitem.h>
+#include <QtQuick/qquickwindow.h>
+#include <private/qguiapplication_p.h>
 
 /*!
  * \qmltype Action
@@ -152,6 +156,7 @@
     , m_published(false)
     , m_itemHint(0)
     , m_parameterType(None)
+    , m_shortcut(0)
 {
     generateName();
 }
@@ -240,6 +245,67 @@
     qWarning() << "Action.itemHint is a DEPRECATED property. Use ActionItems to specify the representation of an Action.";
 }
 
+bool shortcutContextMatcher(QObject* object, Qt::ShortcutContext)
+{
+    UCAction* action = static_cast<UCAction*>(object);
+    // Can't access member here because it's not public
+    if (!action->property("enabled").toBool())
+        return false;
+
+    QObject* window = object;
+    while (window && !window->isWindowType()) {
+        window = window->parent();
+        if (QQuickItem* item = qobject_cast<QQuickItem*>(window))
+            window = item->window();
+    }
+    return window && window == QGuiApplication::focusWindow();
+}
+
+QKeySequence sequenceFromVariant(const QVariant& variant) {
+    if (variant.type() == QVariant::Int)
+        return static_cast<QKeySequence::StandardKey>(variant.toInt());
+    if (variant.type() == QVariant::String)
+        return QKeySequence::fromString(variant.toString());
+    return QKeySequence();
+}
+
+/*!
+ * \qmlproperty var Action::shortcut
+ * The keyboard shortcut that can be used to trigger the action.
+ * \b StandardKey values such as \b StandardKey.Copy
+ * as well as strings in the form "Ctrl+C" are accepted values.
+ * \since 1.3
+ */
+void UCAction::setShortcut(const QVariant& shortcut)
+{
+    if (m_shortcut.isValid())
+        QGuiApplicationPrivate::instance()->shortcutMap.removeShortcut(0, this, sequenceFromVariant(m_shortcut));
+
+    QKeySequence sequence(sequenceFromVariant(shortcut));
+    if (!sequence.toString().isEmpty())
+        QGuiApplicationPrivate::instance()->shortcutMap.addShortcut(this, sequence, Qt::WindowShortcut, shortcutContextMatcher);
+    else
+        qmlInfo(this) << "Invalid shortcut: " << shortcut.toString();
+
+    m_shortcut = shortcut;
+    Q_EMIT shortcutChanged(shortcut);
+}
+
+bool UCAction::event(QEvent *event)
+{
+    if (event->type() != QEvent::Shortcut)
+        return false;
+
+    QShortcutEvent *shortcut_event(static_cast<QShortcutEvent*>(event));
+    if (shortcut_event->isAmbiguous()) {
+        qmlInfo(this) << "Ambiguous shortcut: " << shortcut_event->key().toString();
+        return false;
+    }
+
+    trigger();
+    return true;
+}
+
 /*!
  * \qmlmethod Action::trigger(var value)
  * Checks the \c value against the action \l parameterType and triggers the action.

=== modified file 'modules/Ubuntu/Components/plugin/ucaction.h'
--- modules/Ubuntu/Components/plugin/ucaction.h	2015-01-07 10:15:34 +0000
+++ modules/Ubuntu/Components/plugin/ucaction.h	2015-07-07 19:08:50 +0000
@@ -40,6 +40,9 @@
     Q_PROPERTY(QUrl iconSource MEMBER m_iconSource WRITE setIconSource NOTIFY iconSourceChanged)
     Q_PROPERTY(bool visible MEMBER m_visible NOTIFY visibleChanged)
     Q_PROPERTY(QQmlComponent *itemHint MEMBER m_itemHint WRITE setItemHint)
+
+    // QtQuickControls.Action
+    Q_PROPERTY(QVariant shortcut MEMBER m_shortcut WRITE setShortcut NOTIFY shortcutChanged REVISION 1)
 public:
     enum Type {
         None,
@@ -67,6 +70,7 @@
     void parameterTypeChanged();
     void iconSourceChanged();
     void visibleChanged();
+    void shortcutChanged(const QVariant& shortcut);
     void triggered(const QVariant &value);
 
 public Q_SLOTS:
@@ -85,6 +89,7 @@
     QString m_description;
     QString m_keywords;
     Type m_parameterType;
+    QVariant m_shortcut;
 
     friend class UCActionContext;
     friend class UCListItemPrivate;
@@ -97,6 +102,8 @@
     void setIconName(const QString &name);
     void setIconSource(const QUrl &url);
     void setItemHint(QQmlComponent *);
+    void setShortcut(const QVariant&);
+    bool event(QEvent *event);
 };
 
 #endif // UCACTION_H

=== added file 'tests/unit_x11/tst_components/tst_shortcuts.qml'
--- tests/unit_x11/tst_components/tst_shortcuts.qml	1970-01-01 00:00:00 +0000
+++ tests/unit_x11/tst_components/tst_shortcuts.qml	2015-07-07 19:08:50 +0000
@@ -0,0 +1,92 @@
+/*
+ * Copyright 2015 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.4
+import QtTest 1.0
+import Ubuntu.Test 1.0
+import Ubuntu.Components 1.3
+
+Item {
+    id: root
+    width: 400
+    height: 600
+
+    Action {
+        id: action
+    }
+    Action {
+        id: other
+        shortcut: 'Ctrl+G'
+    }
+
+    TestUtil {
+        id: util
+    }
+
+    UbuntuTestCase {
+        id: testCase
+        name: "Shortcuts"
+        when: windowShown
+
+        function initTestCase() {
+        }
+
+        function init() {
+        }
+
+        SignalSpy {
+            id: spy
+            signalName: 'triggered'
+            target: action
+        }
+
+        function ignoreQMLWarning(message) {
+            ignoreWarning(util.callerFile() + message);
+        }
+
+        function test_shortcut_triggered_data() {
+            return [
+                { tag: 'Multiple modifiers and letter', shortcut: 'Ctrl+Shift+Alt+A', key: Qt.Key_A, mod: Qt.ControlModifier + Qt.ShiftModifier + Qt.AltModifier },
+                { tag: 'Modifier and letter', shortcut: 'Ctrl+A', key: Qt.Key_A, mod: Qt.ControlModifier },
+                { tag: 'Single letter', shortcut: 'E', key: Qt.Key_E, mod: Qt.NoModifier },
+                { tag: 'StandardKey', shortcut: StandardKey.Copy, key: Qt.Key_C, mod: Qt.ControlModifier }
+            ];
+        }
+        function test_shortcut_triggered(data) {
+            action.shortcut = data.shortcut;
+            spy.clear();
+            keyClick(data.key, data.mod);
+            spy.wait();
+        }
+
+        function test_shortcut_invalid_data() {
+            return [
+                { tag: 'Typo', shortcut: 'Ctr+F' },
+                { tag: 'Number', shortcut: 1234567890 }
+            ];
+        }
+        function test_shortcut_invalid(data) {
+            ignoreQMLWarning(':27:5: QML Action: Invalid shortcut: ');
+            action.shortcut = data;
+        }
+
+        function test_shortcut_duplicate() {
+            ignoreQMLWarning(':30:5: QML Action: Ambiguous shortcut: Ctrl+G');
+            action.shortcut = other.shortcut;
+            keyClick(Qt.Key_G, Qt.ControlModifier);
+        }
+    }
+}