ATE::IGlyphsIterator Class Reference

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

#include <IText.h>

List of all members.

Public Member Functions
	IGlyphsIterator ()
	Constructor.
	IGlyphsIterator (const IGlyphsIterator &src)
	Copy constructor.
IGlyphsIterator &	operator= (const IGlyphsIterator &rhs)
	Assignment operator.
bool	operator== (const IGlyphsIterator &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IGlyphsIterator &rhs) const
	Comparison operator tests for inequality.
	IGlyphsIterator (GlyphsIteratorRef glyphsiterator)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IGlyphsIterator ()
	Destructor.
GlyphsIteratorRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
	IGlyphsIterator (IGlyphs glyphs, 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.
IGlyph	GetFirst ()
	Retrieves the first member in this set.
IGlyph	GetLast ()
	Retrieves the last member in this set.
IGlyph	GetNext ()
	Retrieves the next member in this set in the iterator's current direction.
IGlyph	Item () const
	Retrieves the current glyph.
void	Next ()
	Increments the current position in this set in the iterator's current direction.
void	Previous ()
	Decrements the current position in this set.

---

Detailed Description

This class enables you to iterate through a set of.glyphs.

See also:

IGlyphs

---

Constructor & Destructor Documentation

ATE::IGlyphsIterator::IGlyphsIterator

(

)

Constructor.

Returns:

The new object.

ATE::IGlyphsIterator::IGlyphsIterator

(

const IGlyphsIterator &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sGlyphsIterator.

ATE::IGlyphsIterator::IGlyphsIterator

(

GlyphsIteratorRef

glyphsiterator

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

glyphsiterator

The C object.

Returns:

The new C++ object.

ATE::IGlyphsIterator::~IGlyphsIterator

(

)

[virtual]

Destructor.

References ATE::sGlyphsIterator.

ATE::IGlyphsIterator::IGlyphsIterator	(	IGlyphs	glyphs,
		Direction	direction = kForward
	)

Constructor.

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

Parameters:

	glyphs	The glyph set object.
	direction	Optional. The order of iteration. Default is first-to-last.

Returns:

The new iterator object.

References ATE::IGlyphs::GetRef(), ATE::sGlyphsIterator, and ATE::Throw_ATE_Exception().

---

Member Function Documentation

IGlyph ATE::IGlyphsIterator::GetFirst

(

)

Retrieves the first member in this set.

Returns:

The glyph object.

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

IGlyph ATE::IGlyphsIterator::GetLast

(

)

Retrieves the last member in this set.

Returns:

The glyph object.

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

IGlyph ATE::IGlyphsIterator::GetNext

(

)

Retrieves the next member in this set in the iterator's current direction.

Returns:

The glyph object.

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

GlyphsIteratorRef ATE::IGlyphsIterator::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::IGlyphsIterator::IsDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::IGlyphsIterator::IsEmpty

(

)

const

Reports whether the set is empty.

Returns:

True if the set is empty.

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

bool ATE::IGlyphsIterator::IsNotDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::IGlyphsIterator::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sGlyphsIterator.

IGlyph ATE::IGlyphsIterator::Item

(

)

const

Retrieves the current glyph.

Returns:

The glyph object.

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

void ATE::IGlyphsIterator::Next

(

)

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

Returns:

Nothing.

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

bool ATE::IGlyphsIterator::operator!=

(

const IGlyphsIterator &

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.

IGlyphsIterator & ATE::IGlyphsIterator::operator=

(

const IGlyphsIterator &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sGlyphsIterator.

bool ATE::IGlyphsIterator::operator==

(

const IGlyphsIterator &

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

(

)

Decrements the current position in this set.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp