From 32fd687e61b1590f8d315da0410fcb0caa9e7da5 Mon Sep 17 00:00:00 2001 From: Giorgos Tsiapaliwkas Date: Wed, 2 Nov 2011 03:29:15 +0200 Subject: [PATCH] Add documentation for the Scrollbar.qml --- .../plasmacomponents/qml/ScrollBar.qml | 43 ++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/declarativeimports/plasmacomponents/qml/ScrollBar.qml b/declarativeimports/plasmacomponents/qml/ScrollBar.qml index 9a5b637c0..6ef8074e9 100644 --- a/declarativeimports/plasmacomponents/qml/ScrollBar.qml +++ b/declarativeimports/plasmacomponents/qml/ScrollBar.qml @@ -17,6 +17,47 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ +/**Documentanted API + Inherits: + Item + + Imports: + org.kde.plasma.core + QtQuick 1.1 + + Description: + Just a simple scrollbar which is using the plasma theme. + Plasma theme is the theme which changes via the systemsetting-workspace appearence + -desktop theme. + + Properties: + + int orientation: + Sets the orientation. + + bool animated: + TODO + + bool inverted: + Sets if the scrollbar will be inverted or not. + + bool updateValueWhileDragging: true + Sets if the Scrollbar will be resized while it is being dragged. + + alias stepSize: + Sets the step with which the scrollbar is moving. + + alias pressed: + If the scrollbar is pressed it returns true,otherwise false. + + real scrollButtonInterval: 50 + + property Flickable flickableItem: null + + property bool interactive: + If true,then the scrollbar is interactive otherwise it isn't. +**/ + import QtQuick 1.1 import org.kde.plasma.core 0.1 as PlasmaCore @@ -53,7 +94,7 @@ Item { anchors { right: flickableItem.right - left: (orientation == Qt.Vertical) ? undefined : flickableItem.left + left: (orientation == Qt.Vertical) ? undefined : flickableItem.left top: (orientation == Qt.Vertical) ? flickableItem.top : undefined bottom: flickableItem.bottom }