Fix wxDataViewCtrl::GetItemRect() signature in wxOSX and document it better.

The second parameter of this method should be optional, so make it so in wxOSX.

Also document what this method does exactly and the platforms under which it's
implemented.

Closes #13914.

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

diff --git a/include/wx/osx/dataview.h b/include/wx/osx/dataview.h
index 5962127d7b10c2f866bd8d47939c5bcd43ac08d3..b8463c4c991cf12a13bafb6bf2b135ffdf10bbf3 100644 (file)
--- a/include/wx/osx/dataview.h
+++ b/include/wx/osx/dataview.h
@@ -174,7 +174,8 @@ public:
   virtual bool IsExpanded(const wxDataViewItem & item) const;
 
   virtual unsigned int GetCount() const;
-  virtual wxRect GetItemRect(const wxDataViewItem& item, const wxDataViewColumn* columnPtr) const;
+  virtual wxRect GetItemRect(const wxDataViewItem& item,
+                             const wxDataViewColumn* columnPtr = NULL) const;
   virtual int GetSelectedItemsCount() const;
   virtual int GetSelections(wxDataViewItemArray& sel) const;
 

diff --git a/interface/wx/dataview.h b/interface/wx/dataview.h
index c193002f53c84dfeec53366bb16cb99f788fdb5e..bcd05e3cacb270eeddd00df918a7fe16e8079bab 100644 (file)
--- a/interface/wx/dataview.h
+++ b/interface/wx/dataview.h
@@ -1098,7 +1098,18 @@ public:
     int GetIndent() const;
 
     /**
-        Returns item rect.
+        Returns item rectangle.
+
+        This method is currently not implemented at all in wxGTK and only
+        implemented for non-@NULL @a col argument in wxOSX. It is fully
+        implemented in the generic version of the control.
+
+        @param item
+            A valid item.
+        @param col
+            If non-@NULL, the rectangle returned corresponds to the
+            intersection of the item with the specified column. If @NULL, the
+            rectangle spans all the columns.
     */
     virtual wxRect GetItemRect(const wxDataViewItem& item,
                                const wxDataViewColumn* col = NULL) const;