QHeaderView::setOffsetToSectionPosition documentation update

The documentation has used the word visualIndex for the argument
to this function. That is however very misleading since this
visualIndex is not the same as 'visualIndex' as we have in

visualIndex(int logicalIndex)
logicalIndex(int visualIndex)
or visualIndexAt(int position)

Beside the above a variable name has also been changed from
visualIndex to actualVisualIndex.

Change-Id: I43808adfd7c287a349474ab1e2656c417c8cf3e9
Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>

diff --git a/src/widgets/itemviews/qheaderview.cpp b/src/widgets/itemviews/qheaderview.cpp
index af83fb9..e753f72 100644 (file)
--- a/src/widgets/itemviews/qheaderview.cpp
+++ b/src/widgets/itemviews/qheaderview.cpp
@@ -481,15 +481,17 @@ void QHeaderView::setOffset(int newOffset)
 
 /*!
     \since 4.2
-    Sets the offset to the start of the section at the given \a visualIndex.
+    Sets the offset to the start of the section at the given \a visualSectionNumber.
+    \a visualSectionNumber is the actual visible section when hiddenSections are
+    not considered. That is not always the same as \a visualIndex.
 
     \sa setOffset(), sectionPosition()
 */
-void QHeaderView::setOffsetToSectionPosition(int visualIndex)
+void QHeaderView::setOffsetToSectionPosition(int visualSectionNumber)
 {
     Q_D(QHeaderView);
-    if (visualIndex > -1 && visualIndex < d->sectionCount) {
-        int position = d->headerSectionPosition(d->adjustedVisualIndex(visualIndex));
+    if (visualSectionNumber > -1 && visualSectionNumber < d->sectionCount) {
+        int position = d->headerSectionPosition(d->adjustedVisualIndex(visualSectionNumber));
         setOffset(position);
     }
 }