ATE::ICompFontClass Class Reference

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

#include <IText.h>

List of all members.

Public Member Functions
	ICompFontClass ()
	Constructor.
	ICompFontClass (const ICompFontClass &src)
	Copy constructor.
ICompFontClass &	operator= (const ICompFontClass &rhs)
	Assignment operator.
bool	operator== (const ICompFontClass &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ICompFontClass &rhs) const
	Comparison operator tests for inequality.
	ICompFontClass (CompFontClassRef compfontclass)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ICompFontClass ()
	Destructor.
CompFontClassRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
void	GetNativeName (ATETextDOM::Unicode *name, ATETextDOM::Int32 maxLength) const
	Retrieves the platform-specific name of this font class.
void	SetNativeName (const ATETextDOM::Unicode *name)
	Sets the platform-specific name of this font.
ATETextDOM::Int32	GetCodes (ATETextDOM::Unicode *codes, ATETextDOM::Int32 maxLength) const
	Retrieves the Unicode character codes that belong to this class.
ATETextDOM::Int32	SetCodes (const ATETextDOM::Unicode *codes)
	Sets the Unicode character codes that belong to this class.
ICompFontClass	Duplicate () const
	Duplicates this font class.
ATETextDOM::Int32	GetCharacterCount () const
	Retrieves the number of characters in this font class.
CompositeFontClassType	GetClassType () const
	Retrieves the type of this font class.
bool	IsCodeInClass (ATETextDOM::Unicode code) const
	Reports whether a Unicode character is in this font class.
bool	IsEditable () const
	Reports whether the resource is currently editable.
bool	IsCustomOverride () const
	Reports whether this is a custom override class or predefined class.
bool	IsModified () const
	Reports whether the resource been modified since it became editable.
bool	VerifyState () const
	Reports whether the resource is in a valid state, either editable or committed.

---

Detailed Description

Encapsulates a font character class as a text resource.

The methods allow you to add, access, and manipulate font classes for use with the Adobe Text Engine (ATE). A font character class contains a collection of Unicode characters.

---

Constructor & Destructor Documentation

ATE::ICompFontClass::ICompFontClass

(

)

Constructor.

Returns:

The new object.

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

Referenced by Duplicate().

ATE::ICompFontClass::ICompFontClass

(

const ICompFontClass &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sCompFontClass.

ATE::ICompFontClass::ICompFontClass

(

CompFontClassRef

compfontclass

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

compfontclass

The C object.

Returns:

The new C++ object.

ATE::ICompFontClass::~ICompFontClass

(

)

[virtual]

Destructor.

References ATE::sCompFontClass.

---

Member Function Documentation

ICompFontClass ATE::ICompFontClass::Duplicate

(

)

const

Duplicates this font class.

Returns:

The new font class object.

References ICompFontClass(), ATE::sCompFontClass, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICompFontClass::GetCharacterCount

(

)

const

Retrieves the number of characters in this font class.

Returns:

The number of characters.

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

CompositeFontClassType ATE::ICompFontClass::GetClassType

(

)

const

Retrieves the type of this font class.

Returns:

The class type constant.

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

ATETextDOM::Int32 ATE::ICompFontClass::GetCodes	(	ATETextDOM::Unicode *	codes,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the Unicode character codes that belong to this class.

Parameters:

	codes	A buffer in which to return the character codes.
	maxLength	The number of characters in the passed buffer. The return string (including the terminating 0) is truncated to this length if necessary.

Returns:

The number of character codes written to the buffer, including the terminating 0.

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

void ATE::ICompFontClass::GetNativeName	(	ATETextDOM::Unicode *	name,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the platform-specific name of this font class.

Parameters:

	name	A buffer in which to return the name string.
	maxLength	The number of characters in the passed buffer. The name is truncated to this length if necessary.

Returns:

Nothing.

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

CompFontClassRef ATE::ICompFontClass::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::ICompFontClassSet::Find(), and ATE::ICompFontComponent::SetClass().

bool ATE::ICompFontClass::IsCodeInClass

(

ATETextDOM::Unicode

code

)

const

Reports whether a Unicode character is in this font class.

Parameters:

code

The character code.

Returns:

True if the code is part of this class.

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

bool ATE::ICompFontClass::IsCustomOverride

(

)

const

Reports whether this is a custom override class or predefined class.

Returns:

True if this is a custom override class, false if it is a predefined class.

Note:

Predefined classes are never editable.

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

bool ATE::ICompFontClass::IsEditable

(

)

const

Reports whether the resource is currently editable.

Returns:

True if the resource is editable.

Note:

Predefined classes are never editable.

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

bool ATE::ICompFontClass::IsModified

(

)

const

Reports whether the resource been modified since it became editable.

Returns:

True if the resource has been modified.

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

bool ATE::ICompFontClass::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sCompFontClass.

bool ATE::ICompFontClass::operator!=

(

const ICompFontClass &

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.

ICompFontClass & ATE::ICompFontClass::operator=

(

const ICompFontClass &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sCompFontClass.

bool ATE::ICompFontClass::operator==

(

const ICompFontClass &

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.

ATETextDOM::Int32 ATE::ICompFontClass::SetCodes

(

const ATETextDOM::Unicode *

codes

)

Sets the Unicode character codes that belong to this class.

Parameters:

codes

A buffer containing the new Unicode character codes.

Returns:

The character code count, not include the terminating 0.

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

void ATE::ICompFontClass::SetNativeName

(

const ATETextDOM::Unicode *

name

)

Sets the platform-specific name of this font.

Parameters:

name

The new name string.

Returns:

Nothing.

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

bool ATE::ICompFontClass::VerifyState

(

)

const

Reports whether the resource is in a valid state, either editable or committed.

Returns:

True if the resource is in a valid state.

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

---

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

• IText.h
• IText.cpp