Document limitations of the generic wxTextEntry hints.

Calling methods other than SetValue() or ChangeValue() doesn't update the
display correctly currently, see #12475.

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

diff --git a/interface/wx/textentry.h b/interface/wx/textentry.h
index a7110f592aa54895907dfaef79da875a8ad87ecd..74d7a88dc8cf99109cf832a50446026fe8a32c18 100644 (file)
--- a/interface/wx/textentry.h
+++ b/interface/wx/textentry.h
@@ -375,6 +375,16 @@ public:
         Notice that hints are known as <em>cue banners</em> under MSW or
         <em>placeholder strings</em> under OS X.
 
         Notice that hints are known as <em>cue banners</em> under MSW or
         <em>placeholder strings</em> under OS X.
 

+        @remarks For the platforms without native hints support (and currently
+            only the MSW port does have it and even there it is only used under
+            Windows Vista and later only), the implementation has several known
+            limitations. Notably, the hint display will not be properly updated
+            if you change wxTextEntry contents programmatically when the hint
+            is displayed using methods other than SetValue() or ChangeValue()
+            or others which use them internally (e.g. Clear()). In other words,
+            currently you should avoid calling methods such as WriteText() or
+            Replace() when using hints and the text control is empty.
+

         @since 2.9.0
      */
     virtual void SetHint(const wxString& hint);
         @since 2.9.0
      */
     virtual void SetHint(const wxString& hint);