RWUEncodingAliasListIterator
Module: Internationalization Module Group: Character Encoding Scheme Conversion
Does Not Inherit
- Local Index
- Header File
- Description
- Example
- Related Classes
- Public Typedefs
- Global Operators
- Public Constructors
- Public Destructor
- Public Member Operators
Local Index
Members
Non-Members
Header File
#include <rw/i18n/RWUEncodingAliasListIterator.h>
Description
RWUEncodingAliasListIterator is a Standard C++ bidirectional iterator for class RWUEncodingAliasList. An instance of RWUEncodingAliasListIterator can be used to access the list of aliases associated with any encoding currently recognized by the Internationalization Module. The list cannot be changed at run time.
An RWUEncodingAliasListIterator instance is only valid as long as the RWUEncodingAliasList instance used to create it continues to exist.
Example
#include <rw/i18n/RWUEncodingAliasList.h>
#include <iostream>
int
main()
{
// Construct a list object.
RWUEncodingAliasList list("US-ASCII");
// Iterate over the list of aliases and write them
// to std::cout.
RWUEncodingAliasListIterator iter;
for (iter = list.begin(); iter != list.end(); ++iter) {
std::cout << *iter << std::endl;
}
return 0;
}
Results:
========
US-ASCII
ascii
ascii-7
ANSI_X3.4-1968
ANSI_X3.4-1986
ISO_646.irv:1991
iso646-us
us
csASCII
646
iso-ir-6
cp367
Related Classes
Public Typedefs
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 const value_type* pointer;
Declares a conventional Standard C++ alias for the value pointer type.
typedef const 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*().
Global Operators
RWUEncodingAliasListIterator
operator+(
RWUEncodingAliasListIterator::difference_type offset,
const RWUEncodingAliasListIterator& 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 RWUEncodingAliasList::begin(), the iterator is positioned at begin(). If the position of the new iterator is greater than the position given by RWUEncodingAliasList::end(), the iterator is positioned at end().
RWUEncodingAliasListIterator
operator+(const RWUEncodingAliasListIterator& lhs,
RWUEncodingAliasListIterator::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 RWUEncodingAliasList::begin(), the iterator is positioned at begin(). If the position of the new iterator is greater than the position given by RWUEncodingAliasList::end(), the iterator is positioned at end().
RWUEncodingAliasListIterator
operator-(const RWUEncodingAliasListIterator& lhs,
RWUEncodingAliasListIterator::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 RWUEncodingAliasList::begin(), the iterator is positioned at begin(). If the position of the new iterator is greater than the position given by RWUEncodingAliasList::end(), the iterator is positioned at end().
Public Constructors
RWUEncodingAliasListIterator(void);
Default constructor. Creates an invalid iterator. Attempts to dereference an invalid iterator throw RWBoundsErr. Use RWUEncodingAliasList to obtain valid iterators.
RWUEncodingAliasListIterator( const RWUEncodingAliasListIterator& source);
Copy constructor.
Public Destructor
~RWUEncodingAliasListIterator();
Destructor.
Public Member Operators
RWUEncodingAliasListIterator& operator=(const RWUEncodingAliasListIterator& source);
Changes the state of self to match that of source.
bool operator==(const RWUEncodingAliasListIterator& rhs) const;
Returns true if the list position of self is equal to the list position of rhs; otherwise, false.
This method always returns false if self refers to a different alias list than rhs.
bool operator!=(const RWUEncodingAliasListIterator& rhs) const;
Returns true if the list position of self is not equal to the list position of rhs; otherwise, false.
This method always returns true if self refers to a different alias list than rhs.
bool operator<(const RWUEncodingAliasListIterator& rhs) const;
Returns true if the list position of self is less than the list position of rhs; otherwise, false.
This method always returns false if self refers to a different alias list than rhs.
bool operator<=(const RWUEncodingAliasListIterator& rhs) const;
Returns true if the list position of self is less than or equal to the list position of rhs; otherwise, false.
This method always returns false if self refers to a different alias list than rhs.
bool operator>(const RWUEncodingAliasListIterator& rhs) const;
Returns true if the list position of self is greater than the list position of rhs; otherwise, false.
This method always returns false if self refers to a different alias list than rhs.
bool operator>=(const RWUEncodingAliasListIterator& rhs) const;
Returns true if the list position of self is greater than or equal to the list position of rhs; otherwise, false.
This method always returns false if self refers to a different alias list than rhs.
value_type operator*() const;
Returns a const char* to a null-terminated character string that contains the alias 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.
RWUEncodingAliasListIterator& operator++();
Repositions self to the next position in the encoding alias list unless self has the same value as end(), in which case its position is left unchanged. Returns a reference to self.
RWUEncodingAliasListIterator operator++(int);
Prefix operator. Repositions self to the next position in the encoding alias list unless self has the same value as end(), in which case its position is left unchanged. Returns a copy of the previous value of self.
RWUEncodingAliasListIterator& operator+=(difference_type offset);
Adds offset to the current iterator position. If the new position is less than the position given by begin(), self is positioned at begin(). If the new position is greater than the position given by end(), self is positioned at end(). Returns a reference to self.
RWUEncodingAliasListIterator& operator--();
Repositions self to the previous position in the encoding alias list unless self has the same value as begin(), in which case its position is unchanged. Returns a reference to self.
RWUEncodingAliasListIterator operator--(int);
Prefix operator. Repositions self to the previous position in the encoding alias list unless self has the same value as begin(), in which case its position is unchanged. Returns a copy of the previous value of self.
RWUEncodingAliasListIterator& operator-=(difference_type offset);
Subtracts offset from the current iterator position. If the new position is less than the position given by begin(), self is positioned at begin(). If the new position is greater than the position given by end(), self is positioned at end(). Returns a reference to self.
difference_type operator-(const RWUEncodingAliasListIterator& 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.