diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 18:05:16 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-13 16:34:49 +0100 |
commit | c291efff26c13963cf98c127bfa759f89f103e48 (patch) | |
tree | 1ff72838794983592258f9718718db283834f42c /src/quick/items/qquicklistview.cpp | |
parent | ada9dd41c83aad3890b8f01a98fdbeae04528eba (diff) |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: I62d203f21df63a95ee236e578b10418fd9680707
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'src/quick/items/qquicklistview.cpp')
-rw-r--r-- | src/quick/items/qquicklistview.cpp | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/src/quick/items/qquicklistview.cpp b/src/quick/items/qquicklistview.cpp index 9db2060d89..2590d4691f 100644 --- a/src/quick/items/qquicklistview.cpp +++ b/src/quick/items/qquicklistview.cpp @@ -1848,13 +1848,13 @@ QQuickListView::~QQuickListView() Valid values for \c highlightRangeMode are: \list - \o ListView.ApplyRange - the view attempts to maintain the highlight within the range. + \li ListView.ApplyRange - the view attempts to maintain the highlight within the range. However, the highlight can move outside of the range at the ends of the list or due to mouse interaction. - \o ListView.StrictlyEnforceRange - the highlight never moves outside of the range. + \li ListView.StrictlyEnforceRange - the highlight never moves outside of the range. The current item changes if a keyboard or mouse action would cause the highlight to move outside of the range. - \o ListView.NoHighlightRange - this is the default value. + \li ListView.NoHighlightRange - this is the default value. \endlist */ void QQuickListView::setHighlightFollowsCurrentItem(bool autoHighlight) @@ -1902,17 +1902,17 @@ void QQuickListView::setSpacing(qreal spacing) Possible values: \list - \o ListView.Horizontal - Items are laid out horizontally - \o ListView.Vertical (default) - Items are laid out vertically + \li ListView.Horizontal - Items are laid out horizontally + \li ListView.Vertical (default) - Items are laid out vertically \endlist \table \row - \o Horizontal orientation: + \li Horizontal orientation: \image ListViewHorizontal.png \row - \o Vertical orientation: + \li Vertical orientation: \image listview-highlight.png \endtable */ @@ -1948,8 +1948,8 @@ void QQuickListView::setOrientation(QQuickListView::Orientation orientation) Possible values: \list - \o Qt.LeftToRight (default) - Items will be laid out from left to right. - \o Qt.RightToLeft - Items will be laid out from right to let. + \li Qt.LeftToRight (default) - Items will be laid out from left to right. + \li Qt.RightToLeft - Items will be laid out from right to let. \endlist \sa ListView::effectiveLayoutDirection @@ -2020,9 +2020,9 @@ void QQuickListView::setOrientation(QQuickListView::Orientation orientation) \c section.property. This value can be one of: \list - \o ViewSection.FullString (default) - sections are created based on the + \li ViewSection.FullString (default) - sections are created based on the \c section.property value. - \o ViewSection.FirstCharacter - sections are created based on the first + \li ViewSection.FirstCharacter - sections are created based on the first character of the \c section.property value (for example, 'A', 'B', 'C' sections, etc. for an address book) \endlist @@ -2034,11 +2034,11 @@ void QQuickListView::setOrientation(QQuickListView::Orientation orientation) the labels are shown inline. This value can be a combination of: \list - \o ViewSection.InlineLabels - section labels are shown inline between + \li ViewSection.InlineLabels - section labels are shown inline between the item delegates separating sections (default). - \o ViewSection.CurrentLabelAtStart - the current section label sticks to the + \li ViewSection.CurrentLabelAtStart - the current section label sticks to the start of the view as it is moved. - \o ViewSection.NextLabelAtEnd - the next section label (beyond all visible + \li ViewSection.NextLabelAtEnd - the next section label (beyond all visible sections) sticks to the end of the view as it is moved. \note Enabling \c ViewSection.NextLabelAtEnd requires the view to scan ahead for the next section, which has performance implications, especially for slower models. @@ -2174,10 +2174,10 @@ void QQuickListView::setHighlightResizeDuration(int duration) The possible values are: \list - \o ListView.NoSnap (default) - the view stops anywhere within the visible area. - \o ListView.SnapToItem - the view settles with an item aligned with the start of + \li ListView.NoSnap (default) - the view stops anywhere within the visible area. + \li ListView.SnapToItem - the view settles with an item aligned with the start of the view. - \o ListView.SnapOneItem - the view settles no more than one item away from the first + \li ListView.SnapOneItem - the view settles no more than one item away from the first visible item at the time the mouse button is released. This mode is particularly useful for moving one page at a time. \endlist @@ -2254,9 +2254,9 @@ void QQuickListView::setSnapMode(SnapMode mode) It is applied to all items that are created when: \list - \o The view is first created - \o The view's \l model changes - \o The view's \l model is \l {QAbstractItemModel::reset}{reset}, if the model is a QAbstractItemModel subclass + \li The view is first created + \li The view's \l model changes + \li The view's \l model is \l {QAbstractItemModel::reset}{reset}, if the model is a QAbstractItemModel subclass \endlist For example, here is a view that specifies such a transition: @@ -2670,7 +2670,7 @@ void QQuickListView::geometryChanged(const QRectF &newGeometry, const QRectF &ol if keyNavigationWraps is true and it is currently at the end. This method has no effect if the \l count is zero. - \bold Note: methods should only be called after the Component has completed. + \b Note: methods should only be called after the Component has completed. */ void QQuickListView::incrementCurrentIndex() { @@ -2690,7 +2690,7 @@ void QQuickListView::incrementCurrentIndex() if keyNavigationWraps is true and it is currently at the beginning. This method has no effect if the \l count is zero. - \bold Note: methods should only be called after the Component has completed. + \b Note: methods should only be called after the Component has completed. */ void QQuickListView::decrementCurrentIndex() { @@ -2879,12 +2879,12 @@ void QQuickListViewPrivate::translateAndTransitionItemsAfter(int afterModelIndex \a mode: \list - \o ListView.Beginning - position item at the top (or left for horizontal orientation) of the view. - \o ListView.Center - position item in the center of the view. - \o ListView.End - position item at bottom (or right for horizontal orientation) of the view. - \o ListView.Visible - if any part of the item is visible then take no action, otherwise + \li ListView.Beginning - position item at the top (or left for horizontal orientation) of the view. + \li ListView.Center - position item in the center of the view. + \li ListView.End - position item at bottom (or right for horizontal orientation) of the view. + \li ListView.Visible - if any part of the item is visible then take no action, otherwise bring the item into view. - \o ListView.Contain - ensure the entire item is visible. If the item is larger than + \li ListView.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 horizontal orientation) of the view. \endlist @@ -2897,7 +2897,7 @@ void QQuickListViewPrivate::translateAndTransitionItemsAfter(int afterModelIndex the actual start of the view can vary based on the size of the delegates. The correct way to bring an item into view is with \c positionViewAtIndex. - \bold Note: methods should only be called after the Component has completed. To position + \b Note: methods should only be called after the Component has completed. To position the view at startup, this method should be called by Component.onCompleted. For example, to position the view at the end: @@ -2917,7 +2917,7 @@ void QQuickListViewPrivate::translateAndTransitionItemsAfter(int afterModelIndex of the list does not cause all other items to be repositioned, and because the actual start of the view can vary based on the size of the delegates. - \bold Note: methods should only be called after the Component has completed. To position + \b Note: methods should only be called after the Component has completed. To position the view at startup, this method should be called by Component.onCompleted. For example, to position the view at the end on startup: @@ -2936,7 +2936,7 @@ void QQuickListViewPrivate::translateAndTransitionItemsAfter(int afterModelIndex If the item is outside the visible area, -1 is returned, regardless of whether an item will exist at that point when scrolled into view. - \bold Note: methods should only be called after the Component has completed. + \b Note: methods should only be called after the Component has completed. */ /*! @@ -2949,7 +2949,7 @@ void QQuickListViewPrivate::translateAndTransitionItemsAfter(int afterModelIndex If the item is outside the visible area, null is returned, regardless of whether an item will exist at that point when scrolled into view. - \bold Note: methods should only be called after the Component has completed. + \b Note: methods should only be called after the Component has completed. */ QQuickListViewAttached *QQuickListView::qmlAttachedProperties(QObject *obj) |