ATE::ICompFontClassSet Class Reference

Encapsulates a font class set as a text resource. More...

#include <IText.h>

List of all members.

Public Member Functions
	ICompFontClassSet ()
	Constructor.
	ICompFontClassSet (const ICompFontClassSet &src)
	Copy constructor.
ICompFontClassSet &	operator= (const ICompFontClassSet &rhs)
	Assignment operator.
bool	operator== (const ICompFontClassSet &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ICompFontClassSet &rhs) const
	Comparison operator tests for inequality.
	ICompFontClassSet (CompFontClassSetRef compfontclassset)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ICompFontClassSet ()
	Destructor.
CompFontClassSetRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetSize () const
	Retrieves the number of members of this set.
ICompFontClass	GetFirst () const
	Retrieves the first member of this set.
ICompFontClass	GetLast () const
	Retrieves the last member of this set.
ICompFontClass	Item (ATETextDOM::Int32 nIndex) const
	Retrieves a member of this set by position index.
ATETextDOM::Int32	Find (ICompFontClass compFontClass) const
	Retrieves a specific font class from this set.
ATETextDOM::Int32	FindPredefined (CompositeFontClassType predefinedType) const
	Retrieves a specific predefined font class type from this set.

---

Detailed Description

Encapsulates a font class set as a text resource.

The methods allow you to add, access, and manipulate font class sets for use with the Adobe Text Engine (ATE). A font class set contains a collection of ICompFontClass objects.

---

Constructor & Destructor Documentation

ATE::ICompFontClassSet::ICompFontClassSet

(

)

Constructor.

Returns:

The new object.

ATE::ICompFontClassSet::ICompFontClassSet

(

const ICompFontClassSet &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sCompFontClassSet.

ATE::ICompFontClassSet::ICompFontClassSet

(

CompFontClassSetRef

compfontclassset

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

compfontclassset

The C object.

Returns:

The new C++ object.

ATE::ICompFontClassSet::~ICompFontClassSet

(

)

[virtual]

Destructor.

References ATE::sCompFontClassSet.

---

Member Function Documentation

ATETextDOM::Int32 ATE::ICompFontClassSet::Find

(

ICompFontClass

compFontClass

)

const

Retrieves a specific font class from this set.

Parameters:

compFontClass

The font class object.

Returns:

The index position of the object in this set, or -1 if the object is not in this set.

References ATE::ICompFontClass::GetRef(), ATE::sCompFontClassSet, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICompFontClassSet::FindPredefined

(

CompositeFontClassType

predefinedType

)

const

Retrieves a specific predefined font class type from this set.

Parameters:

predefinedType

The font class type.

Returns:

The index position of the type in this set, or -1 if the type is not in this set.

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

ICompFontClass ATE::ICompFontClassSet::GetFirst

(

)

const

Retrieves the first member of this set.

Returns:

The member object.

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

ICompFontClass ATE::ICompFontClassSet::GetLast

(

)

const

Retrieves the last member of this set.

Returns:

The member object.

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

CompFontClassSetRef ATE::ICompFontClassSet::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::ICompFontClassSet::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::ICompFontClassSet::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sCompFontClassSet.

ICompFontClass ATE::ICompFontClassSet::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::sCompFontClassSet, and ATE::Throw_ATE_Exception().

bool ATE::ICompFontClassSet::operator!=

(

const ICompFontClassSet &

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.

ICompFontClassSet & ATE::ICompFontClassSet::operator=

(

const ICompFontClassSet &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sCompFontClassSet.

bool ATE::ICompFontClassSet::operator==

(

const ICompFontClassSet &

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