ATE::ICharStylesIterator Class Reference

This class enables you to iterate through a set of character styles. More...

#include <IText.h>

List of all members.

Public Member Functions
	ICharStylesIterator ()
	Constructor.
	ICharStylesIterator (const ICharStylesIterator &src)
	Copy constructor.
ICharStylesIterator &	operator= (const ICharStylesIterator &rhs)
	Assignment operator.
bool	operator== (const ICharStylesIterator &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ICharStylesIterator &rhs) const
	Comparison operator tests for inequality.
	ICharStylesIterator (CharStylesIteratorRef charstylesiterator)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ICharStylesIterator ()
	Destructor.
CharStylesIteratorRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
	ICharStylesIterator (ICharStyles pStyles, 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 in the set.
void	MoveToLast ()
	Sets the current position to the last member in the set.
void	Next ()
	Increments the current position in the set in the iterator's current direction.
void	Previous ()
	Decrements the current position in the set.
ICharStyle	Item () const
	Retrieves the current character style.

---

Detailed Description

This class enables you to iterate through a set of character styles.

See also:

ICharStyles

---

Constructor & Destructor Documentation

ATE::ICharStylesIterator::ICharStylesIterator

(

)

Constructor.

Returns:

The new object.

ATE::ICharStylesIterator::ICharStylesIterator

(

const ICharStylesIterator &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sCharStylesIterator.

ATE::ICharStylesIterator::ICharStylesIterator

(

CharStylesIteratorRef

charstylesiterator

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

charstylesiterator

The C object.

Returns:

The new C++ object.

ATE::ICharStylesIterator::~ICharStylesIterator

(

)

[virtual]

Destructor.

References ATE::sCharStylesIterator.

ATE::ICharStylesIterator::ICharStylesIterator	(	ICharStyles	pStyles,
		Direction	direction = kForward
	)

Constructor.

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

Parameters:

	pStyles	The style set object.
	direction	Optional. The order of iteration. Default is first to last.

Returns:

The new iterator object.

References ATE::ICharStyles::GetRef(), ATE::sCharStylesIterator, and ATE::Throw_ATE_Exception().

---

Member Function Documentation

CharStylesIteratorRef ATE::ICharStylesIterator::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::ICharStylesIterator::IsDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::ICharStylesIterator::IsEmpty

(

)

const

Reports whether the set is empty.

Returns:

True if the set is empty.

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

bool ATE::ICharStylesIterator::IsNotDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::ICharStylesIterator::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sCharStylesIterator.

ICharStyle ATE::ICharStylesIterator::Item

(

)

const

Retrieves the current character style.

Returns:

The character style object.

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

void ATE::ICharStylesIterator::MoveToFirst

(

)

Sets the current position to the first member in the set.

Returns:

Nothing.

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

void ATE::ICharStylesIterator::MoveToLast

(

)

Sets the current position to the last member in the set.

Returns:

Nothing.

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

void ATE::ICharStylesIterator::Next

(

)

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

Returns:

Nothing.

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

bool ATE::ICharStylesIterator::operator!=

(

const ICharStylesIterator &

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.

ICharStylesIterator & ATE::ICharStylesIterator::operator=

(

const ICharStylesIterator &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sCharStylesIterator.

bool ATE::ICharStylesIterator::operator==

(

const ICharStylesIterator &

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

(

)

Decrements the current position in the set.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp