Harmonize wxDataViewCtrl::GetSelection() behaviour in all ports.

[wxWidgets.git] / interface / wx / dataview.h

diff --git a/interface/wx/dataview.h b/interface/wx/dataview.h
index 9c24be7d765cc04f8e2536464466c7b9f302baa7..0c06dae862881751c1d3e7a4d41cf8c1277b34ff 100644 (file)
--- a/interface/wx/dataview.h
+++ b/interface/wx/dataview.h
@@ -1016,13 +1016,35 @@ public:
     */
     wxDataViewModel* GetModel();
 
     */
     wxDataViewModel* GetModel();
 

+    /**
+        Returns the number of currently selected items.
+
+        This method may be called for both the controls with single and
+        multiple selections and returns the number of selected item, possibly
+        0, in any case.
+
+        @since 2.9.3
+     */
+    virtual int GetSelectedItemsCount() const;
+

     /**
         Returns first selected item or an invalid item if none is selected.
     /**
         Returns first selected item or an invalid item if none is selected.

+
+        This method may be called for both the controls with single and
+        multiple selections but returns an invalid item if more than one item
+        is selected in the latter case, use HasSelection() to determine if
+        there are any selected items when using multiple selection.

     */
     virtual wxDataViewItem GetSelection() const;
 
     /**
         Fills @a sel with currently selected items and returns their number.
     */
     virtual wxDataViewItem GetSelection() const;
 
     /**
         Fills @a sel with currently selected items and returns their number.

+
+        This method may be called for both the controls with single and
+        multiple selections. In the single selection case it returns the array
+        with at most one element in it.
+
+        @see GetSelectedItemsCount()

     */
     virtual int GetSelections(wxDataViewItemArray& sel) const;
 
     */
     virtual int GetSelections(wxDataViewItemArray& sel) const;
 


@@ -1032,6 +1054,20 @@ public:
     */
     virtual wxDataViewColumn* GetSortingColumn() const;
 
     */
     virtual wxDataViewColumn* GetSortingColumn() const;
 

+    /**
+        Returns true if any items are currently selected.
+
+        This method may be called for both the controls with single and
+        multiple selections.
+
+        Calling this method is equivalent to calling GetSelectedItemsCount()
+        and comparing its result with 0 but is more clear and might also be
+        implemented more efficiently in the future.
+
+        @since 2.9.3
+     */
+    bool HasSelection() const;
+

     /**
         Hittest.
     */
     /**
         Hittest.
     */