avoid infinite recursion for richtooltops, (hopefully) fixes #15070

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

diff --git a/interface/wx/ctrlsub.h b/interface/wx/ctrlsub.h
index 33652cb4619f2d99695190a83c4e238d8661799d..3f0c41bcd3a2f2c1fa1c480aaf366a056cf12909 100644 (file)
--- a/interface/wx/ctrlsub.h
+++ b/interface/wx/ctrlsub.h
@@ -123,12 +123,17 @@ public:
     virtual int GetSelection() const = 0;
 
     /**
     virtual int GetSelection() const = 0;
 
     /**

-        Selects the item with the specified string in the control. This doesn't
-        cause any command events to be emitted.
+        Selects the item with the specified string in the control.
+
+        This method doesn't cause any command events to be emitted.
+
+        Notice that this method is case-insensitive, i.e. the string is
+        compared with all the elements of the control case-insensitively and
+        the first matching entry is selected, even if it doesn't have exactly
+        the same case as this string and there is an exact match afterwards.

 
         @param string
             The string to select.
 
         @param string
             The string to select.

-

         @return @true if the specified string has been selected, @false if it
                 wasn't found in the control.
     */
         @return @true if the specified string has been selected, @false if it
                 wasn't found in the control.
     */


@@ -511,6 +516,8 @@ public:
             Array of strings to insert.
         @param pos
             Position to insert the items before, zero based.
             Array of strings to insert.
         @param pos
             Position to insert the items before, zero based.

+        @return The return value is the index of the last inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(const wxArrayString& items, unsigned int pos);
 
     */
     int Insert(const wxArrayString& items, unsigned int pos);
 


@@ -527,6 +534,8 @@ public:
         @param clientData
             Array of client data pointers of the same size as @a items to
             associate with the new items.
         @param clientData
             Array of client data pointers of the same size as @a items to
             associate with the new items.

+        @return The return value is the index of the last inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(const wxArrayString& items, unsigned int pos,
                 void **clientData);
     */
     int Insert(const wxArrayString& items, unsigned int pos,
                 void **clientData);


@@ -544,6 +553,8 @@ public:
         @param clientData
             Array of client data pointers of the same size as @a items to
             associate with the new items.
         @param clientData
             Array of client data pointers of the same size as @a items to
             associate with the new items.

+        @return The return value is the index of the last inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(const wxArrayString& items, unsigned int pos,
                 wxClientData **clientData);
     */
     int Insert(const wxArrayString& items, unsigned int pos,
                 wxClientData **clientData);


@@ -560,6 +571,8 @@ public:
             Array of strings of size @a n.
         @param pos
             Position to insert the items before, zero based.
             Array of strings of size @a n.
         @param pos
             Position to insert the items before, zero based.

+        @return The return value is the index of the last inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(unsigned int n, const wxString* items,
                 unsigned int pos);
     */
     int Insert(unsigned int n, const wxString* items,
                 unsigned int pos);


@@ -579,6 +592,8 @@ public:
         @param clientData
             Array of client data pointers of size @a n to associate with the
             new items.
         @param clientData
             Array of client data pointers of size @a n to associate with the
             new items.

+        @return The return value is the index of the last inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(unsigned int n, const wxString* items,
                 unsigned int pos,
     */
     int Insert(unsigned int n, const wxString* items,
                 unsigned int pos,


@@ -599,6 +614,8 @@ public:
         @param clientData
             Array of client data pointers of size @a n to associate with the
             new items.
         @param clientData
             Array of client data pointers of size @a n to associate with the
             new items.

+        @return The return value is the index of the last inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(unsigned int n, const wxString* items,
                 unsigned int pos,
     */
     int Insert(unsigned int n, const wxString* items,
                 unsigned int pos,