Doxygenize SelectionDialog

This commit is contained in:
Aurélien Gâteau 2012-12-17 22:03:08 +01:00
parent 5fb8c46cd5
commit bd9ec5fa67

View File

@ -40,46 +40,39 @@
**
****************************************************************************/
/**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:
QtObject: listView.model:
The model of selectionDialog.
Can be a simple model or a custom QAbstractItemModel
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
import "." 0.1
/**
* A plasma themed SelectionDialog, which can be customized 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.
*/
CommonDialog {
id: root
// Common API
/**
* type:QtObject
* The model of selectionDialog. Can be a simple model or a custom
* QAbstractItemModel
*/
property alias model: listView.model
/**
* Selected index.
*
* The default value is -1.
*/
property int selectedIndex: -1
/**
* The delegate used to render the items.
*/
property Component delegate: defaultDelegate
Component {