ATE::ITabStopsIterator Class Reference

This class allows you to iterate through a set of tab stops. More...

#include <IText.h>

List of all members.

Public Member Functions
	ITabStopsIterator ()
	Constructor.
	ITabStopsIterator (const ITabStopsIterator &src)
	Copy constructor.
ITabStopsIterator &	operator= (const ITabStopsIterator &rhs)
	Assignment operator.
bool	operator== (const ITabStopsIterator &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ITabStopsIterator &rhs) const
	Comparison operator tests for inequality.
	ITabStopsIterator (TabStopsIteratorRef tabstopsiterator)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ITabStopsIterator ()
	Destructor.
TabStopsIteratorRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
	ITabStopsIterator (ITabStops tabStops, 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 ()
	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.
ITabStop	Item () const
	Retrieves the current tab stop.

---

Detailed Description

This class allows you to iterate through a set of tab stops.

Create the iterator object from a ITabStops object. Use it to access the ITabStop objects in the collection.

---

Constructor & Destructor Documentation

ATE::ITabStopsIterator::ITabStopsIterator

(

)

Constructor.

Returns:

The new object.

ATE::ITabStopsIterator::ITabStopsIterator

(

const ITabStopsIterator &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sTabStopsIterator.

ATE::ITabStopsIterator::ITabStopsIterator

(

TabStopsIteratorRef

tabstopsiterator

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

tabstopsiterator

The C object.

Returns:

The new C++ object.

ATE::ITabStopsIterator::~ITabStopsIterator

(

)

[virtual]

Destructor.

References ATE::sTabStopsIterator.

ATE::ITabStopsIterator::ITabStopsIterator	(	ITabStops	tabStops,
		Direction	direction = kForward
	)

Constructor.

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

Parameters:

	tabStops	The tab stops set object.
	direction	Optional. The order of iteration. Default is first-to-last.

Returns:

The new iterator object.

References ATE::ITabStops::GetRef(), ATE::sTabStopsIterator, and ATE::Throw_ATE_Exception().

---

Member Function Documentation

TabStopsIteratorRef ATE::ITabStopsIterator::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::ITabStopsIterator::IsDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if no more members remain in the set.

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

bool ATE::ITabStopsIterator::IsEmpty

(

)

Reports whether the set is empty.

Returns:

True if the set is empty.

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

bool ATE::ITabStopsIterator::IsNotDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::ITabStopsIterator::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sTabStopsIterator.

ITabStop ATE::ITabStopsIterator::Item

(

)

const

Retrieves the current tab stop.

Returns:

The tab stop object.

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

void ATE::ITabStopsIterator::MoveToFirst

(

)

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

Returns:

Nothing.

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

void ATE::ITabStopsIterator::MoveToLast

(

)

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

Returns:

Nothing.

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

void ATE::ITabStopsIterator::Next

(

)

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

Returns:

Nothing.

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

bool ATE::ITabStopsIterator::operator!=

(

const ITabStopsIterator &

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.

ITabStopsIterator & ATE::ITabStopsIterator::operator=

(

const ITabStopsIterator &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sTabStopsIterator.

bool ATE::ITabStopsIterator::operator==

(

const ITabStopsIterator &

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