ATE::ITextFramesIterator Class Reference

This object enables you to iterate through the set of text frames in the current document. More...

#include <IText.h>

List of all members.

Public Member Functions
	ITextFramesIterator ()
	Constructor.
	ITextFramesIterator (const ITextFramesIterator &src)
	Copy constructor.
ITextFramesIterator &	operator= (const ITextFramesIterator &rhs)
	Assignment operator.
bool	operator== (const ITextFramesIterator &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ITextFramesIterator &rhs) const
	Comparison operator tests for inequality.
	ITextFramesIterator (TextFramesIteratorRef textframesiterator)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ITextFramesIterator ()
	Destructor.
TextFramesIteratorRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
	ITextFramesIterator (const ITextRange &range)
	Constructor.
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	Next ()
	Increments the current position in the set in the iterator's current direction.
void	Previous ()
	Decrements the current position in the set.
ITextFrame	Item () const
	Retrieves the current text frame.

---

Detailed Description

This object enables you to iterate through the set of text frames in the current document.

See also:

ITextFrame.

---

Constructor & Destructor Documentation

ATE::ITextFramesIterator::ITextFramesIterator

(

)

Constructor.

Returns:

The new object.

ATE::ITextFramesIterator::ITextFramesIterator

(

const ITextFramesIterator &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sTextFramesIterator.

ATE::ITextFramesIterator::ITextFramesIterator

(

TextFramesIteratorRef

textframesiterator

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

textframesiterator

The C object.

Returns:

The new C++ object.

ATE::ITextFramesIterator::~ITextFramesIterator

(

)

[virtual]

Destructor.

References ATE::sTextFramesIterator.

ATE::ITextFramesIterator::ITextFramesIterator

(

const ITextRange &

range

)

Constructor.

Creates an iterator for the text frames contained in a text range.

Parameters:

range

The text range object.

Returns:

The new iterator object.

References ATE::ITextRange::GetRef(), ATE::sTextFramesIterator, and ATE::Throw_ATE_Exception().

---

Member Function Documentation

TextFramesIteratorRef ATE::ITextFramesIterator::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::ITextFramesIterator::IsDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if no more members remain in the set.

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

bool ATE::ITextFramesIterator::IsEmpty

(

)

const

Reports whether the set is empty.

Returns:

True if the set is empty.

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

bool ATE::ITextFramesIterator::IsNotDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::ITextFramesIterator::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sTextFramesIterator.

ITextFrame ATE::ITextFramesIterator::Item

(

)

const

Retrieves the current text frame.

Returns:

The text frame object.

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

void ATE::ITextFramesIterator::Next

(

)

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

Returns:

Nothing.

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

bool ATE::ITextFramesIterator::operator!=

(

const ITextFramesIterator &

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.

ITextFramesIterator & ATE::ITextFramesIterator::operator=

(

const ITextFramesIterator &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sTextFramesIterator.

bool ATE::ITextFramesIterator::operator==

(

const ITextFramesIterator &

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.

void ATE::ITextFramesIterator::Previous

(

)

Decrements the current position in the set.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp