emphasize the fact that GetSelectedCols/Rows() is not sufficient to get the selection...

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54665 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/grid.h b/interface/wx/grid.h
index 65aa667f157ea53d35689964b5efe4ba0a3e7a3a..47a223594c2ca876adc3390d385a54c7203cbc69 100644 (file)
--- a/interface/wx/grid.h
+++ b/interface/wx/grid.h
@@ -1851,11 +1851,24 @@ public:
 
     /**
         Returns an array of selected cols.
 
     /**
         Returns an array of selected cols.

+
+        Please notice that this method alone is not sufficient to find all the
+        selected columns, see the explanation in GetSelectedRows()
+        documentation for more details.

     */
     wxArrayInt GetSelectedCols() const;
 
     /**
         Returns an array of selected rows.
     */
     wxArrayInt GetSelectedCols() const;
 
     /**
         Returns an array of selected rows.

+
+        Note that this array contains only the rows which were individually
+        selected (using the mouse with the row header or combinations involving
+        @c Ctrl key for selecting individual rows). In particular if the user
+        selects many rows at once (e.g. by pressing @c Shift key) this array is
+        @b not updated because this could mean storing a very large number of
+        elements in it. So in general to find the current selection you need to
+        use both this method and GetSelectionBlockTopLeft() and
+        GetSelectionBlockBottomRight() ones.

     */
     wxArrayInt GetSelectedRows() const;
 
     */
     wxArrayInt GetSelectedRows() const;