ATE::ICompFontComponent Class Reference

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

#include <IText.h>

List of all members.

Public Member Functions
	ICompFontComponent ()
	Constructor.
	ICompFontComponent (const ICompFontComponent &src)
	Copy constructor.
ICompFontComponent &	operator= (const ICompFontComponent &rhs)
	Assignment operator.
bool	operator== (const ICompFontComponent &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ICompFontComponent &rhs) const
	Comparison operator tests for inequality.
	ICompFontComponent (CompFontComponentRef compfontcomponent)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ICompFontComponent ()
	Destructor.
CompFontComponentRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
	ICompFontComponent (ITextResources pResources)
	Constructor: Creates a font component from a text resources object.
ICompFontClass	GetClass () const
	Retrieves the font class to which this component belongs.
void	SetClass (ICompFontClass charClass)
	Sets the font character class to which this component belongs.
IFont	GetFont () const
	Retrieves the font to which this component belongs.
void	SetFont (IFont font)
	Sets the font to which this component belongs.
ATETextDOM::Real	GetSize () const
	Retrieves the point size of this component.
void	SetSize (ATETextDOM::Real size)
	Sets the point size of this component.
ATETextDOM::Real	GetBaseline () const
	Retrieves the baseline value of this component.
void	SetBaseline (ATETextDOM::Real baseline)
	Sets the baseline value of this component.
ATETextDOM::Real	GetHorizontalScale () const
	Retrieves the horizontal scaling factor of this component.
void	SetHorizontalScale (ATETextDOM::Real horizontalScale)
	Sets the horizontal scaling factor of this component.
ATETextDOM::Real	GetVerticalScale () const
	Retrieves the vertical scaling factor of this component.
void	SetVerticalScale (ATETextDOM::Real verticalScale)
	Sets the vertical scaling factor of this component.
bool	GetCenterGlyph () const
	Reports the centering state of this component.
void	SetCenterGlyph (bool centerglyph)
	Sets the centering state of this component.
bool	IsModified () const
	Reports whether the resource been modified since it became editable.

---

Detailed Description

Encapsulates a font component as a text resource.

The methods allow you to add, access, and manipulate font components for use with the Adobe Text Engine (ATE). Font components belong to ICompFont objects. See ICompFont::GetComponent()

---

Constructor & Destructor Documentation

ATE::ICompFontComponent::ICompFontComponent

(

)

Constructor.

Returns:

The new object.

ATE::ICompFontComponent::ICompFontComponent

(

const ICompFontComponent &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sCompFontComponent.

ATE::ICompFontComponent::ICompFontComponent

(

CompFontComponentRef

compfontcomponent

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

compfontcomponent

The C object.

Returns:

The new C++ object.

ATE::ICompFontComponent::~ICompFontComponent

(

)

[virtual]

Destructor.

References ATE::sCompFontComponent.

ATE::ICompFontComponent::ICompFontComponent

(

ITextResources

pResources

)

Constructor: Creates a font component from a text resources object.

Parameters:

pResources

The text resources object.

Returns:

The new object.

References ATE::ITextResources::GetRef(), ATE::sCompFontComponent, and ATE::Throw_ATE_Exception().

---

Member Function Documentation

ATETextDOM::Real ATE::ICompFontComponent::GetBaseline

(

)

const

Retrieves the baseline value of this component.

Returns:

The baseline value.

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

bool ATE::ICompFontComponent::GetCenterGlyph

(

)

const

Reports the centering state of this component.

Returns:

True if centering is on.

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

ICompFontClass ATE::ICompFontComponent::GetClass

(

)

const

Retrieves the font class to which this component belongs.

Returns:

The font class object.

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

IFont ATE::ICompFontComponent::GetFont

(

)

const

Retrieves the font to which this component belongs.

Returns:

The font object.

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

ATETextDOM::Real ATE::ICompFontComponent::GetHorizontalScale

(

)

const

Retrieves the horizontal scaling factor of this component.

Returns:

The horizontal scaling factor.

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

CompFontComponentRef ATE::ICompFontComponent::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::ICompFont::AddComponent(), ATE::ICompFont::Find(), and ATE::ICompFont::ReplaceComponent().

ATETextDOM::Real ATE::ICompFontComponent::GetSize

(

)

const

Retrieves the point size of this component.

Returns:

The point size.

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

ATETextDOM::Real ATE::ICompFontComponent::GetVerticalScale

(

)

const

Retrieves the vertical scaling factor of this component.

Returns:

The vertical scaling factor.

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

bool ATE::ICompFontComponent::IsModified

(

)

const

Reports whether the resource been modified since it became editable.

Returns:

True if the resource has been modified.

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

bool ATE::ICompFontComponent::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sCompFontComponent.

bool ATE::ICompFontComponent::operator!=

(

const ICompFontComponent &

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.

ICompFontComponent & ATE::ICompFontComponent::operator=

(

const ICompFontComponent &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sCompFontComponent.

bool ATE::ICompFontComponent::operator==

(

const ICompFontComponent &

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.

void ATE::ICompFontComponent::SetBaseline

(

ATETextDOM::Real

baseline

)

Sets the baseline value of this component.

Parameters:

baseline

The new baseline value.

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

void ATE::ICompFontComponent::SetCenterGlyph

(

bool

centerglyph

)

Sets the centering state of this component.

Parameters:

centerglyph

True to turn centering on, false to turn it off

Returns:

Nothing

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

void ATE::ICompFontComponent::SetClass

(

ICompFontClass

charClass

)

Sets the font character class to which this component belongs.

Parameters:

charClass

The font character class object.

Returns:

Nothing.

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

void ATE::ICompFontComponent::SetFont

(

IFont

font

)

Sets the font to which this component belongs.

Parameters:

font

The font object.

Returns:

Nothing.

References ATE::IFont::GetRef(), ATE::sCompFontComponent, and ATE::Throw_ATE_Exception().

void ATE::ICompFontComponent::SetHorizontalScale

(

ATETextDOM::Real

horizontalScale

)

Sets the horizontal scaling factor of this component.

Parameters:

horizontalScale

The new horizontal scaling factor.

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

void ATE::ICompFontComponent::SetSize

(

ATETextDOM::Real

size

)

Sets the point size of this component.

Parameters:

size

The new point size.

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

void ATE::ICompFontComponent::SetVerticalScale

(

ATETextDOM::Real

verticalScale

)

Sets the vertical scaling factor of this component.

Parameters:

verticalScale

The new vertical scaling factor.

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

---

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

• IText.h
• IText.cpp