- end
- Returns an invalid iterator.
public:
static const ITextStyleRunIterator end()
- An iterator can be compared against the one returned by this function to
test for loop termination
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- operator *
public:
const ITextStyleSet& operator *() const
- Returns a reference to the style set belonging to the current style run.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- operator ++
- Increments to the next run.
Overload 1
- Advances the iterator to the next style run in the IText.
public:
ITextStyleRunIterator operator ++(int)
- Return
- a copy of *this from before it was advanced
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Overload 2
- Advances the iterator to the next style run in the IText.
public:
ITextStyleRunIterator& operator ++()
- Return
- *thi
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- operator --
- Decrements to the previous run.
Overload 1
- Advances the iterator to the previous style run in the IText.
public:
ITextStyleRunIterator& operator --()
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Overload 2
- Advances the iterator to the previous style run in the IText.
public:
ITextStyleRunIterator operator --(int)
- Return
- a copy of *this from before it was advanced
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- operator ->
public:
const ITextStyleSet* operator ->() const
- Allows direct access to the members of the style set belonging to the curent style run.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- operator bool
- Returns true when the iterator is no longer valid.
public:
operator bool() const
- The iterator goes invalid when it is advanced off of either end of the IText's
style run array. This operator can be used to test for loop termination.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- runLength
- Returns the number of characters in the current style run.
public:
length_type runLength() const
- Returns the length of the run.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- runStart
- Returns the character offset of the first character in the current style run.
public:
offset_type runStart() const
- Returns the start of the run.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- setCharacterOffset
public:
void setCharacterOffset(offset_type charOffset)
- Sets the iterator to point to the style run containing the given character offset.
- Exception
| IInvalidParameter
| if charOffset is greater than the length of the
IText being examined
|
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- setPropagation
- Sets the iterator to examine only styles of the given propagation type.
public:
void
setPropagation( ITextStyle::EStylePropagation propagation )
- (Because there is no way to map style-run positions and lengths from
one propagation type to another, this also resets the iterator to point
to the first style run in the IText (according to the new propagation type).)
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- setText
public:
void setText(const IText& theText)
- Sets the iterator to point to the first style run in the specified IText.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |