X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4c51a665c649f7579fb39e62070cef4f66b3210d..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/list.h diff --git a/interface/wx/list.h b/interface/wx/list.h index ee97ee6aa8..ac88a671c4 100644 --- a/interface/wx/list.h +++ b/interface/wx/list.h @@ -2,7 +2,6 @@ // Name: list.h // Purpose: interface of wxList // Author: wxWidgets team -// RCS-ID: $Id$ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -12,7 +11,7 @@ This class has been rewritten to be type safe and to provide the full API of the STL std::list container and should be used like it. The exception is that wxList actually stores pointers and therefore its - iterators return pointers and not references to the actual objets in the list + iterators return pointers and not references to the actual objects in the list (see example below) and @e value_type is defined as @e T*. wxList destroys an object after removing it only if wxList::DeleteContents has been called. @@ -132,7 +131,7 @@ public: void DeleteContents(bool destroy); /** - Deletes the given element refered to by @a iter from the list + Deletes the given element referred to by @a iter from the list if @a iter is a valid iterator. Returns @true if successful. Deletes the actual object if DeleteContents( @true ) was called previously. @@ -148,14 +147,14 @@ public: bool DeleteObject(T* object); /** - Removes element refered to be @a iter. + Removes element referred to be @a iter. - Deletes the actualy object if DeleteContents( @true ) was called previously. + Deletes the actual object if DeleteContents( @true ) was called previously. */ void Erase(const compatibility_iterator& iter); /** - Returns the iterator refering to @a object or @NULL if none found. + Returns the iterator referring to @a object or @NULL if none found. */ wxList::compatibility_iterator Find(T* object) const; @@ -192,7 +191,7 @@ public: T* object); /** - Inserts @a object before the object refered to be @a iter. + Inserts @a object before the object referred to be @a iter. */ wxList::compatibility_iterator Insert(compatibility_iterator iter, T* object); @@ -203,7 +202,7 @@ public: bool IsEmpty() const; /** - Returns the iterator refering to the object at the given + Returns the iterator referring to the object at the given @a index in the list. */ wxList::compatibility_iterator Item(size_t index) const; @@ -391,6 +390,13 @@ public: Returns the size of the list. */ size_type size() const; + + /** + Returns a wxVector holding the list elements. + + @since 2.9.5 + */ + wxVector AsVector() const; };