 SourcePro® 2023.1 |
SourcePro® API Reference Guide |
A C++ Standard Library-compatible random-access iterator for class RWUEncodingAliasList. More...
#include <rw/i18n/RWUEncodingAliasListIterator.h>
Public Types | |
| typedef int32_t | difference_type |
| typedef std::random_access_iterator_tag | iterator_category |
| typedef value_type * | pointer |
| typedef value_type | reference |
| typedef const char * | value_type |
Related Functions | |
(Note that these are not member functions.) | |
| RWUEncodingAliasListIterator | operator+ (RWUEncodingAliasListIterator::difference_type offset, const RWUEncodingAliasListIterator &rhs) |
| RWUEncodingAliasListIterator | operator+ (const RWUEncodingAliasListIterator &lhs, RWUEncodingAliasListIterator::difference_type offset) |
| RWUEncodingAliasListIterator | operator- (const RWUEncodingAliasListIterator &lhs, RWUEncodingAliasListIterator::difference_type offset) |
RWUEncodingAliasListIterator is a C++ Standard Library-compatible random-access 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.
Program output:
| typedef int32_t RWUEncodingAliasListIterator::difference_type |
Declares an alias for the type used to represent iterator offsets and differences.
| typedef std::random_access_iterator_tag RWUEncodingAliasListIterator::iterator_category |
Tags this class as a C++ Standard Library-compatible random-access iterator.
Declares an alias for the value pointer type.
Declares an alias for the value reference type.
| typedef const char* RWUEncodingAliasListIterator::value_type |
Declares an alias for the value type returned by operator*().
|
inline |
Default constructor. Creates an invalid iterator. Attempts to dereference an invalid iterator throw RWBoundsErr. Use RWUEncodingAliasList to obtain valid iterators.
|
inline |
Copy constructor.
|
inline |
Destructor.
|
inline |
Returns true if the list position of self is not equal to the list position of rhs; otherwise, false.
| value_type RWUEncodingAliasListIterator::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.
| RWBoundsErr | Thrown if the iterator is invalid or positioned past the end of the list. |
| RWUEncodingAliasListIterator& RWUEncodingAliasListIterator::operator++ | ( | ) |
Repositions self to the next position in the encoding alias list and returns a reference to self.
| RWUEncodingAliasListIterator RWUEncodingAliasListIterator::operator++ | ( | int | ) |
Repositions self to the next position in the encoding alias list and returns a copy of the previous value of self.
| RWUEncodingAliasListIterator& RWUEncodingAliasListIterator::operator+= | ( | difference_type | offset | ) |
Adds offset to the current iterator position.
|
inline |
Calculates the difference, or distance, between self and rhs.
|
inline |
Repositions self to the preceding position in the encoding alias list and returns a reference to self.
|
inline |
Repositions self to the preceding position in the encoding alias list and returns a copy of the previous value of self.
| RWUEncodingAliasListIterator& RWUEncodingAliasListIterator::operator-= | ( | difference_type | offset | ) |
Subtracts offset from the current iterator position.
|
inline |
Returns true if the list position of self is less than the list position of rhs; otherwise, false.
|
inline |
Returns true if the list position of self is less than or equal to the list position of rhs; otherwise, false.
|
inline |
Changes the state of self to match that of source.
|
inline |
Returns true if the list position of self is equal to the list position of rhs; otherwise, false.
|
inline |
Returns true if the list position of self is greater than the list position of rhs; otherwise, false.
|
inline |
Returns true if the list position of self is greater than or equal to the list position of rhs; otherwise, false.
| value_type RWUEncodingAliasListIterator::operator[] | ( | difference_type | offset | ) | const |
Returns a const char* to a null-terminated character string that contains the name of the encoding alias located at the list position specified by the given offset from self.
|
related |
Returns a new iterator whose list position is calculated by adding offset to the position of rhs.
|
related |
Returns a new iterator whose list position is calculated by adding offset to the position of lhs.
|
related |
Returns a new iterator whose list position is calculated by subtracting offset from the position of lhs.
|
Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |
