add documentantion for the SelectionDialog.qml

This commit is contained in:
Giorgos Tsiapaliwkas 2011-12-22 16:41:33 +02:00
parent 421b03e92b
commit 2711e8cb83

View File

@ -40,6 +40,34 @@
**
****************************************************************************/
/**Documentanted API
Inherits:
CommonDialog
Imports:
org.kde.plasma.core
QtQuick 1.1
"." 0.1
Description:
This is plasma themed SelectionDialog, with which you can customize the visual representation
of the selectable items' list by overriding the ListView delegate.
By default SelectionDialog provides a scrollable list of textual menu items.
The user can choose one item from the list at a time.
Properties:
alias model: listView.model:
The model of selectionDialog.
It is just a simple model.
int selectedIndex: -1
It returns the index that the user has selected.
The default value is -1.
Component delegate:
This is a common delegate with which,you will choose
how your items will be displayed.
**/
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore