ATE::ICompFontSet Class Reference

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

#include <IText.h>

List of all members.

Public Member Functions
	ICompFontSet ()
	Constructor.
	ICompFontSet (const ICompFontSet &src)
	Copy constructor.
ICompFontSet &	operator= (const ICompFontSet &rhs)
	Assignment operator.
bool	operator== (const ICompFontSet &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ICompFontSet &rhs) const
	Comparison operator tests for inequality.
	ICompFontSet (CompFontSetRef compfontset)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ICompFontSet ()
	Destructor.
CompFontSetRef	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.
ICompFont	GetFirst () const
	Retrieves the first member of this set.
ICompFont	GetLast () const
	Retrieves the last member of this set.
ICompFont	Item (ATETextDOM::Int32 nIndex) const
	Retrieves a member of this set by position index.
ATETextDOM::Int32	Find (ICompFont font) const
	Retrieves a specific font from this set.
bool	Remove (ATETextDOM::Int32 nIndex)
	Removes a member font from this font set.
ATETextDOM::Int32	Add (ICompFont font)
	Appends a font to this font set.
bool	Replace (ATETextDOM::Int32 nIndex, ICompFont newFont)
	Replaces a font in this set.
void	Update () const
	Updates this font set to reflect what is currently in the document font resource's font set.

---

Detailed Description

Encapsulates a composite font set as a text resource.

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

---

Constructor & Destructor Documentation

ATE::ICompFontSet::ICompFontSet

(

)

Constructor.

Returns:

The new object.

ATE::ICompFontSet::ICompFontSet

(

const ICompFontSet &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sCompFontSet.

ATE::ICompFontSet::ICompFontSet

(

CompFontSetRef

compfontset

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

compfontset

The C object.

Returns:

The new C++ object.

ATE::ICompFontSet::~ICompFontSet

(

)

[virtual]

Destructor.

References ATE::sCompFontSet.

---

Member Function Documentation

ATETextDOM::Int32 ATE::ICompFontSet::Add

(

ICompFont

font

)

Appends a font to this font set.

Parameters:

font

The font object.

Returns:

The 0-based position index of the successfully added font, or -1 if the font could not be appended.

References ATE::ICompFont::GetRef(), ATE::sCompFontSet, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICompFontSet::Find

(

ICompFont

font

)

const

Retrieves a specific font from this set.

Parameters:

font

The font object.

Returns:

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

References ATE::ICompFont::GetRef(), ATE::sCompFontSet, and ATE::Throw_ATE_Exception().

ICompFont ATE::ICompFontSet::GetFirst

(

)

const

Retrieves the first member of this set.

Returns:

The member object.

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

ICompFont ATE::ICompFontSet::GetLast

(

)

const

Retrieves the last member of this set.

Returns:

The member object.

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

CompFontSetRef ATE::ICompFontSet::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::ICompFontSet::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::ICompFontSet::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sCompFontSet.

ICompFont ATE::ICompFontSet::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::sCompFontSet, and ATE::Throw_ATE_Exception().

bool ATE::ICompFontSet::operator!=

(

const ICompFontSet &

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.

ICompFontSet & ATE::ICompFontSet::operator=

(

const ICompFontSet &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sCompFontSet.

bool ATE::ICompFontSet::operator==

(

const ICompFontSet &

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.

bool ATE::ICompFontSet::Remove

(

ATETextDOM::Int32

nIndex

)

Removes a member font from this font set.

Parameters:

nIndex

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

Returns:

True if a font was successfully removed.

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

bool ATE::ICompFontSet::Replace	(	ATETextDOM::Int32	nIndex,
		ICompFont	newFont
	)

Replaces a font in this set.

Parameters:

	nIndex	The 0-based position index of the font to replace.
	newFont	The replacement font object.

Returns:

True if a font was successfully replaced.

References ATE::ICompFont::GetRef(), ATE::sCompFontSet, and ATE::Throw_ATE_Exception().

void ATE::ICompFontSet::Update

(

)

const

Updates this font set to reflect what is currently in the document font resource's font set.

This can invalidate previously saved font indices.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp