ATE::IMojiKumiSet Class Reference

Encapsulates a MojiKumi set as a text resource. More...

#include <IText.h>

List of all members.

Public Member Functions
	IMojiKumiSet ()
	Constructor.
	IMojiKumiSet (const IMojiKumiSet &src)
	Copy constructor.
IMojiKumiSet &	operator= (const IMojiKumiSet &rhs)
	Assignment operator.
bool	operator== (const IMojiKumiSet &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IMojiKumiSet &rhs) const
	Comparison operator tests for inequality.
	IMojiKumiSet (MojiKumiSetRef mojikumiset)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IMojiKumiSet ()
	Destructor.
MojiKumiSetRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetSize ()
	Retrieves the number of members of this set.
IMojiKumi	GetFirst ()
	Retrieves the first member of this set.
IMojiKumi	GetLast ()
	Retrieves the last member of this set.
IMojiKumi	Item (ATETextDOM::Int32 nIndex) const
	Retrieves a member of this set by position index.
ATETextDOM::Int32	Find (const IMojiKumi mojiKumi)
	Retrieves a specific MojiKumi object from this set, matching name and data.
ATETextDOM::Int32	Find (const ATETextDOM::Unicode *name)
	Retrieves a specific MojiKumi object from this set, matching only the name.
ATETextDOM::Int32	Find (MojikumiTablePredefinedTag tag)
	Retrieves a specific MojiKumi object from this set, matching a tag.
bool	Remove (ATETextDOM::Int32 nIndex)
	Removes a member MojiKumi from this set.
ATETextDOM::Int32	Add (IMojiKumi mojiKumi)
	Appends a MojiKumi to this set.
bool	Replace (ATETextDOM::Int32 nIndex, IMojiKumi mojiKumi)
	Replaces a MojiKumi in this set.
IMojiKumi	CreateNewMojiKumi (const ATETextDOM::Unicode *name, ATETextDOM::Int32 *nIndex)
	Creates a new, empty MojiKumi object and appends it to this set.

---

Detailed Description

Encapsulates a MojiKumi set as a text resource.

The methods allow you to add, access, and manipulate MojiKumi sets for use with the Adobe Text Engine (ATE). The set contains IMojiKumi objects.

---

Constructor & Destructor Documentation

ATE::IMojiKumiSet::IMojiKumiSet

(

)

Constructor.

Returns:

The new object.

ATE::IMojiKumiSet::IMojiKumiSet

(

const IMojiKumiSet &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sMojiKumiSet.

ATE::IMojiKumiSet::IMojiKumiSet

(

MojiKumiSetRef

mojikumiset

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

mojikumiset

The C object.

Returns:

The new C++ object.

ATE::IMojiKumiSet::~IMojiKumiSet

(

)

[virtual]

Destructor.

References ATE::sMojiKumiSet.

---

Member Function Documentation

ATETextDOM::Int32 ATE::IMojiKumiSet::Add

(

IMojiKumi

mojiKumi

)

Appends a MojiKumi to this set.

Parameters:

mojiKumi

The MojiKumi object.

Returns:

The 0-based position index of the successfully added object, or the current index of this object if it is already in the set, or -1 if the object was not in the set and could not be appended.

References ATE::IMojiKumi::GetRef(), ATE::sMojiKumiSet, and ATE::Throw_ATE_Exception().

IMojiKumi ATE::IMojiKumiSet::CreateNewMojiKumi	(	const ATETextDOM::Unicode *	name,
		ATETextDOM::Int32 *	nIndex
	)

Creates a new, empty MojiKumi object and appends it to this set.

Parameters:

	name	The name of the new object.
	nIndex	[out] A buffer in which to return the 0-based position index of the successfully added object, or -1 if it could not be added.

Returns:

The new object, or a NULL object if the MojiKumi could not be created.

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

ATETextDOM::Int32 ATE::IMojiKumiSet::Find

(

MojikumiTablePredefinedTag

tag

)

Retrieves a specific MojiKumi object from this set, matching a tag.

Parameters:

tag

The tag. Use kUserDefinedMojikumiTableTag to get the first customized (not predefined) MojiKumi.

Returns:

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

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

ATETextDOM::Int32 ATE::IMojiKumiSet::Find

(

const ATETextDOM::Unicode *

name

)

Retrieves a specific MojiKumi object from this set, matching only the name.

Parameters:

name

The object name.

Returns:

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

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

ATETextDOM::Int32 ATE::IMojiKumiSet::Find

(

const IMojiKumi

mojiKumi

)

Retrieves a specific MojiKumi object from this set, matching name and data.

Parameters:

mojiKumi

The MojiKumi object.

Returns:

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

References ATE::IMojiKumi::GetRef(), ATE::sMojiKumiSet, and ATE::Throw_ATE_Exception().

IMojiKumi ATE::IMojiKumiSet::GetFirst

(

)

Retrieves the first member of this set.

Returns:

The member object.

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

IMojiKumi ATE::IMojiKumiSet::GetLast

(

)

Retrieves the last member of this set.

Returns:

The member object.

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

MojiKumiSetRef ATE::IMojiKumiSet::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::IMojiKumiSet::GetSize

(

)

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::IMojiKumiSet::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sMojiKumiSet.

IMojiKumi ATE::IMojiKumiSet::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::sMojiKumiSet, and ATE::Throw_ATE_Exception().

bool ATE::IMojiKumiSet::operator!=

(

const IMojiKumiSet &

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.

IMojiKumiSet & ATE::IMojiKumiSet::operator=

(

const IMojiKumiSet &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sMojiKumiSet.

bool ATE::IMojiKumiSet::operator==

(

const IMojiKumiSet &

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::IMojiKumiSet::Remove

(

ATETextDOM::Int32

nIndex

)

Removes a member MojiKumi from this set.

Parameters:

nIndex

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

Returns:

True if a MojiKumi was successfully removed.

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

bool ATE::IMojiKumiSet::Replace	(	ATETextDOM::Int32	nIndex,
		IMojiKumi	mojiKumi
	)

Replaces a MojiKumi in this set.

Parameters:

	nIndex	The 0-based position index of the MojiKumi to replace.
	mojiKumi	The replacement MojiKumi object.

Returns:

True if an object was successfully replaced.

References ATE::IMojiKumi::GetRef(), ATE::sMojiKumiSet, and ATE::Throw_ATE_Exception().

---

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

• IText.h
• IText.cpp