Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/textctrl.h b/interface/wx/textctrl.h
index 090e87f247bcb612259a8e47b288c479bdee2be5..cac926f5fedcb0a85442e2aca07fa33890af6579 100644 (file)
--- a/interface/wx/textctrl.h
+++ b/interface/wx/textctrl.h
@@ -1300,14 +1300,34 @@ public:
     */
     virtual bool GetStyle(long position, wxTextAttr& style);
 
-    //@{
     /**
-        This function finds the character at the specified position expressed
-        in pixels.
+        Finds the position of the character at the specified point.
+
+        If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
+        character closest to this position are returned, otherwise the output
+        parameters are not modified.
+
+        Please note that this function is currently only implemented in wxUniv,
+        wxMSW and wxGTK2 ports and always returns @c wxTE_HT_UNKNOWN in the
+        other ports.
+
+        @beginWxPerlOnly
+        In wxPerl this function takes only the @a pt argument and
+        returns a 3-element list (result, col, row).
+        @endWxPerlOnly
+
+        @param pt
+            The position of the point to check, in window device coordinates.
+        @param pos
+            Receives the position of the character at the given position. May
+            be @NULL.
 
-        The two overloads of this method allow to find either the position of
-        the character, as an index into the text control contents, or its row
-        and column.
+        @see PositionToXY(), XYToPosition()
+    */
+    wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
+
+    /**
+        Finds the row and column of the character at the specified point.
 
         If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
         character closest to this position are returned, otherwise the output
@@ -1330,17 +1350,12 @@ public:
         @param row
             Receives the row of the character at the given position. May be
             @NULL.
-        @param pos
-            Receives the position of the character at the given position. May
-            be @NULL.
 
         @see PositionToXY(), XYToPosition()
     */
-    wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
     wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
                                     wxTextCoord *col,
                                     wxTextCoord *row) const;
-    //@}
 
     /**
         Returns @true if the text has been modified by user.