RWUAvailableLocaleListIterator

Module:  Internationalization Module   Group:  Localization

Does Not Inherit

• Local Index
• Header File
• Description
• Example
• Related Classes
• Public Typedefs
• Global Operators
• Public Constructors
• Public Destructor
• Public Member Operators

Members

difference_type iterator_category operator!=() operator>() operator>=()

operator<() operator<=() operator*() operator++() operator+=()

operator-() operator--() operator-=() operator=() operator==()

pointer reference RWUAvailableLocaleListIterator() value_type ~RWUAvailableLocaleListIterator()

Non-Members

operator+()

operator-()

#include <rw/i18n/RWUAvailableLocaleListIterator.h>

RWUAvailableLocaleListIterator is a Standard C++ bidirectional iterator for class RWUAvailableLocaleList.

An instance of RWUAvailableLocaleListIterator can be used to access the list of locale names currently recognized by the Internationalization Module. The list cannot be changed at run time.

#include <rw/i18n/RWUAvailableLocaleList.h>
#include <iostream>

int
main()
{
  // Iterate over the list of locales and write them to
  // std::cout, obtaining iterators from the static
  // RWUAvailableLocaleList begin() and end() methods.
  RWUAvailableLocaleList::const_iterator iter;
  for (iter = RWUAvailableLocaleList::begin();
       iter != RWUAvailableLocaleList::end();
       ++iter)
  {
    std::cout << *iter << std::endl;
  }

  // Iterate over the list of locales again, obtaining
  // iterators from an RWUAvailableLocaleList object.
  RWUAvailableLocaleList list;
  for (iter = list.begin(); iter != list.end(); ++iter) {
    std::cout << *iter << std::endl;
  }

  return 0;
}

RWUAvailableLocaleList

typedef int32_t difference_type;

Declares a conventional Standard C++ alias for the type used to represent iterator offsets and differences.

typedef RW_SL_STD(bidirectional_iterator_tag) 
   iterator_category;

Tags this class as a Standard C++ bidirectional iterator.

typedef value_type* pointer;

Declares a conventional Standard C++ alias for the value pointer type.

typedef value_type& reference;

Declares a conventional Standard C++ alias for the value reference type.

typedef const char* value_type;

Declares a conventional Standard C++ alias for the value type returned by operator*().

RWUAvailableLocaleListIterator
operator+(
     RWUAvailableLocaleListIterator::difference_type offset,
     const RWUAvailableLocaleListIterator& rhs);

Returns a new iterator whose list position is calculated by adding offset to the position of rhs. If the position of the new iterator is less than the position given by RWUAvailableLocaleList::begin(), the iterator is positioned at begin(). If the position of the new iterator is greater than the position given by RWUAvailableLocaleList::end(), the iterator is positioned at end().

RWUAvailableLocaleListIterator
operator+(const RWUAvailableLocaleListIterator& lhs, 
    RWUAvailableLocaleListIterator::difference_type offset);

Returns a new iterator whose list position is calculated by adding offset to the position of lhs. If the position of the new iterator is less than the position given by RWUAvailableLocaleList::begin(), the iterator is positioned at begin(). If the position of the new iterator is greater than the position given by RWUAvailableLocaleList::end(), the iterator is positioned at end().

RWUAvailableLocaleListIterator
operator-(const RWUAvailableLocaleListIterator& lhs, 
    RWUAvailableLocaleListIterator::difference_type offset);

Returns a new iterator whose list position is calculated by subtracting offset from the position of lhs. If the position of the new iterator is less than the position given by RWUAvailableLocaleList::begin(), the iterator is positioned at begin(). If the position of the new iterator is greater than the position given by RWUAvailableLocaleList::end(), the iterator is positioned at end().

RWUAvailableLocaleListIterator(void);

Default constructor. Creates an invalid iterator. Attempts to dereference an invalid iterator throw RWBoundsErr. Use RWUAvailableLocaleList to obtain valid iterators.

RWUAvailableLocaleListIterator(
   const RWUAvailableLocaleListIterator& source);

Copy constructor. Makes self a copy of source.

~RWUAvailableLocaleListIterator();

Destructor.

RWUAvailableLocaleListIterator&
operator=(const RWUAvailableLocaleListIterator& rhs);

Changes the state of self to match that of rhs. Makes the list position of self equal to the list position of rhs.

bool
operator==(const RWUAvailableLocaleListIterator& rhs) const;

Returns true if the list position of self is equal to the list position of rhs; otherwise, false.

bool
operator!=(const RWUAvailableLocaleListIterator& rhs) const;

Returns true if the list position of self is not equal to the list position of rhs; otherwise, false.

bool
operator<(const RWUAvailableLocaleListIterator& rhs) const;

Returns true if the list position of self is less than the list position of rhs; otherwise, false.

bool
operator<=(const RWUAvailableLocaleListIterator& rhs) const;

Returns true if the list position of self is less than or equal to the list position of rhs; otherwise, false.

bool
operator>(const RWUAvailableLocaleListIterator& rhs) const;

Returns true if the list position of self is greater than the list position of rhs; otherwise, false.

bool
operator>=(const RWUAvailableLocaleListIterator& rhs) const;

Returns true if the list position of self is greater than or equal to the list position of rhs; otherwise, false.

value_type
operator*() const;

Returns a const char* to a null-terminated character string containing the locale name located at the list position specified by self.

The storage for this string is owned by the library.

Throws RWBoundsErr if the iterator is invalid or positioned past the end of the list.

RWUAvailableLocaleListIterator&
operator++();

Repositions self to the next position in the locale name list, and returns a reference to self. If self is equal to RWUAvailableLocaleList::end(), its position is left unchanged.

RWUAvailableLocaleListIterator
operator++(int);

Repositions self to the next position in the locale name list, and returns a new iterator that points to the old position. If self is equal to RWUAvailableLocaleList::end(), its position is left unchanged.

RWUAvailableLocaleListIterator&
operator+=(difference_type offset);

Repositions self to a new position in the locale name list by adding offset to the current iterator position, and returns a reference to self.

If the new position is less than the position given by RWUAvailableLocaleList::begin(), self is positioned at begin(). If the new position is greater than the position given by RWUAvailableLocaleList::end(), self is positioned at end().

RWUAvailableLocaleListIterator&
operator--();

Repositions self to the previous position in the locale name list, and returns a reference to self. If self is equal to RWUAvailableLocaleListIterator::begin(), its position is left unchanged.

RWUAvailableLocaleListIterator
operator--(int);

Repositions self to the previous position in the locale name list, and returns a new iterator that points to the old position. If self is equal to RWUAvailableLocaleList::begin(), its position is left unchanged.

RWUAvailableLocaleListIterator&
operator-=(difference_type offset);

Repositions self to a new position in the locale name list by subtracting offset from the current iterator position, and returns a reference to self.

If the new position is less than the position given by RWUAvailableLocaleList::begin(), self is positioned at begin(). If the new position is greater than the position given by RWUAvailableLocaleList::end(), self is positioned at end().

difference_type
operator-(const RWUAvailableLocaleListIterator& rhs) const;

Calculates the difference, or distance, between self and rhs.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.