RWUEncodingNameStandardListIterator Class Reference
[Character Encoding Scheme Conversion]

A Standard C++ Library bidirectional iterator for class RWUEncodingNameStandardList. More...

#include <rw/i18n/RWUEncodingNameStandardListIterator.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
	RWUEncodingNameStandardListIterator (void)
	RWUEncodingNameStandardListIterator (const RWUEncodingNameStandardListIterator &source)
RWUEncodingNameStandardListIterator &	operator= (const RWUEncodingNameStandardListIterator &rhs)
	~RWUEncodingNameStandardListIterator ()
bool	operator== (const RWUEncodingNameStandardListIterator &rhs) const
bool	operator!= (const RWUEncodingNameStandardListIterator &rhs) const
bool	operator< (const RWUEncodingNameStandardListIterator &rhs) const
bool	operator<= (const RWUEncodingNameStandardListIterator &rhs) const
bool	operator> (const RWUEncodingNameStandardListIterator &rhs) const
bool	operator>= (const RWUEncodingNameStandardListIterator &rhs) const
value_type	operator* () const
RWUEncodingNameStandardListIterator &	operator++ ()
RWUEncodingNameStandardListIterator	operator++ (int)
RWUEncodingNameStandardListIterator &	operator+= (difference_type offset)
RWUEncodingNameStandardListIterator &	operator-- ()
RWUEncodingNameStandardListIterator	operator-- (int)
RWUEncodingNameStandardListIterator &	operator-= (difference_type offset)
difference_type	operator- (const RWUEncodingNameStandardListIterator &rhs) const
Related Functions
(Note that these are not member functions.)
RWUEncodingNameStandardListIterator	operator+ (RWUEncodingNameStandardListIterator::difference_type offset, const RWUEncodingNameStandardListIterator &rhs)
RWUEncodingNameStandardListIterator	operator+ (const RWUEncodingNameStandardListIterator &lhs, RWUEncodingNameStandardListIterator::difference_type offset)
RWUEncodingNameStandardListIterator	operator- (const RWUEncodingNameStandardListIterator &lhs, RWUEncodingNameStandardListIterator::difference_type offset)

---

Detailed Description

RWUEncodingNameStandardListIterator is a Standard C++ bidirectional iterator for class RWUEncodingNameStandardList. An instance of RWUEncodingNameStandardListIterator can be used to access the list of encoding name standards that are currently recognized by the Internationalization Module. The list cannot be changed at run time.

Examples

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

See also:

RWUEncodingNameStandardList

---

Member Typedef Documentation

typedef int32_t RWUEncodingNameStandardListIterator::difference_type

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

typedef std::bidirectional_iterator_tag RWUEncodingNameStandardListIterator::iterator_category

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

typedef const value_type* RWUEncodingNameStandardListIterator::pointer

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

typedef const value_type& RWUEncodingNameStandardListIterator::reference

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

typedef const char* RWUEncodingNameStandardListIterator::value_type

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

---

Constructor & Destructor Documentation

RWUEncodingNameStandardListIterator::RWUEncodingNameStandardListIterator

(

void

)

[inline]

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

RWUEncodingNameStandardListIterator::RWUEncodingNameStandardListIterator

(

const RWUEncodingNameStandardListIterator &

source

)

[inline]

Copy constructor.

RWUEncodingNameStandardListIterator::~RWUEncodingNameStandardListIterator

(

)

[inline]

Destructor.

---

Member Function Documentation

bool RWUEncodingNameStandardListIterator::operator!=

(

const RWUEncodingNameStandardListIterator &

rhs

)

const [inline]

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

RWUEncodingNameStandardListIterator::value_type RWUEncodingNameStandardListIterator::operator*

(

)

const [inline]

Returns a const char* to a null-terminated character string that contains the name of the encoding name standard 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.

RWUEncodingNameStandardListIterator RWUEncodingNameStandardListIterator::operator++

(

int

)

[inline]

Repositions self to the next position in the encoding name standard list, and returns a new iterator that points to the old position.

If self is equal to RWUEncodingNameStandardList::end(), its position is left unchanged.

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator++

(

)

[inline]

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

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator+=

(

difference_type

offset

)

[inline]

Repositions self to a new position in the encoding name standard 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 RWUEncodingNameStandardList::begin(), self is positioned at RWUEncodingNameStandardList::begin().

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

RWUEncodingNameStandardListIterator::difference_type RWUEncodingNameStandardListIterator::operator-

(

const RWUEncodingNameStandardListIterator &

rhs

)

const [inline]

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

RWUEncodingNameStandardListIterator RWUEncodingNameStandardListIterator::operator--

(

int

)

[inline]

Repositions self to the previous position in the encoding name standard list, and returns a new iterator that points to the old position.

If self is equal to RWUEncodingNameStandardList::begin(), its position is left unchanged.

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator--

(

)

[inline]

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

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator-=

(

difference_type

offset

)

[inline]

Repositions self to a new position in the encoding name standard 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 RWUEncodingNameStandardList::begin(), self is positioned at RWUEncodingNameStandardList::begin().

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

bool RWUEncodingNameStandardListIterator::operator<

(

const RWUEncodingNameStandardListIterator &

rhs

)

const [inline]

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

bool RWUEncodingNameStandardListIterator::operator<=

(

const RWUEncodingNameStandardListIterator &

rhs

)

const [inline]

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

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator=

(

const RWUEncodingNameStandardListIterator &

rhs

)

[inline]

Changes the state of self to match that of rhs.

bool RWUEncodingNameStandardListIterator::operator==

(

const RWUEncodingNameStandardListIterator &

rhs

)

const [inline]

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

bool RWUEncodingNameStandardListIterator::operator>

(

const RWUEncodingNameStandardListIterator &

rhs

)

const [inline]

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

bool RWUEncodingNameStandardListIterator::operator>=

(

const RWUEncodingNameStandardListIterator &

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

RWUEncodingNameStandardListIterator operator+	(	const RWUEncodingNameStandardListIterator &	lhs,
		RWUEncodingNameStandardListIterator::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 RWUEncodingNameStandardList::begin(), the iterator is positioned at RWUEncodingNameStandardList::begin(). If the position of the new iterator is greater than the position given by RWUEncodingNameStandardList::end(), the iterator is positioned at RWUEncodingNameStandardList::end().

RWUEncodingNameStandardListIterator operator+	(	RWUEncodingNameStandardListIterator::difference_type	offset,
		const RWUEncodingNameStandardListIterator &	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 RWUEncodingNameStandardList::begin(), the iterator is positioned at RWUEncodingNameStandardList::begin(). If the position of the new iterator is greater than the position given by RWUEncodingNameStandardList::end(), the iterator is positioned at RWUEncodingNameStandardList::end().

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