#include <IWaxIterator.h>
Used to iterate over IWaxLines An IWaxIterator is returned from IWaxStrand::NewWaxIterator(). The returned object must be deleted. NOTE: This is not derived from IPMUnknown.
- See Also
- IWaxLines
- IWaxStrand::NewWaxIterator
| virtual void IWaxIterator::ClearCurrentLine | ( | | ) | const |
| pure virtual |
| virtual IWaxLine* IWaxIterator::GetCurrentWaxLine | ( | | ) | |
| pure virtual |
Returns the WaxLine at the current iterator position.
- Returns
- - The current wax line or nil.
| virtual const IWaxLine* IWaxIterator::GetCurrentWaxLine | ( | | ) | const |
| pure virtual |
Returns the WaxLine at the current iterator position.
- Returns
- - The current wax line or nil.
| virtual TextIndex IWaxIterator::GetCurrentWaxLineEnd | ( | | ) | const |
| pure virtual |
Returns the end of the current WaxLine.
- Returns
- - The end of the current WaxLine.
| virtual TextIndex IWaxIterator::GetCurrentWaxLineOrigin | ( | | ) | const |
| pure virtual |
Returns the current TextIndex of the the iterator.
- Returns
- - The TextIndex of the iterator.
| virtual int32 IWaxIterator::GetCurrentWaxLineSpan | ( | | ) | const |
| pure virtual |
Returns the span of the current WaxLine.
- Returns
- - The span of the current WaxLine.
| virtual IWaxLine* IWaxIterator::GetFirstWaxLine | ( | TextIndex | start, | | | int32 * | pOffset = nil | | ) | | |
| pure virtual |
Returns the IWaxLine at the given text index. This WaxLine is only valid until the next GetxxxWaxLine method call or the destruction of the IWaxIterator, whichever comes first. This method is also used to initialize the iterator.
- Parameters
| start | - The text index containing the line you want |
| *pOffset | - Filled with the offset from the beginning of the line where start can be found |
- Returns
- - The wax line containing "start"
| virtual const IWaxLine* IWaxIterator::GetFirstWaxLine | ( | TextIndex | start, | | | int32 * | pOffset = nil | | ) | | const |
| pure virtual |
Returns the IWaxLine at the given text index. This WaxLine is only valid until the next GetxxxWaxLine method call or the destruction of the IWaxIterator, whichever comes first. This method is also used to initialize the iterator.
- Parameters
| start | - The text index containing the line you want |
| *pOffset | - Filled with the offset from the beginning of the line where start can be found |
- Returns
- - The wax line containing "start"
| virtual IWaxLine* IWaxIterator::GetNextWaxLine | ( | | ) | |
| pure virtual |
Returns either the next wax line or nil if the end of story is reached.
- Returns
- - The next wax line or nil.
| virtual const IWaxLine* IWaxIterator::GetNextWaxLine | ( | | ) | const |
| pure virtual |
Returns either the next wax line or nil if the end of story is reached.
- Returns
- - The next wax line or nil.
| virtual IWaxLine* IWaxIterator::GetPreviousWaxLine | ( | | ) | |
| pure virtual |
Returns either the previous IWaxLine, or nil if the start of the story is reached.
- Returns
- - The previous wax line or nil.
| virtual const IWaxLine* IWaxIterator::GetPreviousWaxLine | ( | | ) | const |
| pure virtual |
Returns either the previous IWaxLine, or nil if the start of the story is reached.
- Returns
- - The previous wax line or nil.
| virtual UIDRef IWaxIterator::GetStrandIterating | ( | | ) | const |
| pure virtual |
1.8.3.1 
