AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clean up wxListBox documentation.

Browse Source 
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
This commit is contained in:
Vadim Zeitlin 2012-02-15 00:35:55 +00:00
parent cda337fbb0
commit 659334e17f
1 changed files with 17 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
interface/wx/listbox.h
View File

@ -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;
};