Document that add transitions should not animate item height

Change-Id: I4941e96e9ea96dfe364b9b95a00372d94695c7a3
Reviewed-by: Bea Lam <bea.lam@nokia.com>

diff --git a/src/quick/items/qquickgridview.cpp b/src/quick/items/qquickgridview.cpp
index 139f9e7..e72207c 100644 (file)
--- a/src/quick/items/qquickgridview.cpp
+++ b/src/quick/items/qquickgridview.cpp
@@ -1765,8 +1765,10 @@ void QQuickGridView::setSnapMode(SnapMode mode)
     documentation.
 
     \note This transition is not applied to the items that are created when the view is initially
-    populated, or when the view's \l model changes. In those cases, the \l populate transition is
-    applied instead.
+    populated, or when the view's \l model changes. (In those cases, the \l populate transition is
+    applied instead.) Additionally, this transition should \e not animate the height of the new item;
+    doing so will cause any items beneath the new item to be laid out at the wrong position. Instead,
+    the height can be animated within a \l {ListView::onAdd()}{ListView.onAdd} in the delegate.
 
     \sa addDisplaced, populate, ViewTransition
 */

diff --git a/src/quick/items/qquicklistview.cpp b/src/quick/items/qquicklistview.cpp
index f9ff4db..b92737c 100644 (file)
--- a/src/quick/items/qquicklistview.cpp
+++ b/src/quick/items/qquicklistview.cpp
@@ -2433,8 +2433,10 @@ void QQuickListView::setSnapMode(SnapMode mode)
     documentation.
 
     \note This transition is not applied to the items that are created when the view is initially
-    populated, or when the view's \l model changes. In those cases, the \l populate transition is
-    applied instead.
+    populated, or when the view's \l model changes. (In those cases, the \l populate transition is
+    applied instead.) Additionally, this transition should \e not animate the height of the new item;
+    doing so will cause any items beneath the new item to be laid out at the wrong position. Instead,
+    the height can be animated within a \l {ListView::onAdd()}{ListView.onAdd} in the delegate.
 
     \sa addDisplaced, populate, ViewTransition
 */