ATE::IFont Class Reference

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

#include <IText.h>

List of all members.

Public Member Functions
	IFont ()
	Constructor.
	IFont (const IFont &src)
	Copy constructor.
IFont &	operator= (const IFont &rhs)
	Assignment operator.
bool	operator== (const IFont &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IFont &rhs) const
	Comparison operator tests for inequality.
	IFont (FontRef font)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IFont ()
	Destructor.
FontRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
bool	IsCoolTypeTechnology () const
	Reports whether this is a CoolType font.
bool	IsVerticalRomanGlyphsOnSideByDefault (bool withItalics, StyleRunAlignment characterAlignment) const
	Reports whether Roman glyphs in this font are sideways by default for a specified character alignment.
void *	GetCTFontDict ()
	Retrieves a pointer to the CT font dictionary for this font.

---

Detailed Description

Encapsulates a font as a text resource.

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

---

Constructor & Destructor Documentation

ATE::IFont::IFont

(

)

Constructor.

Returns:

The new object.

ATE::IFont::IFont

(

const IFont &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sFont.

ATE::IFont::IFont

(

FontRef

font

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

font

The C object.

Returns:

The new C++ object.

ATE::IFont::~IFont

(

)

[virtual]

Destructor.

References ATE::sFont.

---

Member Function Documentation

void * ATE::IFont::GetCTFontDict

(

)

Retrieves a pointer to the CT font dictionary for this font.

Returns:

A pointer to the dictionary.

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

FontRef ATE::IFont::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::ICharFeatures::SetFont(), and ATE::ICompFontComponent::SetFont().

bool ATE::IFont::IsCoolTypeTechnology

(

)

const

Reports whether this is a CoolType font.

Returns:

True if this is a CoolType font.

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

bool ATE::IFont::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sFont.

bool ATE::IFont::IsVerticalRomanGlyphsOnSideByDefault	(	bool	withItalics,
		StyleRunAlignment	characterAlignment
	)			const

Reports whether Roman glyphs in this font are sideways by default for a specified character alignment.

Parameters:

	withItalics	True to report the default for italics.
	characterAlignment	The style-run alignment constant for which to get the default.

Returns:

True if the default for Roman glyphs is sideways.

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

bool ATE::IFont::operator!=

(

const IFont &

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.

IFont & ATE::IFont::operator=

(

const IFont &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sFont.

bool ATE::IFont::operator==

(

const IFont &

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