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

misc wxVector<T> docs fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52647 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík 2008-03-21 14:51:28 +00:00
parent 9fa8c9bf96
commit f016d3b424
1 changed files with 83 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
interface/vector.h
View File

@ -7,64 +7,81 @@
/////////////////////////////////////////////////////////////////////////////
/**
@class wxVectorT
@wxheader{vector.h}
wxVectorT is a template class which implements most of the std::vector
class and can be used like it. If wxWidgets is compiled in STL mode,
wxVector will just be a typedef to std::vector. Just like for std::vector,
objects stored in wxVectorT need to be @e assignable but don't have to
be @e default constructible.
wxVector<T> is a template class which implements most of the @c std::vector
class and can be used like it.
You can refer to the STL documentation for further information.
If wxWidgets is compiled in STL mode, wxVector will just be a typedef to @c
std::vector. Just like for @c std::vector, objects stored in wxVector<T>
need to be @e assignable but don't have to be @e default constructible.
Please refer to the STL documentation for further information.
@library{wxbase}
@category{FIXME}
@category{containers}
@see @ref overview_wxcontaineroverview, wxListT(), wxArrayT()
@see @ref overview_container, wxListT, wxArrayT
*/
template<typename T>
class wxVector<T>
{
public:
//@{
typedef size_t size_type;
typedef T value_type;
typedef value_type* iterator;
typedef const value_type* const_iterator;
typedef value_type& reference;
/**
Constructor.
*/
wxVectorT();
wxVectorT(const wxVector<T>& c);
//@}
wxVector();
/**
Copy onstructor.
*/
wxVector(const wxVector<T>& c);
/**
Destructor.
*/
~wxVectorT();
~wxVector();
//@{
/**
Returns item at position @e idx.
*/
const value_type at(size_type idx);
const value_type at(size_type idx);
//@}
const value_type& at(size_type idx) const;
//@{
/**
Return last item.
Returns item at position @e idx.
*/
const value_type back();
const value_type back();
//@}
value_type& at(size_type idx);
/**
Return the last item.
*/
const value_type& back() const;
/**
Return the last item.
*/
value_type& back();
//@{
/**
Return iterator to beginning of the vector.
*/
const_iterator begin();
const iterator begin();
//@}
const_iterator begin() const;
/**
Return iterator to beginning of the vector.
*/
iterator begin();
/**
Returns vector's current capacity, i.e. how much memory is allocated.
@see reserve()
*/
size_type capacity() const;
@ -78,52 +95,62 @@ public:
*/
bool empty() const;
//@{
/**
Returns iterator to the end of the vector.
*/
const_iterator end();
const iterator end();
//@}
const_iterator end() const;
//@{
/**
Erase items. When using values other than built-in integrals
or classes with reference counting this can be an inefficient
operation.
Returns iterator to the end of the vector.
*/
iterator end();
/**
Erase item pointed to by iterator @a it.
@return Iterator pointing to the item immediately after the erased one.
*/
iterator erase(iterator it);
/**
Erase items in the range @a first to @a last (@a last is not erased).
@return Iterator pointing to the item immediately after the
erased range.
*/
iterator erase(iterator first, iterator last);
//@}
//@{
/**
Returns first item.
*/
const value_type front();
const value_type front();
//@}
/**
)
Insert an item. When using values other than built-in integrals
or classes with reference counting this can be an inefficient
operation.
Returns the first item.
*/
iterator insert(iterator it);
const value_type& front() const;
/**
Returns the first item.
*/
value_type& front();
/**
Insert item @a v at given position @a it.
@return Iterator for the inserted item.
*/
iterator insert(iterator it, const value_type& v = value_type());
/**
Assignment operator.
*/
wxVectorT& operator operator=(const wxVector<T>& vb);
//@{
/**
Returns item at position @e idx.
*/
const value_type operator[](size_type idx);
const value_type operator[](size_type idx);
//@}
const value_type& operator[](size_type idx) const;
/**
Returns item at position @e idx.
*/
value_type& operator[](size_type idx);
/**
Removes the last item.
@ -136,9 +163,9 @@ public:
void push_back(const value_type& v);
/**
Reserves more memory of @a n is greater then
wxVector::size. Other this call has
no effect.
Reserves memory for at least @a n items.
@see capacity()
*/
void reserve(size_type n);
};