X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/30a7cc7bfa2ced2bcf809c75616f3a24e2ee96f8..cbb40850016efc8c2a5fe8c976abf6d9abbab5e1:/interface/vlbox.h diff --git a/interface/vlbox.h b/interface/vlbox.h index 85ea204a98..d376222010 100644 --- a/interface/vlbox.h +++ b/interface/vlbox.h @@ -48,8 +48,7 @@ public: wxVListBox(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - size_t countItems = 0, long style = 0, - const wxString& name = wxVListBoxNameStr); + long style = 0, const wxString& name = wxVListBoxNameStr); /** Destructor. @@ -69,7 +68,7 @@ public: @c wxLB_MULTIPLE which indicates that the listbox should support multiple selection. - @returns @true on success or @false if the control couldn't be created. + @return @true on success or @false if the control couldn't be created. */ bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, @@ -80,7 +79,7 @@ public: Deselects all the items in the listbox. This method is only valid for multi selection listboxes. - @returns @true if any items were changed, i.e. if there had been any + @return @true if any items were changed, i.e. if there had been any selected items before, or @false if all the items were already deselected. @@ -191,6 +190,8 @@ public: consists in drawing the selected item with the standard background colour and drawing a border around the item if it is either selected or current. + + @todo Change this function signature to non-const. */ void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const; @@ -205,6 +206,8 @@ public: region is set to this rectangle before calling this function). @param n The index of the item to be drawn. + + @todo Change this function signature to non-const. */ virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const; @@ -221,6 +224,8 @@ public: The bounding rectangle for the item. @param n The index of the item. + + @todo Change this function signature to non-const. */ virtual void OnDrawSeparator(wxDC& dc, wxRect& rect, size_t n) const; @@ -234,7 +239,7 @@ public: Selects or deselects the specified item which must be valid (i.e. not equal to @c wxNOT_FOUND). - @returns @true if the items selection status has changed or @false + @return @true if the items selection status has changed or @false otherwise. This function is only valid for the multiple selection listboxes, use @@ -245,7 +250,7 @@ public: /** Selects all the items in the listbox. - @returns @true if any items were changed, i.e. if there had been any + @return @true if any items were changed, i.e. if there had been any unselected items before, or @false if all the items were already selected. @@ -259,7 +264,7 @@ public: Selects all items in the specified range which may be given in any order. - @returns @true if the items selection status has changed or @false + @return @true if the items selection status has changed or @false otherwise. This method is only valid for multi selection listboxes.