CEGUI::ConstBaseIterator< T > Class Template Reference

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

#include <CEGUIIteratorBase.h>

List of all members.

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

---

Detailed Description

template<class T>
class CEGUI::ConstBaseIterator< T >

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

Definition at line 43 of file CEGUIIteratorBase.h.

---

Member Typedef Documentation

template<class T> typedef T::mapped_type CEGUI::ConstBaseIterator< T >::mapped_type

Definition at line 49 of file CEGUIIteratorBase.h.

---

Constructor & Destructor Documentation

template<class T> CEGUI::ConstBaseIterator< T >::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. Definition at line 62 of file CEGUIIteratorBase.h.

template<class T> CEGUI::ConstBaseIterator< T >::~ConstBaseIterator (  void   )  [inline]

ConstBaseIterator destructor. Definition at line 74 of file CEGUIIteratorBase.h.

template<class T> CEGUI::ConstBaseIterator< T >::ConstBaseIterator (  const ConstBaseIterator< T > &  org  )  [inline]

ConstBaseIterator copy constructor. Definition at line 83 of file CEGUIIteratorBase.h.

---

Member Function Documentation

template<class T> T::key_type CEGUI::ConstBaseIterator< T >::getCurrentKey (  void   )  const [inline]

Return the key for the item at the current iterator position. Definition at line 109 of file CEGUIIteratorBase.h. Referenced by CEGUI::Scheme::loadResources(), CEGUI::Scheme::resourcesLoaded(), and CEGUI::Scheme::unloadResources().

template<class T> mapped_type CEGUI::ConstBaseIterator< T >::getCurrentValue (  void   )  const [inline]

Return the value for the item at the current iterator position. Definition at line 119 of file CEGUIIteratorBase.h. Referenced by CEGUI::Scheme::loadResources(), and CEGUI::Scheme::resourcesLoaded().

template<class T> bool CEGUI::ConstBaseIterator< T >::isAtEnd (  void   )  const [inline]

Return whether the current iterator position is at the end of the iterators range. Definition at line 129 of file CEGUIIteratorBase.h. Referenced by CEGUI::Scheme::loadResources(), CEGUI::Scheme::resourcesLoaded(), and CEGUI::Scheme::unloadResources().

template<class T> bool CEGUI::ConstBaseIterator< T >::isAtStart (  void   )  const [inline]

Return whether the current iterator position is at the start of the iterators range. Definition at line 139 of file CEGUIIteratorBase.h.

template<class T> mapped_type CEGUI::ConstBaseIterator< T >::operator * (   )  const [inline]

Return the value for the current iterator position. Definition at line 233 of file CEGUIIteratorBase.h.

template<class T> bool CEGUI::ConstBaseIterator< T >::operator!= (  const ConstBaseIterator< T > &  rhs  )  const [inline]

Compares two iterators. Return true if the current position of the iterators are different. Definition at line 223 of file CEGUIIteratorBase.h.

template<class T> ConstBaseIterator<T> CEGUI::ConstBaseIterator< 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. Definition at line 168 of file CEGUIIteratorBase.h.

template<class T> ConstBaseIterator<T>& CEGUI::ConstBaseIterator< 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. Definition at line 152 of file CEGUIIteratorBase.h.

template<class T> ConstBaseIterator<T> CEGUI::ConstBaseIterator< 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. Definition at line 200 of file CEGUIIteratorBase.h.

template<class T> ConstBaseIterator<T>& CEGUI::ConstBaseIterator< 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. Definition at line 184 of file CEGUIIteratorBase.h.

template<class T> ConstBaseIterator<T>& CEGUI::ConstBaseIterator< T >::operator= (  const ConstBaseIterator< T > &  rhs  )  [inline]

ConstBaseIterator assignment operator. Definition at line 95 of file CEGUIIteratorBase.h. References CEGUI::ConstBaseIterator< T >::d_currIter, CEGUI::ConstBaseIterator< T >::d_endIter, and CEGUI::ConstBaseIterator< T >::d_startIter.

template<class T> bool CEGUI::ConstBaseIterator< T >::operator== (  const ConstBaseIterator< T > &  rhs  )  const [inline]

Compares two iterators. Return true if the current position of both iterators are equivalent. Definition at line 213 of file CEGUIIteratorBase.h. References CEGUI::ConstBaseIterator< T >::d_currIter.

template<class T> void CEGUI::ConstBaseIterator< T >::toEnd (  void   )  [inline]

Set the iterator current position to the end position. Definition at line 253 of file CEGUIIteratorBase.h.

template<class T> void CEGUI::ConstBaseIterator< T >::toStart (  void   )  [inline]

Set the iterator current position to the start position. Definition at line 243 of file CEGUIIteratorBase.h.

---

The documentation for this class was generated from the following file:

• CEGUIIteratorBase.h

---