ATE::IParagraphsIterator Class Reference

This class allows you to iterate through a set of paragraphs contained in a set of story objects or text ranges. More...

#include <IText.h>

List of all members.

Public Member Functions
	IParagraphsIterator ()
	Constructor.
	IParagraphsIterator (const IParagraphsIterator &src)
	Copy constructor.
IParagraphsIterator &	operator= (const IParagraphsIterator &rhs)
	Assignment operator.
bool	operator== (const IParagraphsIterator &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IParagraphsIterator &rhs) const
	Comparison operator tests for inequality.
	IParagraphsIterator (ParagraphsIteratorRef paragraphsiterator)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IParagraphsIterator ()
	Destructor.
ParagraphsIteratorRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
	IParagraphsIterator (ITextRanges ranges, Direction direction=kForward)
	Constructor.
bool	IsDone () const
	Reports whether the end of the set has been reached.
bool	IsNotDone () 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 this set in the iterator's current direction.
IParagraph	Item ()
	Retrieves the current paragraph.

---

Detailed Description

This class allows you to iterate through a set of paragraphs contained in a set of story objects or text ranges.

Retrieve the iteration object with IStories::GetParagraphsIterator(), or create one from a set of text ranges (ITextRanges). Use it to access the IParagraph objects in the document's text.

---

Constructor & Destructor Documentation

ATE::IParagraphsIterator::IParagraphsIterator

(

)

Constructor.

Returns:

The new object.

ATE::IParagraphsIterator::IParagraphsIterator

(

const IParagraphsIterator &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sParagraphsIterator.

ATE::IParagraphsIterator::IParagraphsIterator

(

ParagraphsIteratorRef

paragraphsiterator

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

paragraphsiterator

The C object.

Returns:

The new C++ object.

ATE::IParagraphsIterator::~IParagraphsIterator

(

)

[virtual]

Destructor.

References ATE::sParagraphsIterator.

ATE::IParagraphsIterator::IParagraphsIterator	(	ITextRanges	ranges,
		Direction	direction = kForward
	)

Constructor.

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

Parameters:

	ranges	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::sParagraphsIterator, and ATE::Throw_ATE_Exception().

---

Member Function Documentation

ParagraphsIteratorRef ATE::IParagraphsIterator::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::IParagraphsIterator::IsDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::IParagraphsIterator::IsEmpty

(

)

const

Reports whether the set is empty.

Returns:

True if the set is empty.

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

bool ATE::IParagraphsIterator::IsNotDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if no more members remain in the set.

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

bool ATE::IParagraphsIterator::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sParagraphsIterator.

IParagraph ATE::IParagraphsIterator::Item

(

)

Retrieves the current paragraph.

Returns:

The paragraph object.

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

void ATE::IParagraphsIterator::MoveToFirst

(

)

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

Returns:

Nothing.

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

void ATE::IParagraphsIterator::MoveToLast

(

)

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

Returns:

Nothing.

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

void ATE::IParagraphsIterator::Next

(

)

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

Returns:

Nothing.

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

bool ATE::IParagraphsIterator::operator!=

(

const IParagraphsIterator &

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.

IParagraphsIterator & ATE::IParagraphsIterator::operator=

(

const IParagraphsIterator &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sParagraphsIterator.

bool ATE::IParagraphsIterator::operator==

(

const IParagraphsIterator &

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