Doc fixes to the Positioners/Layouts documentation
authorJan Arve Saether <jan-arve.saether@digia.com>
Fri, 24 May 2013 14:56:26 +0000 (16:56 +0200)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Thu, 30 May 2013 10:07:18 +0000 (12:07 +0200)
* Add references to Qt Quick Layouts
* Don't lie about that Positioners can resize the items
* Rename title from "Item Layouts" to "Item Positioners" to avoid
  confusion with Qt Quick Layouts

Change-Id: I43e3ad6e6d9e4b08a1233868c75f0efcab43f8c3
Reviewed-by: Caroline Chao <caroline.chao@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
src/quick/doc/qtquick.qdocconf
src/quick/doc/src/concepts/positioning/layouts.qdoc
src/quick/items/qquickitem.cpp
src/quick/items/qquickpositioners.cpp

index 96b6f83..13b03d4 100644 (file)
@@ -34,7 +34,7 @@ qhp.QtQuick.subprojects.examples.selectors = fake:example
 
 tagfile                 = ../../../doc/qtquick/qtquick.tags
 
-depends += qtcore qtxmlpatterns qtqml qtgui qtlinguist qtquickcontrols qtdoc
+depends += qtcore qtxmlpatterns qtqml qtgui qtlinguist qtquickcontrols qtquicklayouts qtdoc
 
 headerdirs  += ..
 
index 785bcc6..35be2f6 100644 (file)
@@ -28,9 +28,9 @@
 /*!
 \ingroup qtquick-positioners
 \page qtquick-positioning-layouts.html
-\title Item Layouts
+\title Item Positioners
 
-Positioner items are container items that manage the positions and sizes of
+Positioner items are container items that manage the positions of
 items in a declarative user interface. Positioners behave in a similar way to
 the \l{Widgets and Layouts}{layout managers} used with standard Qt widgets,
 except that they are also containers in their own right.
@@ -38,6 +38,10 @@ except that they are also containers in their own right.
 Positioners make it easier to work with many items when they need
 to be arranged in a regular layout.
 
+\l{Qt Quick Layouts} can also be used to arrange Qt Quick items in a user interface.
+They manage both the positions and the sizes of items on a declarative user interface,
+and are well suited for resizable user interfaces.
+
 \section1 Positioners
 
 A set of standard positioners are provided in the basic set of Qt Quick
index 58e1612..110e14d 100644 (file)
@@ -1363,7 +1363,7 @@ QQuickKeysAttached *QQuickKeysAttached::qmlAttachedProperties(QObject *obj)
     \brief Property used to mirror layout behavior
 
     The LayoutMirroring attached property is used to horizontally mirror \l {anchor-layout}{Item anchors},
-    \l{Item Layouts}{positioner} types (such as \l Row and \l Grid)
+    \l{Item Positioners}{positioner} types (such as \l Row and \l Grid)
     and views (such as \l GridView and horizontal \l ListView). Mirroring is a visual change: left
     anchors become right anchors, and positioner types like \l Grid and \l Row reverse the
     horizontal layout of child items.
@@ -1403,7 +1403,7 @@ QQuickKeysAttached *QQuickKeysAttached::qmlAttachedProperties(QObject *obj)
 
     This property holds whether the item's layout is mirrored horizontally. Setting this to true
     horizontally reverses \l {anchor-layout}{anchor} settings such that left anchors become right,
-    and right anchors become left. For \l{Item Layouts}{positioner} types
+    and right anchors become left. For \l{Item Positioners}{positioner} types
     (such as \l Row and \l Grid) and view types (such as \l {GridView}{GridView} and \l {ListView}{ListView})
     this also mirrors the horizontal layout direction of the item.
 
index 789d2e6..b07a38c 100644 (file)
@@ -626,7 +626,7 @@ void QQuickPositionerAttached::setIsLastItem(bool isLastItem)
     more information about its position within the Column.
 
     For more information on using Column and other related positioner-types, see
-    \l{Item Layouts}.
+    \l{Item Positioners}.
 
 
     \section1 Using Transitions
@@ -644,7 +644,7 @@ void QQuickPositionerAttached::setIsLastItem(bool isLastItem)
 
     \image verticalpositioner_transition.gif
 
-    \sa Row, Grid, Flow, Positioner, {Qt Quick Examples - Positioners}
+    \sa Row, Grid, Flow, Positioner, ColumnLayout, {Qt Quick Examples - Positioners}
 */
 /*!
     \qmlproperty Transition QtQuick2::Column::populate
@@ -795,10 +795,10 @@ void QQuickColumn::reportConflictingAnchors()
     more information about its position within the Row.
 
     For more information on using Row and other related positioner-types, see
-    \l{Item Layouts}.
+    \l{Item Positioners}.
 
 
-    \sa Column, Grid, Flow, Positioner, {Qt Quick Examples - Positioners}
+    \sa Column, Grid, Flow, Positioner, RowLayout, {Qt Quick Examples - Positioners}
 */
 /*!
     \qmlproperty Transition QtQuick2::Row::populate
@@ -1028,10 +1028,10 @@ void QQuickRow::reportConflictingAnchors()
     or anchor itself with any of the \l {Item::anchors}{anchor} properties.
 
     For more information on using Grid and other related positioner-types, see
-    \l{Item Layouts}.
+    \l{Item Positioners}.
 
 
-    \sa Flow, Row, Column, Positioner, {Qt Quick Examples - Positioners}
+    \sa Flow, Row, Column, Positioner, GridLayout, {Qt Quick Examples - Positioners}
 */
 /*!
     \qmlproperty Transition QtQuick2::Grid::populate
@@ -1570,7 +1570,7 @@ void QQuickGrid::reportConflictingAnchors()
     or anchor itself with any of the \l {Item::anchors}{anchor} properties.
 
     For more information on using Flow and other related positioner-types, see
-    \l{Item Layouts}.
+    \l{Item Positioners}.
 
   \sa Column, Row, Grid, Positioner, {Qt Quick Examples - Positioners}
 */