Add documentation for SectionScroller.qml

This commit is contained in:
Giorgos Tsiapaliwkas 2011-11-02 03:32:04 +02:00
parent 32fd687e61
commit f3bdcfa3b8

View File

@ -37,21 +37,34 @@
** $QT_END_LICENSE$
**
****************************************************************************/
/**Documentanted API
Inherits:
Item
Imports:
QtQuick 1.1
org.kde.plasma.core
SectionScroller.js
Description:
It's similar to a ScrollBar or a ScrollDecorator.
It's interactive and works on ListViews that have section.property set,
so its contents are categorized.
An indicator will say to what category the user scrolled to.
Useful for things like address books or things sorted by date.
Don't use with models too big (thousands of items) because implies
loading all the items to memory, as well loses precision.
Properties:
ListView listView:
TODO needs info
**/
import QtQuick 1.1
import "SectionScroller.js" as Sections
import org.kde.plasma.core 0.1 as PlasmaCore
/**
* It's similar to a ScrollBar or a ScrollDecorator.
* It's interactive and works on ListViews that have section.property set,
* so its contents are categorized.
* An indicator will say to what category the user scrolled to.
*
* Useful for things like address books or things sorted by date.
* Don't use with models too big (thousands of items) because implies
* loading all the items to memory, as well loses precision.
*/
Item {
id: root