ATE::IMojiKumi Class Reference

Encapsulates the MojiKumi characteristics of a character as a text resource. More...

#include <IText.h>

List of all members.

Public Member Functions
	IMojiKumi ()
	Constructor.
	IMojiKumi (const IMojiKumi &src)
	Copy constructor.
IMojiKumi &	operator= (const IMojiKumi &rhs)
	Assignment operator.
bool	operator== (const IMojiKumi &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IMojiKumi &rhs) const
	Comparison operator tests for inequality.
	IMojiKumi (MojiKumiRef mojikumi)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IMojiKumi ()
	Destructor.
MojiKumiRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetName (ATETextDOM::Unicode *name, ATETextDOM::Int32 maxLength) const
	Retrieves the name of this object.
ATETextDOM::Int32	GetNameSize () const
	Retrieves the number of characters in the name of this object.
void	SetName (const ATETextDOM::Unicode *name)
	Sets the name of this object.
bool	MatchesPredefinedResourceTag (ATE::MojikumiTablePredefinedTag tag) const
	Reports whether this object matches a predefined tag in the MojiKumi table.
void	GetEntry (ATETextDOM::Int32 index, ATETextDOM::Float *minExpansion, ATETextDOM::Float *maxExpansion, ATETextDOM::Float *desiredExpansion) const
	Retrieves a MojiKumi table entry from this object.
void	SetEntry (ATETextDOM::Int32 index, ATETextDOM::Real minExpansion, ATETextDOM::Real maxExpansion, ATETextDOM::Real desiredExpansion)
	Sets a MojiKumi table entry from this object.
bool	IsEquivalent (IMojiKumi rhsMojiKumi) const
	Reports whether this object is equivalent to another MojiKumi object.
bool	IsModified () const
	Reports whether the resource been modified since it became editable.
bool	IsPredefined () const
	Reports whether this is a predefined MojiKumi.
IMojiKumi	Duplicate () const
	Creates a new object by duplicating the information in this one.

---

Detailed Description

Encapsulates the MojiKumi characteristics of a character as a text resource.

The methods allow you to add, access, and manipulate MojiKumi for use with the Adobe Text Engine (ATE). These objects are collected in an IMojiKumiSet.

---

Constructor & Destructor Documentation

ATE::IMojiKumi::IMojiKumi

(

)

Constructor.

Returns:

The new object.

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

Referenced by Duplicate().

ATE::IMojiKumi::IMojiKumi

(

const IMojiKumi &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sMojiKumi.

ATE::IMojiKumi::IMojiKumi

(

MojiKumiRef

mojikumi

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

mojikumi

The C object.

Returns:

The new C++ object.

ATE::IMojiKumi::~IMojiKumi

(

)

[virtual]

Destructor.

References ATE::sMojiKumi.

---

Member Function Documentation

IMojiKumi ATE::IMojiKumi::Duplicate

(

)

const

Creates a new object by duplicating the information in this one.

Returns:

The new object

References IMojiKumi(), ATE::sMojiKumi, and ATE::Throw_ATE_Exception().

void ATE::IMojiKumi::GetEntry	(	ATETextDOM::Int32	index,
		ATETextDOM::Float *	minExpansion,
		ATETextDOM::Float *	maxExpansion,
		ATETextDOM::Float *	desiredExpansion
	)			const

Retrieves a MojiKumi table entry from this object.

Parameters:

	index	The 0-based position index for the entry.
	minExpansion	[out] A buffer in which to return the maximum expansion value.
	maxExpansion	[out] A buffer in which to return the minimum expansion value.
	desiredExpansion	[out] A buffer in which to return the desired expansion value.

Returns:

Nothing.

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

ATETextDOM::Int32 ATE::IMojiKumi::GetName	(	ATETextDOM::Unicode *	name,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the name of this object.

Parameters:

	name	[out] A Unicode string in which to return the name.
	maxLength	The number of characters in the buffer. Use GetNameSize() to determine the size needed.

Returns:

The number of characters written to the buffer.

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

ATETextDOM::Int32 ATE::IMojiKumi::GetNameSize

(

)

const

Retrieves the number of characters in the name of this object.

Use to determine the size of buffer to pass to GetName().

Returns:

The number of characters in the name.

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

MojiKumiRef ATE::IMojiKumi::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::IMojiKumiSet::Add(), ATE::IMojiKumiSet::Find(), IsEquivalent(), ATE::IMojiKumiSet::Replace(), and ATE::IParaFeatures::SetMojiKumi().

bool ATE::IMojiKumi::IsEquivalent

(

IMojiKumi

rhsMojiKumi

)

const

Reports whether this object is equivalent to another MojiKumi object.

Parameters:

rhsMojiKumi

The other MojiKumi object.

Returns:

True if the objects are equivalent.

References GetRef(), ATE::sMojiKumi, and ATE::Throw_ATE_Exception().

bool ATE::IMojiKumi::IsModified

(

)

const

Reports whether the resource been modified since it became editable.

Returns:

True if the resource has been modified.

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

bool ATE::IMojiKumi::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sMojiKumi.

bool ATE::IMojiKumi::IsPredefined

(

)

const

Reports whether this is a predefined MojiKumi.

Returns:

True if the MojiKumi is predefined, false if it is customized.

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

bool ATE::IMojiKumi::MatchesPredefinedResourceTag

(

ATE::MojikumiTablePredefinedTag

tag

)

const

Reports whether this object matches a predefined tag in the MojiKumi table.

Parameters:

tag

The tag object.

Returns:

True if this object matches the tag.

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

bool ATE::IMojiKumi::operator!=

(

const IMojiKumi &

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.

IMojiKumi & ATE::IMojiKumi::operator=

(

const IMojiKumi &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sMojiKumi.

bool ATE::IMojiKumi::operator==

(

const IMojiKumi &

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.

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

void ATE::IMojiKumi::SetEntry	(	ATETextDOM::Int32	index,
		ATETextDOM::Real	minExpansion,
		ATETextDOM::Real	maxExpansion,
		ATETextDOM::Real	desiredExpansion
	)

Sets a MojiKumi table entry from this object.

Parameters:

	index	The 0-based position index for the entry.
	minExpansion	The new maximum expansion value.
	maxExpansion	The new minimum expansion value.
	desiredExpansion	The new desired expansion value.

Returns:

Nothing.

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

void ATE::IMojiKumi::SetName

(

const ATETextDOM::Unicode *

name

)

Sets the name of this object.

Parameters:

name

A Unicode string containing the new name.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp