From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 15 Feb 2012 00:35:55 +0000 (+0000)
Subject: Clean up wxListBox documentation.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/659334e17f17fda066ba322178f72bb474c3010c

Clean up wxListBox documentation.

Remove the methods inherited from the base class, there is no need to
re-document them here, especially as this was done incorrectly for Set().

Do document EnsureVisible() and IsSorted().

Closes #13979.

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

diff --git a/interface/wx/listbox.h b/interface/wx/listbox.h
index 68fe933e88..e9e3524b7a 100644
--- a/interface/wx/listbox.h
+++ b/interface/wx/listbox.h
@@ -259,30 +259,6 @@ public:
     */
     virtual bool IsSelected(int n) const;
 
-    /**
-        Clears the list box and adds the given strings to it.
-
-        @param n
-            The number of strings to set.
-        @param choices
-            An array of strings to set.
-        @param clientData
-            Options array of client data pointers
-    */
-    void Set(unsigned int n, const wxString* choices, void *clientData);
-
-    /**
-        Clears the list box and adds the given strings to it.
-        You may free the array from the calling program after this method
-        has been called.
-
-        @param choices
-            An array of strings to set.
-        @param clientData
-            Options array of client data pointers
-    */
-    void Set(const wxArrayString& choices, void *clientData);
-
     /**
         Set the specified item to be the first visible item.
 
@@ -298,17 +274,24 @@ public:
             The string that should be visible.
     */
     void SetFirstItem(const wxString& string);
-    
+
+    /**
+        Ensure that the item with the given index is currently shown.
+
+        Scroll the listbox if necessary.
+
+        This method is currently only implemented in wxGTK and wxOSX and does
+        nothing in other ports.
+
+        @see SetFirstItem()
+     */
     virtual void EnsureVisible(int n);
-    
+
+    /**
+        Return true if the listbox has ::wxLB_SORT style.
+
+        This method is mostly meant for internal use only.
+     */
     virtual bool IsSorted() const;
-    
-    // implement base class pure virtuals
-    virtual void Refresh(bool eraseBack = true, const wxRect *rect = NULL);
-    
-    virtual unsigned int GetCount() const;
-    virtual wxString GetString(unsigned int n) const;
-    virtual void SetString(unsigned int n, const wxString& s);
-    virtual int FindString(const wxString& s, bool bCase = false) const;
 };