aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items/qquickgridview.cpp
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@digia.com>2014-03-04 15:40:14 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-06 01:00:49 +0100
commit71ec1e0e059589940ca3791bd5bef75360014703 (patch)
tree7d475eab090dbe8b179b5f2ace9eb59e35d637f6 /src/quick/items/qquickgridview.cpp
parent6f15b9102afb8694679f4c7648d0effdac4dd051 (diff)
Fix GridView flow enum docs
Task-number: QTBUG-37232 Change-Id: Ib975181e6cff9a86f642d822dfc92773528598cb Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
Diffstat (limited to 'src/quick/items/qquickgridview.cpp')
-rw-r--r--src/quick/items/qquickgridview.cpp26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/quick/items/qquickgridview.cpp b/src/quick/items/qquickgridview.cpp
index f97229a76a..e7b1437cf3 100644
--- a/src/quick/items/qquickgridview.cpp
+++ b/src/quick/items/qquickgridview.cpp
@@ -1202,7 +1202,7 @@ bool QQuickGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte
\list
\li \l flow - controls whether items flow from left to right (as a series of rows)
or from top to bottom (as a series of columns). This value can be either
- GridView.LeftToRight or GridView.TopToBottom.
+ GridView.FlowLeftToRight or GridView.FlowTopToBottom.
\li \l layoutDirection - controls the horizontal layout direction: that is, whether items
are laid out from the left side of the view to the right, or vice-versa. This value can
be either Qt.LeftToRight or Qt.RightToLeft.
@@ -1215,16 +1215,16 @@ bool QQuickGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte
horizontally, and from top to bottom vertically.
These properties can be combined to produce a variety of layouts, as shown in the table below.
- The GridViews in the first row all have a \l flow value of GridView.LeftToRight, but use
+ The GridViews in the first row all have a \l flow value of GridView.FlowLeftToRight, but use
different combinations of horizontal and vertical layout directions (specified by \l layoutDirection
and \l verticalLayoutDirection respectively). Similarly, the GridViews in the second row below
- all have a \l flow value of GridView.TopToBottom, but use different combinations of horizontal and
+ all have a \l flow value of GridView.FlowTopToBottom, but use different combinations of horizontal and
vertical layout directions to lay out their items in different ways.
\table
\header
\li {4, 1}
- \b GridViews with GridView.LeftToRight flow
+ \b GridViews with GridView.FlowLeftToRight flow
\row
\li \b (H) Left to right \b (V) Top to bottom
\image gridview-layout-lefttoright-ltr-ttb.png
@@ -1236,7 +1236,7 @@ bool QQuickGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte
\image gridview-layout-lefttoright-rtl-btt.png
\header
\li {4, 1}
- \b GridViews with GridView.TopToBottom flow
+ \b GridViews with GridView.FlowTopToBottom flow
\row
\li \b (H) Left to right \b (V) Top to bottom
\image gridview-layout-toptobottom-ltr-ttb.png
@@ -1467,8 +1467,8 @@ void QQuickGridView::setHighlightFollowsCurrentItem(bool autoHighlight)
on the \l GridView::flow property.
\endlist
- \b Note: If GridView::flow is set to GridView.LeftToRight, this is not to be confused if
- GridView::layoutDirection is set to Qt.RightToLeft. The GridView.LeftToRight flow value simply
+ \b Note: If GridView::flow is set to GridView.FlowLeftToRight, this is not to be confused if
+ GridView::layoutDirection is set to Qt.RightToLeft. The GridView.FlowLeftToRight flow value simply
indicates that the flow is horizontal.
\sa GridView::effectiveLayoutDirection, GridView::verticalLayoutDirection
@@ -1583,8 +1583,8 @@ void QQuickGridView::setHighlightMoveDuration(int duration)
Possible values:
\list
- \li GridView.LeftToRight (default) - Items are laid out from left to right, and the view scrolls vertically
- \li GridView.TopToBottom - Items are laid out from top to bottom, and the view scrolls horizontally
+ \li GridView.FlowLeftToRight (default) - Items are laid out from left to right, and the view scrolls vertically
+ \li GridView.FlowTopToBottom - Items are laid out from top to bottom, and the view scrolls horizontally
\endlist
*/
QQuickGridView::Flow QQuickGridView::flow() const
@@ -1662,9 +1662,9 @@ void QQuickGridView::setCellHeight(qreal cellHeight)
\list
\li GridView.NoSnap (default) - the view stops anywhere within the visible area.
- \li GridView.SnapToRow - the view settles with a row (or column for \c GridView.TopToBottom flow)
+ \li GridView.SnapToRow - the view settles with a row (or column for \c GridView.FlowTopToBottom flow)
aligned with the start of the view.
- \li GridView.SnapOneRow - the view will settle no more than one row (or column for \c GridView.TopToBottom flow)
+ \li GridView.SnapOneRow - the view will settle no more than one row (or column for \c GridView.FlowTopToBottom flow)
away from the first visible row at the time the mouse button is released.
This mode is particularly useful for moving one page at a time.
\endlist
@@ -2512,13 +2512,13 @@ bool QQuickGridViewPrivate::needsRefillForAddedOrRemovedIndex(int modelIndex) co
\a mode:
\list
- \li GridView.Beginning - position item at the top (or left for \c GridView.TopToBottom flow) of the view.
+ \li GridView.Beginning - position item at the top (or left for \c GridView.FlowTopToBottom flow) of the view.
\li GridView.Center - position item in the center of the view.
\li GridView.End - position item at bottom (or right for horizontal orientation) of the view.
\li GridView.Visible - if any part of the item is visible then take no action, otherwise
bring the item into view.
\li GridView.Contain - ensure the entire item is visible. If the item is larger than
- the view the item is positioned at the top (or left for \c GridView.TopToBottom flow) of the view.
+ the view the item is positioned at the top (or left for \c GridView.FlowTopToBottom flow) of the view.
\li GridView.SnapPosition - position the item at \l preferredHighlightBegin. This mode
is only valid if \l highlightRangeMode is StrictlyEnforceRange or snapping is enabled
via \l snapMode.