ItemDelegate: Document how to use highlighted with ListView.isCurrentItem

Change-Id: Ia77e4ddf52dc2e39b95ac8acfdada629b18b0696
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>

1 files changed, 14 insertions, 1 deletions

diff --git a/src/quicktemplates2/qquickitemdelegate.cpp b/src/quicktemplates2/qquickitemdelegate.cpp
index 9ff068f1..d0cc7539 100644
--- a/src/quicktemplates2/qquickitemdelegate.cpp
+++ b/src/quicktemplates2/qquickitemdelegate.cpp
@@ -86,7 +86,20 @@ QQuickItemDelegate::QQuickItemDelegate(QQuickItemDelegatePrivate &dd, QQuickItem
     This property holds whether the delegate is highlighted.
 
     A delegate can be highlighted in order to draw the user's attention towards
-    it. It has no effect on keyboard interaction.
+    it. It has no effect on keyboard interaction. For example, you can
+    highlight the current item in a ListView using the following code:
+
+    \code
+    ListView {
+        id: listView
+        model: 10
+        delegate: ItemDelegate {
+            text: modelData
+            highlighted: ListView.isCurrentItem
+            onClicked: listView.currentIndex = index
+        }
+    }
+    \endcode
 
     The default value is \c false.
 */