Add documentation for the Scrollbar.qml

This commit is contained in:
Giorgos Tsiapaliwkas 2011-11-02 03:29:15 +02:00
parent 41472f8dbe
commit 32fd687e61

View File

@ -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
}