HxmMapIterator Class

class HxmMapIterator

An iterator referencing the contents of an HxmMap.

See:

HxmMap

Since:

10.0

Summary

Functions

next

Advances the iterator to the next element of the map.

getKey

Returns the current key in the iteration.

getValue

Returns the current value in the iteration.

Functions

bool HxmMapIterator::next()

Advances the iterator to the next element of the map. Returns true if the iterator was successfully advanced and false if the iterator has passed the end of the map.

HxmValue HxmMapIterator::getKey() const

Returns the current key in the iteration. This method returns nil if the iterator is positionned before the first element in the map. next() must be called to advance the iterator to the first element of the map before calling this method.

HxmValue HxmMapIterator::getValue() const

Returns the current value in the iteration. This method returns nil if the iterator is positionned before the first element in the map. next() must be called to advance the iterator to the first element of the map before calling this method.