CEGUI::ConstBaseIterator< T, V > Class Template Reference

Base class constant iterator used to offer iteration over various collections within the system. More...

Public Types
typedef V	value_type
typedef V	value_type

Public Member Functions
	ConstBaseIterator (typename T::const_iterator start_iter, typename T::const_iterator end_iter)
	ConstBaseIterator constructor. More...
virtual	~ConstBaseIterator (void)
	ConstBaseIterator destructor.
	ConstBaseIterator (const ConstBaseIterator< T, V > &org)
	ConstBaseIterator copy constructor.
ConstBaseIterator< T, V > &	operator= (const ConstBaseIterator< T, V > &rhs)
	ConstBaseIterator assignment operator.
virtual value_type	getCurrentValue (void) const =0
	Return the value for the item at the current iterator position.
bool	isAtEnd (void) const
	Return whether the current iterator position is at the end of the iterators range.
bool	isAtStart (void) const
	Return whether the current iterator position is at the start of the iterators range.
bool	operator== (const ConstBaseIterator< T, V > &rhs) const
	Compares two iterators. Return true if the current position of both iterators are equivalent.
bool	operator!= (const ConstBaseIterator< T, V > &rhs) const
	Compares two iterators. Return true if the current position of the iterators are different.
value_type	operator* () const
	Return the value for the current iterator position.
void	toStart (void)
	Set the iterator current position to the start position.
void	toEnd (void)
	Set the iterator current position to the end position.
	ConstBaseIterator (typename T::const_iterator start_iter, typename T::const_iterator end_iter)
	ConstBaseIterator constructor. More...
virtual	~ConstBaseIterator (void)
	ConstBaseIterator destructor.
	ConstBaseIterator (const ConstBaseIterator< T, V > &org)
	ConstBaseIterator copy constructor.
ConstBaseIterator< T, V > &	operator= (const ConstBaseIterator< T, V > &rhs)
	ConstBaseIterator assignment operator.
virtual value_type	getCurrentValue (void) const =0
	Return the value for the item at the current iterator position.
bool	isAtEnd (void) const
	Return whether the current iterator position is at the end of the iterators range.
bool	isAtStart (void) const
	Return whether the current iterator position is at the start of the iterators range.
bool	operator== (const ConstBaseIterator< T, V > &rhs) const
	Compares two iterators. Return true if the current position of both iterators are equivalent.
bool	operator!= (const ConstBaseIterator< T, V > &rhs) const
	Compares two iterators. Return true if the current position of the iterators are different.
value_type	operator* () const
	Return the value for the current iterator position.
void	toStart (void)
	Set the iterator current position to the start position.
void	toEnd (void)
	Set the iterator current position to the end position.

Protected Attributes
T::const_iterator	d_currIter
	'real' iterator describing the current position within the collection.
T::const_iterator	d_startIter
	'real' iterator describing the start position within the collection (or what we were told was the start).
T::const_iterator	d_endIter
	'real' iterator describing the end position within the collection (or what we were told was the end).

Detailed Description

template<typename T, typename V = typename T::value_type>
class CEGUI::ConstBaseIterator< T, V >

Base class constant iterator used to offer iteration over various collections within the system.

Constructor & Destructor Documentation

template<typename T, typename V = typename T::value_type>

CEGUI::ConstBaseIterator< T, V >::ConstBaseIterator ( typename T::const_iterator  start_iter, typename T::const_iterator  end_iter  )

inline

ConstBaseIterator constructor.

Parameters

start_iter	'real' iterator that will be the start of the range to be iterated over by this iterator.
end_iter	'real' iterator that will be the end of the range to be iterated over by this iterator.

template<typename T, typename V = typename T::value_type>

CEGUI::ConstBaseIterator< T, V >::ConstBaseIterator ( typename T::const_iterator  start_iter, typename T::const_iterator  end_iter  )

inline

ConstBaseIterator constructor.

Parameters

start_iter	'real' iterator that will be the start of the range to be iterated over by this iterator.
end_iter	'real' iterator that will be the end of the range to be iterated over by this iterator.