-// DrawHintRect() draws a drop hint rectangle. First calls DoDrop() to
-// determine the exact position the pane would be at were if dropped. If
-// the pame would indeed become docked at the specified drop point,
-// DrawHintRect() then calls ShowHint() to indicate this drop rectangle.
-// "pane_window" is the window pointer of the pane being dragged, pt is
-// the mouse position, in client coordinates
-void wxAuiManager::DrawHintRect(wxWindow* pane_window,
- const wxPoint& pt,
- const wxPoint& offset)
+
+// CalculateHintRect() calculates the drop hint rectangle. The method
+// first calls DoDrop() to determine the exact position the pane would
+// be at were if dropped. If the pane would indeed become docked at the
+// specified drop point, the the rectangle hint will be returned in
+// screen coordinates. Otherwise, an empty rectangle is returned.
+// |pane_window| is the window pointer of the pane being dragged, |pt| is
+// the mouse position, in client coordinates. |offset| describes the offset
+// that the mouse is from the upper-left corner of the item being dragged
+
+wxRect wxAuiManager::CalculateHintRect(wxWindow* pane_window,
+ const wxPoint& pt,
+ const wxPoint& offset)