ATE::IParaStylesIterator Class Reference

This class allows you to iterate through a set of paragraph styles. More...

#include <IText.h>

List of all members.

Public Member Functions
	IParaStylesIterator ()
	Constructor.
	IParaStylesIterator (const IParaStylesIterator &src)
	Copy constructor.
IParaStylesIterator &	operator= (const IParaStylesIterator &rhs)
	Assignment operator.
bool	operator== (const IParaStylesIterator &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IParaStylesIterator &rhs) const
	Comparison operator tests for inequality.
	IParaStylesIterator (ParaStylesIteratorRef parastylesiterator)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IParaStylesIterator ()
	Destructor.
ParaStylesIteratorRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
	IParaStylesIterator (IParaStyles paraStyles, Direction direction=kForward)
	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	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.
void	Previous ()
	Decrements the current position in this set.
IParaStyle	Item () const
	Retrieves the current paragraph style.

---

Detailed Description

This class allows you to iterate through a set of paragraph styles.

Create the iterator object from a IParaStyles object. Use it to access the IParaStyle objects in the collection.

---

Constructor & Destructor Documentation

ATE::IParaStylesIterator::IParaStylesIterator

(

)

Constructor.

Returns:

The new object.

ATE::IParaStylesIterator::IParaStylesIterator

(

const IParaStylesIterator &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sParaStylesIterator.

ATE::IParaStylesIterator::IParaStylesIterator

(

ParaStylesIteratorRef

parastylesiterator

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

parastylesiterator

The C object.

Returns:

The new C++ object.

ATE::IParaStylesIterator::~IParaStylesIterator

(

)

[virtual]

Destructor.

References ATE::sParaStylesIterator.

ATE::IParaStylesIterator::IParaStylesIterator	(	IParaStyles	paraStyles,
		Direction	direction = kForward
	)

Constructor.

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

Parameters:

	paraStyles	The paragraph style set object.
	direction	Optional. The order of iteration. Default is first-to-last.

Returns:

The new iterator object.

References ATE::IParaStyles::GetRef(), ATE::sParaStylesIterator, and ATE::Throw_ATE_Exception().

---

Member Function Documentation

ParaStylesIteratorRef ATE::IParaStylesIterator::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::IParaStylesIterator::IsDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if no more members remain in the set.

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

bool ATE::IParaStylesIterator::IsEmpty

(

)

const

Reports whether the set is empty.

Returns:

True if the set is empty.

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

bool ATE::IParaStylesIterator::IsNotDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::IParaStylesIterator::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sParaStylesIterator.

IParaStyle ATE::IParaStylesIterator::Item

(

)

const

Retrieves the current paragraph style.

Returns:

The paragraph style object.

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

void ATE::IParaStylesIterator::MoveToFirst

(

)

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

Returns:

Nothing.

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

void ATE::IParaStylesIterator::MoveToLast

(

)

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

Returns:

Nothing.

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

void ATE::IParaStylesIterator::Next

(

)

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

Returns:

Nothing.

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

bool ATE::IParaStylesIterator::operator!=

(

const IParaStylesIterator &

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.

IParaStylesIterator & ATE::IParaStylesIterator::operator=

(

const IParaStylesIterator &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sParaStylesIterator.

bool ATE::IParaStylesIterator::operator==

(

const IParaStylesIterator &

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::IParaStylesIterator::Previous

(

)

Decrements the current position in this set.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp