ATE::IGlyphs Class Reference

Encapsulates a set of glyphs as a text resource. More...

#include <IText.h>

List of all members.

Public Member Functions
	IGlyphs ()
	Constructor.
	IGlyphs (const IGlyphs &src)
	Copy constructor.
IGlyphs &	operator= (const IGlyphs &rhs)
	Assignment operator.
bool	operator== (const IGlyphs &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IGlyphs &rhs) const
	Comparison operator tests for inequality.
	IGlyphs (GlyphsRef glyphs)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IGlyphs ()
	Destructor.
GlyphsRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetSize ()
	Retrieves the number of members of this set.
IGlyph	GetFirst ()
	Retrieves the first member of this set.
IGlyph	GetLast ()
	Retrieves the last member of this set.
ITextRanges	GetTextRanges () const
	Retrieves the set of text ranges that use this glyph set.
ITextRanges	GetTextSelection () const
	Retrieves the set of selected text ranges that use this glyph set.
IParagraphsIterator	GetParagraphsIterator () const
	Creates an iterator object for all paragraphs in the current document that use this glyph set.
ITextRunsIterator	GetTextRunsIterator () const
	Creates an iterator object for all text runs in the current document that use this glyph set.
IWordsIterator	GetWordsIterator () const
	Creates an iterator object for all words in the current document that use this glyph set.
void	Add (const IGlyph &glyph)
	Appends a glyph to this set.
IGlyph	Item (ATETextDOM::Int32 nIndex) const
	Retrieves a member of this set by position index.
void	RemoveAll ()
	Removes all members from the set.
void	Remove (ATETextDOM::Int32 nIndex)
	Removes a member from the set.

---

Detailed Description

Encapsulates a set of glyphs as a text resource.

A glyph set contains a collection of IGlyph objects. Use an IGlyphsIterator object to iterate through the set.

---

Constructor & Destructor Documentation

ATE::IGlyphs::IGlyphs

(

)

Constructor.

Returns:

The new object.

ATE::IGlyphs::IGlyphs

(

const IGlyphs &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sGlyphs.

ATE::IGlyphs::IGlyphs

(

GlyphsRef

glyphs

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

glyphs

The C object.

Returns:

The new C++ object.

ATE::IGlyphs::~IGlyphs

(

)

[virtual]

Destructor.

References ATE::sGlyphs.

---

Member Function Documentation

void ATE::IGlyphs::Add

(

const IGlyph &

glyph

)

Appends a glyph to this set.

Parameters:

glyph

The glyph object.

Returns:

The 0-based position index of the successfully added object, or the current index of this object if it is already in the set, or -1 if the object was not in the set and could not be appended.

References ATE::IGlyph::GetRef(), ATE::sGlyphs, and ATE::Throw_ATE_Exception().

IGlyph ATE::IGlyphs::GetFirst

(

)

Retrieves the first member of this set.

Returns:

The member value.

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

IGlyph ATE::IGlyphs::GetLast

(

)

Retrieves the last member of this set.

Returns:

The member value.

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

IParagraphsIterator ATE::IGlyphs::GetParagraphsIterator

(

)

const

Creates an iterator object for all paragraphs in the current document that use this glyph set.

Returns:

The iterator object.

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

GlyphsRef ATE::IGlyphs::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::IGlyphsIterator::IGlyphsIterator().

ATETextDOM::Int32 ATE::IGlyphs::GetSize

(

)

Retrieves the number of members of this set.

Returns:

The number of members.

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

ITextRanges ATE::IGlyphs::GetTextRanges

(

)

const

Retrieves the set of text ranges that use this glyph set.

Returns:

The text ranges set objet.

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

ITextRunsIterator ATE::IGlyphs::GetTextRunsIterator

(

)

const

Creates an iterator object for all text runs in the current document that use this glyph set.

Returns:

The iterator object.

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

ITextRanges ATE::IGlyphs::GetTextSelection

(

)

const

Retrieves the set of selected text ranges that use this glyph set.

Returns:

The text ranges set objet.

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

IWordsIterator ATE::IGlyphs::GetWordsIterator

(

)

const

Creates an iterator object for all words in the current document that use this glyph set.

Returns:

The iterator object.

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

bool ATE::IGlyphs::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sGlyphs.

IGlyph ATE::IGlyphs::Item

(

ATETextDOM::Int32

nIndex

)

const

Retrieves a member of this set by position index.

Use with GetSize() to iterate through members.

Parameters:

nIndex

The 0-based position index.

Returns:

The member object.

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

bool ATE::IGlyphs::operator!=

(

const IGlyphs &

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.

IGlyphs & ATE::IGlyphs::operator=

(

const IGlyphs &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sGlyphs.

bool ATE::IGlyphs::operator==

(

const IGlyphs &

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::IGlyphs::Remove

(

ATETextDOM::Int32

nIndex

)

Removes a member from the set.

Parameters:

nIndex

The 0-based position index of the member to remove.

Returns:

Nothing.

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

void ATE::IGlyphs::RemoveAll

(

)

Removes all members from the set.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp