Merge lp:~tpeeters/ubuntu-ui-toolkit/actionItem into lp:ubuntu-ui-toolkit

[Tim Peeters]

Add ActionItem component that copies the Action API, but adds a visual representation of the Action.

Add ActionItem component that copies the Action API, but adds a visual representation of the Action.

Action API will be simplified (remove itemHint, visible, update triggered) later (in separate MRs) when there is a new way to define tools for the toolbar using ActionItems.

[Tim Peeters (tpeeters)]

Don't approve until https://code.launchpad.net/~tpeeters/ubuntu-ui-toolkit/toolsItem/+merge/168932 is merged.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:557
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/171/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/28/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/28/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/171/rebuild

review: Needs Fixing (continuous-integration)

[lp:~tpeeters/ubuntu-ui-toolkit/actionItem]

558. By Tim Peeters on 2013-06-12

merge toolsItem branch

559. By Tim Peeters on 2013-06-12

empty change

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:558
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/172/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/29/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/29/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/172/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:559
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/174/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/31/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/31/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/174/rebuild

review: Needs Fixing (continuous-integration)

[lp:~tpeeters/ubuntu-ui-toolkit/actionItem]

560. By Tim Peeters on 2013-06-13

merge toolsItem branch

561. By Tim Peeters on 2013-06-13

fix iconSource test

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:560
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/178/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/35/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/35/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/178/rebuild

review: Needs Fixing (continuous-integration)

[lp:~tpeeters/ubuntu-ui-toolkit/actionItem]

562. By Tim Peeters on 2013-06-13

re-trigger jenkins test

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:561
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/179/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/36
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/36
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/36/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/179/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:562
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/180/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/37
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/37
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/37/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/180/rebuild

review: Approve (continuous-integration)

[lp:~tpeeters/ubuntu-ui-toolkit/actionItem]

563. By Tim Peeters on 2013-06-13

merge trunk

564. By Tim Peeters on 2013-06-13

update comment

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:564
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/181/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/38
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/38
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/38/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/181/rebuild

review: Approve (continuous-integration)

[Zsombor Egri (zsombi)]

got it now the reason why this step was made.

review: Approve

=== modified file 'components.api'
--- components.api	2013-06-13 08:56:42 +0000
+++ components.api	2013-06-13 12:43:26 +0000
@@ -1,6 +1,5 @@
 modules/Ubuntu/Components/AbstractButton.qml
-Item
-    property Action action
+ActionItem
     signal clicked()
     signal pressAndHold()
     property bool pressed
@@ -15,6 +14,12 @@
     property bool visible
     property bool enabled
     property Component itemHint
+modules/Ubuntu/Components/ActionItem.qml
+Item
+    property Action action
+    property string text
+    property url iconSource
+    signal triggered(var caller)
 modules/Ubuntu/Components/ActionList.qml
 QtObject
     default property alias children
@@ -28,8 +33,6 @@
 modules/Ubuntu/Components/Button.qml
 AbstractButton
     property color color
-    property url iconSource
-    property string text
     property string iconPosition
 modules/Ubuntu/Components/CheckBox.qml
 AbstractButton

=== modified file 'modules/Ubuntu/Components/AbstractButton.qml'
--- modules/Ubuntu/Components/AbstractButton.qml	2013-05-28 12:37:56 +0000
+++ modules/Ubuntu/Components/AbstractButton.qml	2013-06-13 12:43:26 +0000
@@ -27,18 +27,15 @@
     This class defines the behavior of the button: it defines the MouseArea
     and the states.
 */
-Item {
+ActionItem {
     id: button
 
     /*!
       If an action is specified, the button's clicked signal will trigger the action.
       Subclasses of AbstractButton can use other properties of action (for example
       the text and iconSource).
+      \qmlproperty Action action
      */
-    property Action action: null
-
-    visible: action ? action.visible : true
-    enabled: action ? action.enabled : true
 
     /*!
        This handler is called when there is a mouse click on the button
@@ -48,10 +45,9 @@
     signal clicked()
 
     /*!
-      If \l action was set, action.triggered() is automatically called with
-      the AbstractButton as parameter.
+      If a button is clicked, its triggered() signal will automatically be called.
      */
-    onClicked: if (action) action.triggered(button)
+    onClicked: button.triggered(button)
 
     Keys.onEnterPressed: clicked()
     Keys.onReturnPressed: clicked()

=== added file 'modules/Ubuntu/Components/ActionItem.qml'
--- modules/Ubuntu/Components/ActionItem.qml	1970-01-01 00:00:00 +0000
+++ modules/Ubuntu/Components/ActionItem.qml	2013-06-13 12:43:26 +0000
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2012 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.0
+
+/*!
+    \qmlabstract ActionItem
+    \inqmlmodule Ubuntu.Components 0.1
+    \ingroup ubuntu
+    \brief A visual representation of an Action. The API of ActionItem is a
+        copy of the API of \l Action, with additional properties to define
+        visual aspects of the ActionItem.
+
+        If \l action is set, the values of the other properties will by default
+        be identical to the \l Action's property values.
+*/
+Item {
+    id: actionItem
+
+    /*!
+      The \l Action associated with this ActionItem. If action is set,
+      the values of the Action properties are copied to the values of
+      the ActionItem properties.
+     */
+    property Action action: null
+
+    // TODO: remove visible from action when we start using ActionItems
+    //  to define the toolbar contents.
+    visible: action ? action.visible : true
+    enabled: action ? action.enabled : true
+
+    /*!
+      The title of the actionItem.
+      Default value: action.text
+     */
+    property string text: action ? action.text : ""
+
+    /*!
+      The image associated with the actionItem.
+      Default value: action.iconSource.
+     */
+    property url iconSource: action ? action.iconSource : ""
+
+    /*!
+      Called when the actionItem is triggered.
+     */
+    signal triggered(var caller)
+
+    /*!
+      If \l action is set, this will call action.trigger(caller).
+    */
+    onTriggered: if (action) action.triggered(caller)
+}

=== modified file 'modules/Ubuntu/Components/Button.qml'
--- modules/Ubuntu/Components/Button.qml	2013-05-29 12:42:41 +0000
+++ modules/Ubuntu/Components/Button.qml	2013-06-13 12:43:26 +0000
@@ -49,7 +49,7 @@
             }
         }
     \endqml
-    An \l Action can be used to specify \b clicked, \l iconSource and \l text. Example:
+    An \l Action can be used to specify \b clicked, iconSource and text. Example:
     \qml
         Item {
             Action {
@@ -83,16 +83,16 @@
        The source URL of the icon to display inside the button.
        Leave this value blank for a text-only button.
        If \l action is set, the default iconSource is that of the action.
+       \qmlproperty url iconSource
     */
-    property url iconSource: action ? action.iconSource : ""
 
     /*!
        The text to display in the button. If an icon was defined,
        the text will be shown next to the icon, otherwise it will
        be centered. Leave blank for an icon-only button.
        If \l action is set, the default text is that of the action.
+       \qmlproperty string text
     */
-    property string text: action ? action.text : undefined
 
     /*!
        The position of the icon relative to the text. Options

=== modified file 'modules/Ubuntu/Components/ListItems/Empty.qml'
--- modules/Ubuntu/Components/ListItems/Empty.qml	2013-05-19 19:03:44 +0000
+++ modules/Ubuntu/Components/ListItems/Empty.qml	2013-06-13 12:43:26 +0000
@@ -89,11 +89,6 @@
     property bool highlightWhenPressed: true
 
     /*!
-      The property holds the attached action to the list item.
-      */
-    property Action action
-
-    /*!
       \preliminary
       Defines if this item can be removed or not.
      */

=== modified file 'modules/Ubuntu/Components/ListItems/MultiValue.qml'
--- modules/Ubuntu/Components/ListItems/MultiValue.qml	2013-02-01 12:00:30 +0000
+++ modules/Ubuntu/Components/ListItems/MultiValue.qml	2013-06-13 12:43:26 +0000
@@ -50,7 +50,6 @@
       The text that is shown in the list item as a label.
       \qmlproperty string text
      */
-    property alias text: label.text
 
     /*!
       \preliminary
@@ -73,6 +72,7 @@
                 left: parent.left
                 right: parent.right
             }
+            text: multiValueListItem.text
         }
         LabelVisual {
             id: valueLabel

=== modified file 'modules/Ubuntu/Components/ListItems/SingleValue.qml'
--- modules/Ubuntu/Components/ListItems/SingleValue.qml	2013-05-19 19:03:44 +0000
+++ modules/Ubuntu/Components/ListItems/SingleValue.qml	2013-06-13 12:43:26 +0000
@@ -52,7 +52,6 @@
       The text that is shown in the list item as a label.
       \qmlproperty string text
      */
-    property alias text: label.text
 
     /*!
       \preliminary
@@ -68,6 +67,7 @@
             verticalCenter: parent.verticalCenter
             left: parent.left
         }
+        text: listItem.text
         width: Math.min(implicitWidth, parent.width * 0.8)
     }
     LabelVisual {

=== modified file 'modules/Ubuntu/Components/ListItems/Standard.qml'
--- modules/Ubuntu/Components/ListItems/Standard.qml	2013-05-24 09:12:56 +0000
+++ modules/Ubuntu/Components/ListItems/Standard.qml	2013-06-13 12:43:26 +0000
@@ -84,7 +84,6 @@
       The text that is shown in the list item as a label.
       \qmlproperty string text
      */
-    property alias text: label.text
 
     /*!
       \preliminary
@@ -240,6 +239,7 @@
             right: control ? controlContainer.left : (progression ? progressionHelper.left : parent.right)
             rightMargin: listItem.__contentsMargins
         }
+        text: listItem.text
     }
 
     Item {

=== modified file 'modules/Ubuntu/Components/ListItems/ValueSelector.qml'
--- modules/Ubuntu/Components/ListItems/ValueSelector.qml	2013-05-14 13:33:39 +0000
+++ modules/Ubuntu/Components/ListItems/ValueSelector.qml	2013-06-13 12:43:26 +0000
@@ -63,7 +63,6 @@
       The text that is shown in the list item as a label.
       \qmlproperty string text
      */
-    property alias text: label.text
 
     /*!
       \preliminary
@@ -159,6 +158,7 @@
                     verticalCenter: parent.verticalCenter
                     left: parent.left
                 }
+                text: selector.text
                 width: Math.min(implicitWidth, parent.width * 0.8)
             }
             LabelVisual {

=== modified file 'modules/Ubuntu/Components/Popups/ActionSelectionPopover.qml'
--- modules/Ubuntu/Components/Popups/ActionSelectionPopover.qml	2013-05-13 10:14:24 +0000
+++ modules/Ubuntu/Components/Popups/ActionSelectionPopover.qml	2013-06-13 12:43:26 +0000
@@ -100,7 +100,6 @@
     /*!
       The property holds the list of actions to be presented. Each action
       triggered will use the actionHost as caller.
-
       */
     property var actions
 
@@ -110,15 +109,17 @@
       to access action data.
       */
     property Component delegate: Empty {
-        visible: action.visible && action.text !== ""
+        id: listItem
         Label {
-            text: action.text
+            text: listItem.text
             anchors {
                 verticalCenter: parent.verticalCenter
                 horizontalCenter: parent.horizontalCenter
             }
             wrapMode: Text.Wrap
         }
+        /*! \internal */
+        onTriggered: popover.hide()
     }
 
     grabDismissAreaEvents: false
@@ -151,22 +152,11 @@
                         if (item.hasOwnProperty("modelData"))
                             item.modelData = modelData;
                         // auto-connect trigger
-                        // FIXME: define all these signals to the action to be in sync with HUD
-                        if (item.hasOwnProperty("clicked"))
-                            item.clicked.connect(triggerAction);
-                        else if (item.hasOwnProperty("accepted"))
-                            item.accepted.connect(triggerAction);
-                        else if (item.hasOwnProperty("triggered"))
-                            item.triggered.connect(triggerAction);
                         // if the delegate is a list item, hide divider of the last one
                         if (item.hasOwnProperty("showDivider"))
                             item.showDivider = index < (repeater.count - 1);
                     }
                 }
-                function triggerAction() {
-                    modelData.triggered(target);
-                    popover.hide();
-                }
             }
         }
     }

=== modified file 'modules/Ubuntu/Components/qmldir'
--- modules/Ubuntu/Components/qmldir	2013-05-20 13:39:43 +0000
+++ modules/Ubuntu/Components/qmldir	2013-06-13 12:43:26 +0000
@@ -1,6 +1,7 @@
 module Ubuntu.Components
 plugin UbuntuComponents
 Action 0.1 Action.qml
+ActionItem 0.1 ActionItem.qml
 ActionList 0.1 ActionList.qml
 ToolbarActions 0.1 ToolbarActions.qml
 MainView 0.1 MainView.qml

=== added file 'tests/unit/tst_components/tst_actionitem.qml'
--- tests/unit/tst_components/tst_actionitem.qml	1970-01-01 00:00:00 +0000
+++ tests/unit/tst_components/tst_actionitem.qml	2013-06-13 12:43:26 +0000
@@ -0,0 +1,84 @@
+/*
+ * Copyright 2012 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.0
+import QtTest 1.0
+import Ubuntu.Components 0.1
+
+TestCase {
+     name: "ActionItemAPI"
+
+     function initTestCase() {
+         compare(item1.action, null, "action is null by default")
+         compare(item1.text, "", "text is empty string set by default")
+         compare(item1.iconSource, "", "iconSource is empty string by default")
+     }
+
+     function test_action() {
+         compare(item1.action, null,"Action is null by default")
+         item1.action = action1
+         compare(item1.action, action1, "Action can be set")
+         compare(item1.text, action1.text, "text is automatically set to action text")
+         compare(item1.iconSource, action1.iconSource, "iconSource is automatically set to action iconSource")
+         var numTriggers = action1.triggerCount
+         item1.triggered(null)
+         compare(action1.triggerCount, numTriggers+1, "ActionItem triggered() triggers action")
+         item1.action = null
+     }
+
+     // NOTE: This test must be run AFTER test_action(), otherwise setting the action will
+     // not update the text
+     function test_text() {
+         compare(item1.text, "", "text is empty string by default")
+         var newText = "new text"
+         item1.text = newText
+         compare(item1.text, newText, "text can be set")
+         item1.text = ""
+         compare(item1.text, "", "text can be unset")
+     }
+
+     // NOTE: This test must be run AFTER test_action(), otherwise setting the action will
+     // will not update the iconSource
+     function test_iconSource() {
+         compare(item1.iconSource, "", "iconSource is empty string by default")
+         var newIconSource = "../../../examples/ubuntu-ui-toolkit-gallery/small_avatar.png"
+         item1.iconSource = newIconSource
+         compare(item1.iconSource, Qt.resolvedUrl(newIconSource), "iconSource can be set")
+         item1.iconSource = ""
+         compare(item1.iconSource, "", "iconSource can be unset")
+     }
+
+     function test_signal_triggered() {
+         signalSpy.signalName = "triggered";
+         compare(signalSpy.valid,true,"triggered signal exists")
+     }
+
+     ActionItem {
+         id: item1
+         SignalSpy {
+             id: signalSpy
+             target: parent
+         }
+     }
+
+     Action {
+         id: action1
+         text: "actionText"
+         iconSource: "imageURL"
+         property int triggerCount: 0
+         onTriggered: triggerCount++
+     }
+}