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

[Tim Peeters]

Add action property to AbstractButton, and use it in the toolbar.

Add action property to AbstractButton, and use it in the toolbar.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Zsombor Egri (zsombi)]

looks cool :)

review: Approve

=== modified file 'components.api'
--- components.api	2013-05-22 11:27:49 +0000
+++ components.api	2013-05-28 12:40:33 +0000
@@ -1,5 +1,6 @@
 modules/Ubuntu/Components/AbstractButton.qml
 Item
+    property Action action
     signal clicked()
     signal pressAndHold()
     property bool pressed
 
=== modified file 'modules/Ubuntu/Components/AbstractButton.qml'
--- modules/Ubuntu/Components/AbstractButton.qml	2013-04-17 11:06:44 +0000
+++ modules/Ubuntu/Components/AbstractButton.qml	2013-05-28 12:40:33 +0000
@@ -31,35 +31,48 @@
     id: button
 
     /*!
-       \preliminary
+      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).
+     */
+    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
-       and the button is not disabled.
+       and the button is not disabled. If \l action is defined,
+       the action will be triggered.
     */
     signal clicked()
 
+    /*!
+      If \l action was set, action.triggered() is automatically called with
+      the AbstractButton as parameter.
+     */
+    onClicked: if (action) action.triggered(button)
+
     Keys.onEnterPressed: clicked()
     Keys.onReturnPressed: clicked()
 
     /*!
-      \preliminary
       This handler is called when there is a long press.
      */
     signal pressAndHold()
 
     /*!
-     \preliminary
       True if the user presses a mouse button in the button's mouse area.
      */
     property bool pressed: mouseArea.pressed
 
     /*!
-      \preliminary
       True if the mouse cursor hovers over the button's mouse area.
      */
     property bool hovered: __acceptEvents && mouseArea.containsMouse
 
-
-    /*! \internal
+    /*!
+      \internal
       Disable or enable signal emition by default.
       Some classes want to emit the signal by themselves (ListItem.Standard)
      */
 
=== modified file 'modules/Ubuntu/Components/Button.qml'
--- modules/Ubuntu/Components/Button.qml	2013-05-24 09:12:56 +0000
+++ modules/Ubuntu/Components/Button.qml	2013-05-28 12:40:33 +0000
@@ -49,6 +49,22 @@
             }
         }
     \endqml
+    An \l Action can be used to specify \l clicked(), \l iconSource and \l text. Example:
+    \qml
+        Item {
+            Action {
+                id: action1
+                text: "Click me"
+                onTriggered: print("action!")
+                iconSource: "icon.png"
+            }
+            Button {
+                anchors.centerIn: parent
+                action: action1
+                color: "green"
+            }
+       }
+    \endqml
 */
 AbstractButton {
     id: button
@@ -59,31 +75,26 @@
     implicitHeight: units.gu(4)
 
     /*!
-       \preliminary
        The foreground color of the button in idle state.
     */
     property color color: "transparent"
 
     /*!
-       \preliminary
        The source URL of the icon to display inside the button.
        Leave this value blank for a text-only button.
-       \qmlproperty url iconSource
+       If \l action is set, the default iconSource is that of the action.
     */
-    property url iconSource: ""
+    property url iconSource: action ? action.iconSource : ""
 
     /*!
-       \preliminary
        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.
-       \qmlproperty string text
+       If \l action is set, the default text is that of the action.
     */
-    property string text
+    property string text: action ? action.text : undefined
 
     /*!
-       \preliminary
-
        The position of the icon relative to the text. Options
        are "left" and "right". The default value is "left".
 
 
=== modified file 'modules/Ubuntu/Components/Toolbar.qml'
--- modules/Ubuntu/Components/Toolbar.qml	2013-05-02 19:18:09 +0000
+++ modules/Ubuntu/Components/Toolbar.qml	2013-05-28 12:40:33 +0000
@@ -122,15 +122,12 @@
 
     Component {
         id: toolButtonComponent
-        Item {
+        Button {
             id: toolButton
+            // Disable the mouse area so swipes on the button will not be blocked
+            // from going to the toolbar. The panel will take care calling the button's clicked().
+            __mouseArea.visible: false
             Theming.ItemStyle.class: "toolbar-button"
-            property string text: action && action.text ? action.text : ""
-            property url iconSource: action && action.iconSource ? action.iconSource : ""
-            signal clicked()
-            onClicked: action.triggered(toolButton)
-            enabled: action && action.enabled
-            visible: action && action.visible
             width: units.gu(5)
             height: toolbar.height
         }
@@ -138,22 +135,20 @@
 
     Loader {
         id: backButton
-        property Action action: toolbar.tools && toolbar.tools.back ? toolbar.tools.back : null
-        sourceComponent: action ? action.itemHint ? action.itemHint : toolButtonComponent : null
+        property Action backAction: toolbar.tools ? toolbar.tools.back : null
+        sourceComponent: backAction ? backAction.itemHint ? backAction.itemHint : toolButtonComponent : null
         anchors {
             left: parent.left
             leftMargin: units.gu(2)
             verticalCenter: parent.verticalCenter
         }
         onStatusChanged: {
-            if (item && status == Loader.Ready && action && action.itemHint) {
-                if (item.hasOwnProperty("clicked")) item.clicked.connect(backButton.itemTriggered);
-                if (item.hasOwnProperty("accepted")) item.accepted.connect(backButton.itemTriggered);
-                if (item.hasOwnProperty("triggered")) item.accepted.connect(backButton.itemTtriggered);
+            if (item && status == Loader.Ready) {
+                if (item.hasOwnProperty("action")) item.action = backAction;
             }
         }
-        signal itemTriggered()
-        onItemTriggered: action.triggered(item)
+        // ensure the item's action is up-to-date (which is not the case without this line):
+        onBackActionChanged: if (item && item.hasOwnProperty("action")) item.action = backAction;
     }
 
     Row {
@@ -170,8 +165,12 @@
             model: internal.visibleTools ? internal.visibleTools.children : 0
             Loader {
                 sourceComponent: modelData.itemHint ? modelData.itemHint : toolButtonComponent
-                property Action action: modelData
                 anchors.verticalCenter: toolButtonsContainer.verticalCenter
+                onStatusChanged: {
+                    if (item && status == Loader.Ready) {
+                        if (item.hasOwnProperty("action")) item.action = modelData
+                    }
+                }
             }
         }
     }
 
=== modified file 'tests/unit/tst_components/tst_abstractbutton.qml'
--- tests/unit/tst_components/tst_abstractbutton.qml	2012-11-21 21:23:04 +0000
+++ tests/unit/tst_components/tst_abstractbutton.qml	2013-05-28 12:40:33 +0000
@@ -21,6 +21,16 @@
 TestCase {
      name: "AbstractButtonAPI"
 
+     function test_action() {
+         compare(absButton.action, null,"Action is null by default")
+         absButton.action = action1
+         compare(absButton.action, action1, "Action can be set")
+         var numTriggers = action1.triggerCount
+         absButton.clicked()
+         compare(action1.triggerCount, numTriggers+1, "Button clicked triggers action")
+         absButton.action = null
+     }
+
      function test_hovered() {
         compare(absButton.hovered,false,"Hovered is boolean and false by default")
      }
@@ -46,4 +56,10 @@
              target: parent
          }
      }
+
+     Action {
+         id: action1
+         property int triggerCount: 0
+         onTriggered: triggerCount++
+     }
 }
 
=== modified file 'tests/unit/tst_components/tst_button.qml'
--- tests/unit/tst_components/tst_button.qml	2013-05-06 13:11:21 +0000
+++ tests/unit/tst_components/tst_button.qml	2013-05-28 12:40:33 +0000
@@ -28,6 +28,18 @@
         compare(button.text,newText,"Can set/get text")
     }
 
+    function test_action() {
+        compare(actionButton.action, null, "Action is null by default")
+        actionButton.action = action1
+        compare(actionButton.action, action1, "action can be set")
+        var newText = "Hello action!"
+        action1.text = newText
+        compare(actionButton.text, newText, "action can be used to define text")
+        var newIcon = "../../../examples/ubuntu-ui-toolkit-gallery/small_avatar.png"
+        action1.iconSource = newIcon
+        compare(actionButton.iconSource, Qt.resolvedUrl(newIcon), "action can be used to define iconSource")
+    }
+
     function test_iconPosition() {
         compare(button.iconPosition,"left","The default value for iconPosition is 'left'")
         var newIconPosition = "right"
@@ -73,4 +85,14 @@
             target: parent
         }
     }
+
+    // Use a new button for action tests, because other tests override
+    //  the button's default text and iconSource so they are no longer
+    //  automatically taken from the action.
+    Button {
+        id: actionButton
+    }
+    Action {
+        id: action1
+    }
 }