RWUAvailableEncodingListIterator Class Reference
[Character Encoding Scheme Conversion]

Provides a C++ Standard Library bidirectional iterator for class RWUAvailableEncodingList. More...

#include <rw/i18n/RWUAvailableEncodingListIterator.h>

List of all members.

Public Types
typedef const char *	value_type
typedef int32_t	difference_type
typedef const value_type *	pointer
typedef const value_type &	reference
typedef std::bidirectional_iterator_tag	iterator_category
Public Member Functions
	RWUAvailableEncodingListIterator (void)
	RWUAvailableEncodingListIterator (const RWUAvailableEncodingListIterator &source)
RWUAvailableEncodingListIterator &	operator= (const RWUAvailableEncodingListIterator &rhs)
	~RWUAvailableEncodingListIterator ()
bool	operator== (const RWUAvailableEncodingListIterator &rhs) const
bool	operator!= (const RWUAvailableEncodingListIterator &rhs) const
bool	operator< (const RWUAvailableEncodingListIterator &rhs) const
bool	operator<= (const RWUAvailableEncodingListIterator &rhs) const
bool	operator> (const RWUAvailableEncodingListIterator &rhs) const
bool	operator>= (const RWUAvailableEncodingListIterator &rhs) const
value_type	operator* () const
RWUAvailableEncodingListIterator &	operator++ ()
RWUAvailableEncodingListIterator	operator++ (int)
RWUAvailableEncodingListIterator &	operator+= (difference_type offset)
RWUAvailableEncodingListIterator &	operator-- ()
RWUAvailableEncodingListIterator	operator-- (int)
RWUAvailableEncodingListIterator &	operator-= (difference_type offset)
difference_type	operator- (const RWUAvailableEncodingListIterator &rhs) const
Related Functions
(Note that these are not member functions.)
RWUAvailableEncodingListIterator	operator+ (RWUAvailableEncodingListIterator::difference_type offset, const RWUAvailableEncodingListIterator &rhs)
RWUAvailableEncodingListIterator	operator+ (const RWUAvailableEncodingListIterator &lhs, RWUAvailableEncodingListIterator::difference_type offset)
RWUAvailableEncodingListIterator	operator- (const RWUAvailableEncodingListIterator &lhs, RWUAvailableEncodingListIterator::difference_type offset)

---

Detailed Description

RWUAvailableEncodingListIterator is a C++ Standard Library bidirectional iterator for class RWUAvailableEncodingList. An instance of RWUAvailableEncodingListIterator can be used to access the list of encoding names currently recognized by the Internationalization Module. The list cannot be changed at run time.

Examples

 #include <rw/i18n/RWUAvailableEncodingList.h>
 #include <iostream>
 
 int
 main()
 {
   // Iterate over the list of encodings and write them
   // to std::cout, obtaining iterators from the static
   // RWUAvailableEncodingList begin() and end() methods.
   RWUAvailableEncodingList::const_iterator iter;
   for (iter = RWUAvailableEncodingList::begin();
        iter != RWUAvailableEncodingList::end();
        ++iter)
   {
     std::cout << *iter << std::endl;
   }
 
   // Iterate over the list of encodings again, obtaining
   // iterators from an RWUAvailableEncodingList object.
   RWUAvailableEncodingList list;
   for (iter = list.begin(); iter != list.end(); ++iter) {
     std::cout << *iter << std::endl;
   }
 
   return 0;
 }

See also:

RWUAvailableEncodingList

---

Member Typedef Documentation

typedef int32_t RWUAvailableEncodingListIterator::difference_type

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

typedef std::bidirectional_iterator_tag RWUAvailableEncodingListIterator::iterator_category

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

typedef const value_type* RWUAvailableEncodingListIterator::pointer

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

typedef const value_type& RWUAvailableEncodingListIterator::reference

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

typedef const char* RWUAvailableEncodingListIterator::value_type

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

---

Constructor & Destructor Documentation

RWUAvailableEncodingListIterator::RWUAvailableEncodingListIterator

(

void

)

[inline]

Default constructor. Creates an invalid iterator. Attempts to dereference an invalid iterator cause an RWBoundsErr exception to be thrown. Use RWUAvailableEncodingList to obtain valid iterators.

RWUAvailableEncodingListIterator::RWUAvailableEncodingListIterator

(

const RWUAvailableEncodingListIterator &

source

)

[inline]

Copy constructor. Makes self a copy of source.

RWUAvailableEncodingListIterator::~RWUAvailableEncodingListIterator

(

)

[inline]

Destructor.

---

Member Function Documentation

bool RWUAvailableEncodingListIterator::operator!=

(

const RWUAvailableEncodingListIterator &

rhs

)

const [inline]

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

RWUAvailableEncodingListIterator::value_type RWUAvailableEncodingListIterator::operator*

(

)

const [inline]

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

The storage for this string is owned by the library.

Exceptions:

RWBoundsErr

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

RWUAvailableEncodingListIterator RWUAvailableEncodingListIterator::operator++

(

int

)

[inline]

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

RWUAvailableEncodingListIterator & RWUAvailableEncodingListIterator::operator++

(

)

[inline]

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

RWUAvailableEncodingListIterator & RWUAvailableEncodingListIterator::operator+=

(

difference_type

offset

)

[inline]

Repositions self to a new position in the encoding 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 RWUAvailableEncodingList::begin(), self is positioned at RWUAvailableEncodingList::begin(). If the new position is greater than the position given by RWUAvailableEncodingList::end(), self is positioned at RWUAvailableEncodingList::end().

RWUAvailableEncodingListIterator::difference_type RWUAvailableEncodingListIterator::operator-

(

const RWUAvailableEncodingListIterator &

rhs

)

const [inline]

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

RWUAvailableEncodingListIterator RWUAvailableEncodingListIterator::operator--

(

int

)

[inline]

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

RWUAvailableEncodingListIterator & RWUAvailableEncodingListIterator::operator--

(

)

[inline]

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

RWUAvailableEncodingListIterator & RWUAvailableEncodingListIterator::operator-=

(

difference_type

offset

)

[inline]

Repositions self to a new position in the encoding 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 RWUAvailableEncodingList::begin(), self is positioned at RWUAvailableEncodingList::begin(). If the new position is greater than the position given by RWUAvailableEncodingList::end(), self is positioned at RWUAvailableEncodingList::end().

bool RWUAvailableEncodingListIterator::operator<

(

const RWUAvailableEncodingListIterator &

rhs

)

const [inline]

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

bool RWUAvailableEncodingListIterator::operator<=

(

const RWUAvailableEncodingListIterator &

rhs

)

const [inline]

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

RWUAvailableEncodingListIterator & RWUAvailableEncodingListIterator::operator=

(

const RWUAvailableEncodingListIterator &

rhs

)

[inline]

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

bool RWUAvailableEncodingListIterator::operator==

(

const RWUAvailableEncodingListIterator &

rhs

)

const [inline]

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

bool RWUAvailableEncodingListIterator::operator>

(

const RWUAvailableEncodingListIterator &

rhs

)

const [inline]

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

bool RWUAvailableEncodingListIterator::operator>=

(

const RWUAvailableEncodingListIterator &

rhs

)

const [inline]

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

---

Friends And Related Function Documentation

RWUAvailableEncodingListIterator operator+	(	const RWUAvailableEncodingListIterator &	lhs,
		RWUAvailableEncodingListIterator::difference_type	offset
	)			[related]

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 RWUAvailableEncodingList::begin(), the iterator is positioned at RWUAvailableEncodingList::begin(). If the position of the new iterator is greater than the position given by RWUAvailableEncodingList::end(), the iterator is positioned at RWUAvailableEncodingList::end().

RWUAvailableEncodingListIterator operator+	(	RWUAvailableEncodingListIterator::difference_type	offset,
		const RWUAvailableEncodingListIterator &	rhs
	)			[related]

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 RWUAvailableEncodingList::begin(), the iterator is positioned at RWUAvailableEncodingList::begin(). If the position of the new iterator is greater than the position given by RWUAvailableEncodingList::end(), the iterator is positioned at RWUAvailableEncodingList::end().

RWUAvailableEncodingListIterator operator-	(	const RWUAvailableEncodingListIterator &	lhs,
		RWUAvailableEncodingListIterator::difference_type	offset
	)			[related]

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 RWUAvailableEncodingList::begin(), the iterator is positioned at RWUAvailableEncodingList::begin(). If the position of the new iterator is greater than the position given by RWUAvailableEncodingList::end(), the iterator is positioned at RWUAvailableEncodingList::end().