add ScrollArea.qml

a component that automatically creates the scrollbars/scrollindicators/sectionscrollers for a Flickable, ListView or GridView

declarativeimports/plasmaextracomponents/qml/ScrollArea.qml

@@ -0,0 +1,155 @@
+/*
+*   Copyright 2012 Marco Martin <mart@kde.org>
+*
+*   This program is free software; you can redistribute it and/or modify
+*   it under the terms of the GNU Library General Public License as
+*   published by the Free Software Foundation; either version 2, or
+*   (at your option) any later version.
+*
+*   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 Library General Public License for more details
+*
+*   You should have received a copy of the GNU Library General Public
+*   License along with this program; if not, write to the
+*   Free Software Foundation, Inc.,
+*   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+*/
+
+/**Documented API
+Inherits:
+        Item
+
+Imports:
+        QtQuick 1.1
+        org.kde.plasma.components 0.1
+
+Description:
+    This item takes a Flickable and automatically puts scrollbars in adjusting the layout if needed. The scrollbars will be interactive or not, depending on the platform.
+    If flickableItem is a categorized ListView the vertical scrollbar will be a SectionScroller.
+
+Properties:
+    Item flickableItem:
+    The Flickable of this area: it can be either a Flickable or a subclass, ListView or GridView
+**/
+
+import QtQuick 1.1
+import org.kde.plasma.components 0.1
+
+Item {
+    id: root
+
+    property Flickable flickableItem
+    //FIXME: this alias seems necessary for it to correctly parse
+    default property alias flickableItemDefault: root.flickableItem
+
+    Connections {
+        target: root
+        onFlickableItemChanged: {
+            root.flickableItem.parent = root
+            root.flickableItem.anchors.fill = root
+            internal.checkVerticalScrollBar()
+            internal.checkHorizontalScrollBar()
+        }
+    }
+    Component.onCompleted: {
+        root.flickableItem.parent = root
+        root.flickableItem.anchors.fill = root
+        internal.checkVerticalScrollBar()
+        internal.checkHorizontalScrollBar()
+    }
+    Connections {
+        target: flickableItem
+        onContentHeightChanged: internal.checkVerticalScrollBar()
+        onContentWidthChanged: internal.checkHorizontalScrollBar()
+    }
+    QtObject {
+        id: internal
+        property Item verticalScrollBar
+        property Item horizontalScrollBar
+
+        function checkVerticalScrollBar()
+        {
+            if (!flickableItem) {
+                return
+            }
+
+            if (flickableItem.contentHeight > flickableItem.height) {
+                //Do we have to change the type?
+                //from section to normal
+                if ((!flickableItem.section || !flickableItem.section.property) &&
+                    (!verticalScrollBar || verticalScrollBar.orientation === undefined)) {
+                    if (verticalScrollBar) verticalScrollBar.destroy()
+                    verticalScrollBar = verticalScrollBarComponent.createObject(root)
+                //from normal to section
+                } else if (flickableItem.section && flickableItem.section.property &&
+                    (!verticalScrollBar || verticalScrollBar.orientation !== undefined)) {
+                    if (verticalScrollBar) verticalScrollBar.destroy()
+                    verticalScrollBar = sectionScrollerComponent.createObject(root)
+                }
+
+                if (verticalScrollBar.interactive) {
+                    flickableItem.anchors.leftMargin = verticalScrollBar.width
+                } else {
+                    flickableItem.anchors.leftMargin = 0
+                }
+            }
+        }
+
+        function checkHorizontalScrollBar()
+        {
+            if (!flickableItem || horizontalScrollBar) {
+                return
+            }
+
+            if (flickableItem.contentWidth > flickableItem.width) {
+                horizontalScrollBar = horizontalScrollBarComponent.createObject(root)
+
+                if (verticalScrollBar.interactive) {
+                    flickableItem.anchors.leftMargin = verticalScrollBar.width
+                } else {
+                    flickableItem.anchors.leftMargin = 0
+                }
+            }
+        }
+    }
+    Component {
+        id: verticalScrollBarComponent
+        ScrollBar {
+            flickableItem: root.flickableItem
+            orientation: Qt.Vertical
+            anchors {
+                left: undefined
+                top: parent.top
+                right: parent.right
+                bottom: parent.bottom
+            }
+        }
+    }
+    Component {
+        id: horizontalScrollBarComponent
+        ScrollBar {
+            flickableItem: root.flickableItem
+            orientation: Qt.Horizontal
+            anchors {
+                left: parent.left
+                top: undefined
+                right: parent.right
+                bottom: parent.bottom
+            }
+        }
+    }
+    Component {
+        id: sectionScrollerComponent
+        SectionScroller {
+            listView: root.flickableItem
+            anchors {
+                left: undefined
+                top: parent.top
+                right: parent.right
+                bottom: parent.bottom
+            }
+        }
+    }
+}

declarativeimports/plasmaextracomponents/qml/qmldir

@@ -3,6 +3,7 @@ plugin plasmaextracomponentsplugin
 App 0.1 App.qml
 Heading 0.1 Heading.qml
 Paragraph 0.1 Paragraph.qml
+ScrollArea 0.1 ScrollArea.qml
 Title 0.1 Title.qml
 
 ActivateAnimation 0.1 ActivateAnimation.qml