X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e3d1fc26b245a15757488c0769b960e74c67ecca..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/list.h diff --git a/interface/wx/list.h b/interface/wx/list.h index eae8cd2cf2..ac88a671c4 100644 --- a/interface/wx/list.h +++ b/interface/wx/list.h @@ -2,36 +2,34 @@ // Name: list.h // Purpose: interface of wxList // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** - @class wxList - The wxList class provides linked list functionality. 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 + wxList destroys an object after removing it only if wxList::DeleteContents has been called. wxList is not a real template and it requires that you declare and define - each wxListT class in your program. This is done with @e WX_DECLARE_LIST + each wxList class in your program. This is done with @e WX_DECLARE_LIST and @e WX_DEFINE_LIST macros (see example). We hope that we'll be able to - provide a proper template class providing both the STL std::list and the old + provide a proper template class providing both the STL @c std::list and the old wxList API in the future. - Please refer to the STL std::list documentation for further information on how - to use the class. Below we documented both the supported STL and the legacy API + Please refer to the STL @c std::list documentation (see http://www.cppreference.com/wiki/stl/list/start) + for further information on how to use the class. + Below we documented both the supported STL and the legacy API that originated from the old wxList class and which can still be used alternatively - for the the same class. + for the same class. - Note that if you compile wxWidgets in STL mode (wxUSE_STL defined as 1) - then wxList will actually derive from std::list and just add a legacy + Note that if you compile wxWidgets in STL mode (@c wxUSE_STL defined as 1) + then wxList will actually derive from @c std::list and just add a legacy compatibility layer for the old wxList class. @code @@ -86,11 +84,15 @@ The use of the latter is especially discouraged as it is not only unsafe but is also much less efficient than wxArrayString class. + @tparam T + The type stored in the wxList nodes. + @library{wxbase} - @category{data} + @category{containers} - @see wxArray, wxVector + @see wxArray, wxVector, wxNode */ +template class wxList { public: @@ -129,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. @@ -145,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; @@ -189,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); @@ -200,15 +202,17 @@ 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; /** - @deprecated This function is deprecated, use Find() instead. + Check if the object is present in the list. + + @see Find() */ - wxList::compatibility_iterator Member(T* object) const; + bool Member(T* object) const; /** @deprecated This function is deprecated, use Item() instead. @@ -386,17 +390,22 @@ 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; }; /** - @class wxNode - - wxNodeBase is the node structure used in linked lists (see wxList) and derived - classes. You should never use wxNodeBase class directly, however, because it + wxNode is the node structure used in linked lists (see wxList) and derived + classes. You should never use wxNode class directly, however, because it works with untyped (@c void *) data and this is unsafe. - Use wxNodeBase-derived classes which are automatically defined by WX_DECLARE_LIST + Use wxNode-derived classes which are automatically defined by WX_DECLARE_LIST and WX_DEFINE_LIST macros instead as described in wxList documentation (see example there). @@ -409,11 +418,15 @@ public: written as wxNodeT even though it isn't really a template class -- but it helps to think of it as if it were. + @tparam T + The type stored in the wxNode. + @library{wxbase} @category{data} @see wxList, wxHashTable */ +template class wxNode { public: