ICharacterPropertyIterator
The ICharacterPropertyIterator class allows you to identify the set of Unicode
characters with specific character properties.
Do not derive from this class.
ICharacterPropertyIterator - Member Functions and Data by Group
Constructors & Destructor
Use the constructors and destructor in this group to create and destroy objects of class ICharacterPropertyIterator.
- ~ICharacterPropertyIterator
public:
virtual ~ICharacterPropertyIterator()
- Destructor, used to delete an ICharacterPropertyIterator object.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- ICharacterPropertyIterator
- Creates an ICharacterPropertyIterator object.
Overload 1
public:
ICharacterPropertyIterator( const ICharacterPropertyIterator& that )
- Use this constructor to create an ICharacterPropertyIterator object that is initialized
by copying from the given one.
-
that
-
The ICharacterPropertyIterator object being copied in.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Overload 2
public:
ICharacterPropertyIterator( IUnicode::ECharacterProperty lowPropertyBound,
IUnicode::ECharacterProperty highPropertyBound )
- Constructs an ICharacterPropertyIterator using the given values.
Use this constructor to create an iterator that allows you to walk through a
set of Unicode characters in the specified range.
-
lowPropertyBound
-
The low boundary of the character property
range.
-
highPropertyBound
-
The high boundary of the character
property range.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Assignment Operator
Use the operator in this group to assign the given ICharacterPropertyIterator to the current one.
- operator =
public:
ICharacterPropertyIterator&
operator =( const ICharacterPropertyIterator& that )
Replaces the entire contents of *this iterator with the specified value.
-
that
-
The ICharacterPropertyIterator object being copied in.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Getting the Current Unicode Character
Use the function in this group to obtain the current Unicode character in the range.
- operator *
public:
UniChar operator *() const
- Returns the current Unicode character in the range.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Incrementing the Iterator
Use the functions in this group to increment the character property iterator.
- operator ++
- This function increments the iterator.
Overload 1
public:
ICharacterPropertyIterator& operator ++()
- This function advances to the next Unicode character and returns the advanced character
property iterator. When the end of range is detected, return *this.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Overload 2
public:
ICharacterPropertyIterator operator ++(int)
- This function advances to the next Unicode character and returns the advanced character
property iterator. When the end of range is detected, returns *this.
-
int
-
This int type represents the postfix form of ++ operator.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Resetting the Cursor Pointer
Use the function in this group to point the cursor at the first character property in the range.
- reset
public:
void reset()
- Resets the cursor pointer to the first character property in the range.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Setting and Getting the Iterator Range
Use the functions in this group to get and set the character property iterator range.
- range
public:
void
range( IUnicode::ECharacterProperty& lowPropertyBound,
IUnicode::ECharacterProperty& highPropertyBound ) const
Gets the character property iterator range.
-
lowPropertyBound
-
The low boundary of the character property
range.
-
highPropertyBound
-
The high boundary of the character
property range.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setRange
public:
void
setRange( IUnicode::ECharacterProperty lowPropertyBound,
IUnicode::ECharacterProperty highPropertyBound )
Sets the character property iterator range to a new range.
-
lowPropertyBound
-
The low boundary of the character property
range.
-
highPropertyBound
-
The high boundary of the character
property range.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Testing the Iterator Position
Use the function in this group to determine if the iterator is positioned at the end of the list.
- operator bool
public:
operator bool() const
- Indicates the iterator is at the end of the list.
Returns true if there are more elements on the list, otherwise returns false.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Inherited Public Functions
Inherited Public Data
Inherited Protected Functions
Inherited Protected Data