Doc: Documented the standard keys in item views.

Task-number: 212278
Reviewed-by: David Boddie

1 files changed, 39 insertions, 1 deletions

diff --git a/src/gui/itemviews/qabstractitemview.cpp b/src/gui/itemviews/qabstractitemview.cpp
index c9b2c0c181..9d977a5f7c 100644
--- a/src/gui/itemviews/qabstractitemview.cpp
+++ b/src/gui/itemviews/qabstractitemview.cpp
@@ -176,7 +176,45 @@ void QAbstractItemViewPrivate::checkMouseMove(const QPersistentModelIndex &index
     slots mechanism, enabling subclasses to be kept up-to-date with
     changes to their models.  This class provides standard support for
     keyboard and mouse navigation, viewport scrolling, item editing,
-    and selections.
+    and selections. The keyboard navigation implements this
+    functionality:
+
+    \table
+        \header
+            \o Keys
+            \o Functionality
+        \row
+            \o Arrow keys
+            \o Changes the current item and selects it.
+        \row
+            \o Ctrl+Arrow keys
+            \o Changes the current item but does not select it.
+        \row
+            \o Shift+Arrow keys
+            \o Changes the current item and selects it. The previously
+               selected item(s) is not deselected.
+        \row
+            \o Ctr+Space
+            \o Toggles selection of the current item.
+        \row
+            \o Tab/Backtab
+            \o Changes the current item to the next/previous item.
+        \row
+            \o Home/End
+            \o Selects the first/last item in the model.
+        \row
+            \o Page up/Page down
+            \o Scrolls the rows shown up/down by the number of
+               visible rows in the view.
+        \row
+            \o Ctrl+A
+            \o Selects all items in the model.
+    \endtable
+
+    Note that the above table assumes that the
+    \l{selectionMode}{selection mode} allows the operations. For
+    instance, you cannot select items if the selection mode is
+    QAbstractItemView::NoSelection.
 
     The QAbstractItemView class is one of the \l{Model/View Classes}
     and is part of Qt's \l{Model/View Programming}{model/view framework}.