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

[Tim Peeters]

Tools are now Items:
- Make ToolbarActions a subclass of Item
- Move the visualization of Actions in Toolbar from Toolbar to ToolbarActions
- Allow the tools properties of Toolbar and Page to be any Item

Tools are now Items:
- Make ToolbarActions a subclass of Item
- Move the visualization of Actions in Toolbar from Toolbar to ToolbarActions
- Allow the tools properties of Toolbar and Page to be any Item

This MR prepares the code for changes to the Action API. We can now support two APIs (the old one will be deprecated) at the same time for defining the actions in a toolbar.

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

552. By Tim Peeters on 2013-06-12

update CHANGES

[Tim Peeters (tpeeters)]

Wait for https://code.launchpad.net/~tpeeters/gallery-app/newTools/+merge/168923 to be included in the image so that gallery-app will not break.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

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

553. By Tim Peeters on 2013-06-12

avoid disappearing tools

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

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

554. By Tim Peeters on 2013-06-13

Change type of tools from ToolbarActions to Item

555. By Tim Peeters on 2013-06-13

support tools items that do not have opened or locked properties

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

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

556. By Tim Peeters on 2013-06-13

update documentation

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Zsombor Egri (zsombi)]

nice work

review: Approve

[Tim Peeters (tpeeters)]

Tested on galaxy nexus with saucy-8. Worked with all apps except gallery-app which has an update to fix in the newest package (not yet included in the image). After apt-get upgrade, all apps including gallery-app work fine.

review: Approve

=== modified file 'CHANGES'
--- CHANGES	2013-05-30 08:21:58 +0000
+++ CHANGES	2013-06-13 09:30:37 +0000
@@ -19,15 +19,18 @@
 * DEPRECATED IN Toolbar: property bool lock
 * DEPRECATED IN ToolbarActions: property bool active
 * DEPRECATED IN ToolbarActions: property bool lock
-* CHANGED IN Page: property Header header to property Header __propagated.header
-* CHANGED IN Page: property Toolbar toolbar to property Toolbar __propagated.toolbar
-* CHANGED IN MainView: property Header header to property Header __propagated.header
-* CHANGED IN MainView: property Toolbar toolbar to property Toolbar __propagated.toolbar
+* CHANGED IN Page: property Header header TO property Header __propagated.header
+* CHANGED IN Page: property Toolbar toolbar TO property Toolbar __propagated.toolbar
+* CHANGED IN MainView: property Header header TO property Header __propagated.header
+* CHANGED IN MainView: property Toolbar toolbar TO property Toolbar __propagated.toolbar
 * DEPRECATED IN Page: property Header header
 * DEPRECATED IN Page: property Toolbar toolbar
 * DEPRECATED IN MainView: property Header header
 * DEPRECATED IN Page: property Toolbar toolbar
 * REMOVED in MainView: property QtObject __hud 
+* CHANGED in ToolbarActions: INHERIT Item INSTEAD OF ActionList
+* CHANGED in Page: property ToolbarActions tools TO property Item tools
+* CHANGED IN Toolbar: property ToolbarActions tools TO property Item tools
 
 Compatibility Breaks
 ********************

=== modified file 'components.api'
--- components.api	2013-05-29 16:18:00 +0000
+++ components.api	2013-06-13 09:30:37 +0000
@@ -287,9 +287,11 @@
 Panel
     property bool active
     property bool lock
-    property ToolbarActions tools
+    property Item tools
 modules/Ubuntu/Components/ToolbarActions.qml
-ActionList
+Item
+    default property alias children
+    property list<Action> actions
     property Action back
     property Item __pageStack
     property bool opened

=== modified file 'modules/Ubuntu/Components/Page.qml'
--- modules/Ubuntu/Components/Page.qml	2013-05-22 16:24:18 +0000
+++ modules/Ubuntu/Components/Page.qml	2013-06-13 09:30:37 +0000
@@ -76,7 +76,7 @@
     /*!
       The list of actions associated with this Page.
      */
-    property ToolbarActions tools: ToolbarActions { }
+    property Item tools: ToolbarActions { }
 
     /*!
       Optional flickable that controls the header. This property
@@ -109,7 +109,7 @@
                     internal.header.flickable = page.flickable;
                 }
                 if (tools) {
-                    tools.__pageStack = page.pageStack;
+                    if (tools.hasOwnProperty("__pageStack")) tools.__pageStack = page.pageStack;
                 }
                 if (internal.toolbar) {
                     internal.toolbar.tools = page.tools;

=== modified file 'modules/Ubuntu/Components/Toolbar.qml'
--- modules/Ubuntu/Components/Toolbar.qml	2013-05-23 17:00:58 +0000
+++ modules/Ubuntu/Components/Toolbar.qml	2013-06-13 09:30:37 +0000
@@ -63,17 +63,19 @@
       \preliminary
       The list of \l Actions to be shown on the toolbar
      */
-    property ToolbarActions tools: null
+    property Item tools: null
+
     /*! \internal */
     onToolsChanged: {
-        locked = tools.locked;
-        if (tools && tools.opened && tools.locked) {
+        if (tools.hasOwnProperty("locked")) locked = tools.locked;
+        if (tools && tools.hasOwnProperty("locked") && tools.hasOwnProperty("opened")
+                && tools.opened && tools.locked) {
             // toolbar is locked in visible state.
-            internal.visibleTools = tools;
+            internal.updateVisibleTools();
             opened = true;
         } else if (!opened && !animating) {
             // toolbar is invisible
-            internal.visibleTools = tools;
+            internal.updateVisibleTools();
         } else {
             opened = false;
             // internal.visibleTools will be updated
@@ -82,22 +84,30 @@
     }
 
     // if tools is not specified, lock the toolbar in closed position
-    locked: tools ? tools.locked : true
+    locked: tools && tools.hasOwnProperty("locked") ? tools.locked : false
 
     Connections {
         target: tools
+        ignoreUnknownSignals: true
         onOpenedChanged: toolbar.opened = tools.opened;
         onLockedChanged: toolbar.locked = tools.locked;
     }
 
     QtObject {
         id: internal
-        property ToolbarActions visibleTools: tools
+        property Item visibleTools: tools
+        function updateVisibleTools() {
+            if (internal.visibleTools !== toolbar.tools) {
+                if (internal.visibleTools) internal.visibleTools.parent = null;
+                internal.visibleTools = toolbar.tools;
+                internal.visibleTools.parent = visibleToolsContainer;
+            }
+        }
     }
 
     onAnimatingChanged: {
         if (!animating && !opened) {
-            internal.visibleTools = toolbar.tools;
+            internal.updateVisibleTools();
         }
     }
 
@@ -120,58 +130,10 @@
         property bool animating: toolbar.animating
     }
 
-    Component {
-        id: toolButtonComponent
-        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"
-            width: units.gu(5)
-            height: toolbar.height
-        }
-    }
-
-    Loader {
-        id: backButton
-        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) {
-                if (item.hasOwnProperty("action")) item.action = backAction;
-            }
-        }
-        // 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 {
-        id: toolButtonsContainer
-        anchors {
-            right: parent.right
-            bottom: parent.bottom
-            top: parent.top
-            rightMargin: units.gu(2)
-        }
-        spacing: units.gu(1)
-
-        Repeater {
-            model: internal.visibleTools ? internal.visibleTools.children : 0
-            Loader {
-                sourceComponent: modelData.itemHint ? modelData.itemHint : toolButtonComponent
-                anchors.verticalCenter: toolButtonsContainer.verticalCenter
-                onStatusChanged: {
-                    if (item && status == Loader.Ready) {
-                        if (item.hasOwnProperty("action")) item.action = modelData
-                    }
-                }
-            }
+    Item {
+        id: visibleToolsContainer
+        anchors {
+            fill: background
         }
     }
 }

=== modified file 'modules/Ubuntu/Components/ToolbarActions.qml'
--- modules/Ubuntu/Components/ToolbarActions.qml	2013-05-30 12:07:03 +0000
+++ modules/Ubuntu/Components/ToolbarActions.qml	2013-06-13 09:30:37 +0000
@@ -15,6 +15,11 @@
  */
 
 import QtQuick 2.0
+// FIXME: When a module contains QML, C++ and JavaScript elements exported,
+// we need to use named imports otherwise namespace collision is reported
+// by the QML engine. As workaround, we use Theming named import.
+// Bug to watch: https://bugreports.qt-project.org/browse/QTBUG-27645
+import Ubuntu.Components 0.1 as Theming
 
 /*!
     \qmltype ToolbarActions
@@ -70,8 +75,88 @@
         }
     \endqml
 */
-ActionList {
+Item {
     id: toolbarActions
+    anchors.fill: parent
+
+    // internal objects using nested elements,
+    // which isn't allowed by QtObject; this fix makes this possible
+    /*!
+      Default property to allow adding of children. For example, the tools of a \l Page
+      can be defined as follows:
+      \qml
+          import QtQuick 2.0
+          import Ubuntu.Components 0.1
+
+          MainView {
+              width: units.gu(50)
+              height: units.gu(80)
+
+              Page {
+                  title: "test page"
+
+                  Label {
+                      anchors.centerIn: parent
+                      text: "Hello, world"
+                  }
+
+                  tools: ToolbarActions {
+                      Action {
+                          text: "action 1"
+                      }
+                      Action {
+                          text: "action 2"
+                      }
+                  }
+              }
+          }
+      \endqml
+      ToolbarActions will automatically create a visual representation of the actions.
+      \qmlproperty list<Action> children
+      */
+    default property alias children: toolbarActions.actions
+
+    /*!
+      List of already defined actions when not defining them as children of the ToolbarActions.
+      Note that when you set this property, the children of ToolbarActions will be ignored,
+      so do not set the list and define children.
+      \qml
+        import QtQuick 2.0
+        import Ubuntu.Components 0.1
+
+        MainView {
+            width: units.gu(50)
+            height: units.gu(80)
+
+            Action {
+                id: action1
+                text: "action 1"
+                onTriggered: print("one!")
+            }
+            Action {
+                id: action2
+                text: "action 2"
+                onTriggered: print("two!")
+            }
+
+            Page {
+                title: "test page"
+
+                Label {
+                    anchors.centerIn: parent
+                    text: "Hello, world"
+                }
+
+                tools: ToolbarActions {
+                    actions: [action1, action2]
+                }
+            }
+        }
+      \endqml
+      the advantage of setting actions over using the children is that the same
+      \l Action items can be used in several sets of actions.
+      */
+    property list<Action> actions
 
     /*!
       The back \l Action. If the action is visible, the back button will be shown
@@ -150,4 +235,59 @@
         }
         return false;
     }
+
+    Component {
+        id: toolButtonComponent
+        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"
+            width: units.gu(5)
+            height: toolbarActions.height
+        }
+    }
+
+    Loader {
+        id: backButton
+        property Action backAction: toolbarActions.back
+        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) {
+                if (item.hasOwnProperty("action")) item.action = backAction;
+            }
+        }
+        // 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 {
+        id: toolButtonsContainer
+        anchors {
+            right: parent.right
+            bottom: parent.bottom
+            top: parent.top
+            rightMargin: units.gu(2)
+        }
+        spacing: units.gu(1)
+
+        Repeater {
+            model: toolbarActions.actions
+            Loader {
+                sourceComponent: modelData.itemHint ? modelData.itemHint : toolButtonComponent
+                anchors.verticalCenter: toolButtonsContainer.verticalCenter
+                onStatusChanged: {
+                    if (item && status == Loader.Ready) {
+                        if (item.hasOwnProperty("action")) item.action = modelData
+                    }
+                }
+            }
+        }
+    }
 }