ATE::IGlyph Class Reference

Encapsulates a glyph as a text resource. More...

#include <IText.h>

List of all members.

Public Member Functions
	IGlyph ()
	Constructor.
	IGlyph (const IGlyph &src)
	Copy constructor.
IGlyph &	operator= (const IGlyph &rhs)
	Assignment operator.
bool	operator== (const IGlyph &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IGlyph &rhs) const
	Comparison operator tests for inequality.
	IGlyph (GlyphRef glyph)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IGlyph ()
	Destructor.
GlyphRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATEGlyphID	GetGlyphID () const
	Retrieves the unique identifier for this glyph.
IGlyphs	GetAlternateGlyphs () const
	Retrieves the set of alternates for this glyph.
void	GetOTFeatures (char **otFeatures, ATETextDOM::Int32 *otFeatureCount, ATETextDOM::Int32 **otFeatureIndex)
	Retrieves the OpenType feature of this glyph.

---

Detailed Description

Encapsulates a glyph as a text resource.

The methods allow you to add, access, and manipulate glyphs for use with the Adobe Text Engine (ATE).

---

Constructor & Destructor Documentation

ATE::IGlyph::IGlyph

(

)

Constructor.

Returns:

The new object.

ATE::IGlyph::IGlyph

(

const IGlyph &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sGlyph.

ATE::IGlyph::IGlyph

(

GlyphRef

glyph

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

glyph

The C object.

Returns:

The new C++ object.

ATE::IGlyph::~IGlyph

(

)

[virtual]

Destructor.

References ATE::sGlyph.

---

Member Function Documentation

IGlyphs ATE::IGlyph::GetAlternateGlyphs

(

)

const

Retrieves the set of alternates for this glyph.

Returns:

The alternate glyph set.

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

ATEGlyphID ATE::IGlyph::GetGlyphID

(

)

const

Retrieves the unique identifier for this glyph.

Returns:

The identifier.

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

void ATE::IGlyph::GetOTFeatures	(	char **	otFeatures,
		ATETextDOM::Int32 *	otFeatureCount,
		ATETextDOM::Int32 **	otFeatureIndex
	)

Retrieves the OpenType feature of this glyph.

Parameters:

	otFeatures	[out] A buffer in which to return the features string.
	otFeatureCount	[out] A buffer in which to return the number of features.
	otFeatureIndex	[out] A buffer in which to return the index into the feature string.

Returns:

Nothing.

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

GlyphRef ATE::IGlyph::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::IGlyphs::Add().

bool ATE::IGlyph::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sGlyph.

bool ATE::IGlyph::operator!=

(

const IGlyph &

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.

IGlyph & ATE::IGlyph::operator=

(

const IGlyph &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sGlyph.

bool ATE::IGlyph::operator==

(

const IGlyph &

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