X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7afd2b58c565ec9d9148c54745bb94613dbea4bf..c6ea1fdaf924be4ee49a19d12f76e4fcd257bb0a:/include/wx/richtext/richtextbuffer.h

diff --git a/include/wx/richtext/richtextbuffer.h b/include/wx/richtext/richtextbuffer.h
index ba5b53a7db..8d73233313 100644
--- a/include/wx/richtext/richtextbuffer.h
+++ b/include/wx/richtext/richtextbuffer.h
@@ -2001,6 +2001,10 @@ public:
         The function puts the position in @a textPosition if one is found.
         @a pt is in logical units (a zero y position is at the beginning of the buffer).
 
+        Pass wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS if you only want to consider objects
+        directly under the object you are calling HitTest on. Otherwise, it will recurse
+        and potentially find a nested object.
+
         @return One of the ::wxRichTextHitTestFlags values.
     */