ATE::IGlyphRunsIterator Class Reference

This object enables you to iterate through the set of glyph runs in the current document. More...

#include <IText.h>

List of all members.

Public Member Functions
	IGlyphRunsIterator ()
	Constructor.
	IGlyphRunsIterator (const IGlyphRunsIterator &src)
	Copy constructor.
IGlyphRunsIterator &	operator= (const IGlyphRunsIterator &rhs)
	Assignment operator.
bool	operator== (const IGlyphRunsIterator &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IGlyphRunsIterator &rhs) const
	Comparison operator tests for inequality.
	IGlyphRunsIterator (GlyphRunsIteratorRef glyphrunsiterator)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IGlyphRunsIterator ()
	Destructor.
GlyphRunsIteratorRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
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.
void	Next ()
	Increments the current position in the set in the iterator's current direction.
IGlyphRun	Item () const
	Retrieves the current glyph run.

---

Detailed Description

This object enables you to iterate through the set of glyph runs in the current document.

See also:

IGlyphRun.

---

Constructor & Destructor Documentation

ATE::IGlyphRunsIterator::IGlyphRunsIterator

(

)

Constructor.

Returns:

The new object.

ATE::IGlyphRunsIterator::IGlyphRunsIterator

(

const IGlyphRunsIterator &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sGlyphRunsIterator.

ATE::IGlyphRunsIterator::IGlyphRunsIterator

(

GlyphRunsIteratorRef

glyphrunsiterator

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

glyphrunsiterator

The C object.

Returns:

The new C++ object.

ATE::IGlyphRunsIterator::~IGlyphRunsIterator

(

)

[virtual]

Destructor.

References ATE::sGlyphRunsIterator.

---

Member Function Documentation

GlyphRunsIteratorRef ATE::IGlyphRunsIterator::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::IGlyphRunsIterator::IsDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if no more members remain in the set.

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

bool ATE::IGlyphRunsIterator::IsNotDone

(

)

const

Reports whether the end of the set has been reached.

Returns:

True if more members remain in the set.

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

bool ATE::IGlyphRunsIterator::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sGlyphRunsIterator.

IGlyphRun ATE::IGlyphRunsIterator::Item

(

)

const

Retrieves the current glyph run.

Returns:

The glyph run object.

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

void ATE::IGlyphRunsIterator::Next

(

)

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

Returns:

Nothing.

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

bool ATE::IGlyphRunsIterator::operator!=

(

const IGlyphRunsIterator &

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.

IGlyphRunsIterator & ATE::IGlyphRunsIterator::operator=

(

const IGlyphRunsIterator &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sGlyphRunsIterator.

bool ATE::IGlyphRunsIterator::operator==

(

const IGlyphRunsIterator &

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