Clarified wxPropertyGrid::HitTest() docs

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

diff --git a/include/wx/propgrid/propgrid.h b/include/wx/propgrid/propgrid.h
index 5a2c37493e95c79e168e95cda23624270da8fa91..cbda18e38991109f3f81dec1a9f4f3c26443cc52 100644 (file)
--- a/include/wx/propgrid/propgrid.h
+++ b/include/wx/propgrid/propgrid.h
@@ -885,10 +885,13 @@ public:
     bool IsEditorsValueModified() const
         { return  ( m_iFlags & wxPG_FL_VALUE_MODIFIED ) ? true : false; }
 
-    /** Returns information about arbitrary position in the grid.
+    /**
+        Returns information about arbitrary position in the grid.
 
-        For wxPropertyGridHitTestResult definition, see
-        wxPropertyGridPageState::HitTest().
+        @param pt
+            Logical coordinates in the virtual grid space. Use
+            wxScrolledWindow::CalcUnscrolledPosition() if you need to
+            translate a scrolled position into a logical one.
     */
     wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;
 

diff --git a/include/wx/propgrid/propgridpagestate.h b/include/wx/propgrid/propgridpagestate.h
index 9f3764a71e2c123dbb9656a1dfffa901cfaab552..5e58483f1f3ea3e513c8663c8258c003374dec28 100644 (file)
--- a/include/wx/propgrid/propgridpagestate.h
+++ b/include/wx/propgrid/propgridpagestate.h
@@ -542,24 +542,13 @@ public:
                           unsigned int col,
                           bool subProps) const;
 
-    /** Returns information about arbitrary position in the grid.
-
-        wxPropertyGridHitTestResult definition:
-        @code
-            struct wxPropertyGridHitTestResult
-            {
-                wxPGProperty* GetProperty() const;
-
-                // column. -1 for margin
-                int             column;
-
-                // Index of splitter hit, -1 for none.
-                int             splitter;
+    /**
+        Returns information about arbitrary position in the grid.
 
-                // If splitter hit, then offset to that.
-                int             splitterHitOffset;
-            };
-        @endcode
+        @param pt
+            Logical coordinates in the virtual grid space. Use
+            wxScrolledWindow::CalcUnscrolledPosition() if you need to
+            translate a scrolled position into a logical one.
     */
     wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;
 

diff --git a/interface/wx/propgrid/propgrid.h b/interface/wx/propgrid/propgrid.h
index 16c785c43d6780767deacf6a21e6876dccc04891..a2bd673462aee63e5a3523da71f1bf62bd9429db 100644 (file)
--- a/interface/wx/propgrid/propgrid.h
+++ b/interface/wx/propgrid/propgrid.h
@@ -672,6 +672,11 @@ public:
 
     /**
         Returns information about arbitrary position in the grid.
+
+        @param pt
+            Logical coordinates in the virtual grid space. Use
+            wxScrolledWindow::CalcUnscrolledPosition() if you need to
+            translate a scrolled position into a logical one.
     */
     wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;