ATE::ITextRangesIterator Class Reference

This object allows you to iterate through a set of text ranges. More...

#include <IText.h>

List of all members.

Public Member Functions
	ITextRangesIterator ()
	Constructor.
	ITextRangesIterator (const ITextRangesIterator &src)
	Copy constructor.
ITextRangesIterator &	operator= (const ITextRangesIterator &rhs)
	Assignment operator.
bool	operator== (const ITextRangesIterator &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ITextRangesIterator &rhs) const
	Comparison operator tests for inequality.
	ITextRangesIterator (TextRangesIteratorRef textrangesiterator)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ITextRangesIterator ()
	Destructor.
TextRangesIteratorRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
	ITextRangesIterator (ITextRanges textRanges, Direction direction=kForward)
	Constructor.
ITextRangesIterator	Clone () const
	Creates a duplicate of this object.
bool	IsNotDone () const
	Reports whether the end of the set has been reached.
bool	IsDone () const
	Reports whether the end of the set has been reached.
bool	IsEmpty () const
	Reports whether the set is empty.
void	MoveToFirst ()
	Sets the current position to the first member of this set.
void	MoveToLast ()
	Sets the current position to the last member of this set.
void	Next ()
	Increments the current position in the set in the iterator's current direction.
ITextRange	Item () const
	Retrieves the current text range.

---

Detailed Description

This object allows you to iterate through a set of text ranges.

Create the iterator from a set of text ranges (ITextRanges).

---

Constructor & Destructor Documentation

ATE::ITextRangesIterator::ITextRangesIterator

(

)

Constructor.

Returns:

The new object.

Referenced by Clone().

ATE::ITextRangesIterator::ITextRangesIterator

(

const ITextRangesIterator &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sTextRangesIterator.

ATE::ITextRangesIterator::ITextRangesIterator

(

TextRangesIteratorRef

textrangesiterator

)

[explicit]

Constructs this C++ object from the corresponding C object returned by an ATE suite function.

The C++ object manages reference counting.

Parameters:

textrangesiterator

The C object.

Returns:

The new C++ object.

ATE::ITextRangesIterator::~ITextRangesIterator

(

)

[virtual]

Destructor.

References ATE::sTextRangesIterator.

ATE::ITextRangesIterator::ITextRangesIterator	(	ITextRanges	textRanges,
		Direction	direction = kForward
	)

Constructor.

Creates an iterator object for a specific text range set that is ordered first-to-last or last-to-first.

Parameters:

	textRanges	The text range set object.
	direction	Optional. The order of iteration. Default is first-to-last.

Returns:

The new iterator object.

References ATE::ITextRanges::GetRef(), ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

---

Member Function Documentation

ITextRangesIterator ATE::ITextRangesIterator::Clone

(

)

const

Creates a duplicate of this object.

Returns:

The new object.

References ITextRangesIterator(), ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

TextRangesIteratorRef ATE::ITextRangesIterator::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::ITextRangesIterator::IsDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if no more members remain in the set.

References ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

bool ATE::ITextRangesIterator::IsEmpty

(

)

const

Reports whether the set is empty.

Returns:

True if the set is empty.

References ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

bool ATE::ITextRangesIterator::IsNotDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

References ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

bool ATE::ITextRangesIterator::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sTextRangesIterator.

ITextRange ATE::ITextRangesIterator::Item

(

)

const

Retrieves the current text range.

Returns:

The text range object.

References ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

void ATE::ITextRangesIterator::MoveToFirst

(

)

Sets the current position to the first member of this set.

Returns:

Nothing.

References ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

void ATE::ITextRangesIterator::MoveToLast

(

)

Sets the current position to the last member of this set.

Returns:

Nothing.

References ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

void ATE::ITextRangesIterator::Next

(

)

Increments the current position in the set in the iterator's current direction.

Returns:

Nothing.

References ATE::sTextRangesIterator, and ATE::Throw_ATE_Exception().

bool ATE::ITextRangesIterator::operator!=

(

const ITextRangesIterator &

rhs

)

const

Comparison operator tests for inequality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are not the same.

ITextRangesIterator & ATE::ITextRangesIterator::operator=

(

const ITextRangesIterator &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sTextRangesIterator.

bool ATE::ITextRangesIterator::operator==

(

const ITextRangesIterator &

rhs

)

const

Comparison operator tests for equality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are the same.

---

The documentation for this class was generated from the following files:

• IText.h
• IText.cpp