CEGUI::ConstMapIterator< T > Class Template Reference

iterator class for maps More...

#include <IteratorBase.h>

Inheritance diagram for CEGUI::ConstMapIterator< T >:

Collaboration diagram for CEGUI::ConstMapIterator< T >:

Public Member Functions
	ConstMapIterator (typename T::const_iterator start_iter, typename T::const_iterator end_iter)
ConstBaseIterator< T, typenameT::mapped_type >::value_type	getCurrentValue () const
	Return the value for the item at the current iterator position.
T::key_type	getCurrentKey () const
	Return the key for the item at the current iterator position.
ConstMapIterator< T > &	operator++ ()
	Increase the iterator position (prefix increment).
ConstMapIterator< T > &	operator-- ()
	Decrease the iterator position (prefix decrement).
ConstMapIterator< T >	operator++ (int)
	Increase the iterator position (postfix increment).
ConstMapIterator< T >	operator-- (int)
	Decrease the iterator position (postfix decrement).
Public Member Functions inherited from CEGUI::ConstBaseIterator< T, T::mapped_type >
	ConstBaseIterator (typename T::const_iterator start_iter, typename T::const_iterator end_iter)
	ConstBaseIterator constructor.
	ConstBaseIterator (const ConstBaseIterator< T, T::mapped_type > &org)
	ConstBaseIterator copy constructor.
virtual	~ConstBaseIterator (void)
	ConstBaseIterator destructor.
ConstBaseIterator< T, T::mapped_type > &	operator= (const ConstBaseIterator< T, T::mapped_type > &rhs)
	ConstBaseIterator assignment operator.
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, T::mapped_type > &rhs) const
	Compares two iterators. Return true if the current position of both iterators are equivalent.
bool	operator!= (const ConstBaseIterator< T, T::mapped_type > &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.

Additional Inherited Members
Public Types inherited from CEGUI::ConstBaseIterator< T, T::mapped_type >
typedef T::mapped_type	value_type
Protected Attributes inherited from CEGUI::ConstBaseIterator< T, T::mapped_type >
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<class T>
class CEGUI::ConstMapIterator< T >

iterator class for maps

Member Function Documentation

getCurrentValue()

template<class T >

ConstBaseIterator< T, typenameT::mapped_type >::value_type CEGUI::ConstMapIterator< T >::getCurrentValue ( void  ) const

inlinevirtual

Return the value for the item at the current iterator position.

Implements CEGUI::ConstBaseIterator< T, T::mapped_type >.

References CEGUI::ConstBaseIterator< T, T::mapped_type >::d_currIter.

operator++() [1/2]

template<class T >

ConstMapIterator< T > & CEGUI::ConstMapIterator< T >::operator++ ( )

inline

Increase the iterator position (prefix increment).

Note

The iterator is checked, and this call will always succeed, so do not rely on some exception to exit a loop.

operator++() [2/2]

template<class T >

ConstMapIterator< T > CEGUI::ConstMapIterator< T >::operator++ ( int  )

inline

Increase the iterator position (postfix increment).

Note

The iterator is checked, and this call will always succeed, so do not rely on some exception to exit a loop.

operator--() [1/2]

template<class T >

ConstMapIterator< T > & CEGUI::ConstMapIterator< T >::operator-- ( )

inline

Decrease the iterator position (prefix decrement).

Note

The iterator is checked, and this call will always succeed, so do not rely on some exception to exit a loop.

operator--() [2/2]

template<class T >

ConstMapIterator< T > CEGUI::ConstMapIterator< T >::operator-- ( int  )

inline

Decrease the iterator position (postfix decrement).

Note

The iterator is checked, and this call will always succeed, so do not rely on some exception to exit a loop.