ATE::IKinsokuSet Class Reference

Encapsulates a set of Kinsoku as a text resource. More...

#include <IText.h>

List of all members.

Public Member Functions
	IKinsokuSet ()
	Constructor.
	IKinsokuSet (const IKinsokuSet &src)
	Copy constructor.
IKinsokuSet &	operator= (const IKinsokuSet &rhs)
	Assignment operator.
bool	operator== (const IKinsokuSet &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IKinsokuSet &rhs) const
	Comparison operator tests for inequality.
	IKinsokuSet (KinsokuSetRef kinsokuset)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IKinsokuSet ()
	Destructor.
KinsokuSetRef	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.
IKinsoku	GetFirst ()
	Retrieves the first member of this set.
IKinsoku	GetLast ()
	Retrieves the last member of this set.
IKinsoku	Item (ATETextDOM::Int32 nIndex) const
	Retrieves a member of this set by position index.
ATETextDOM::Int32	Find (IKinsoku kinsoku)
	Retrieves a specific Kinsoku object from this set, matching name and data.
ATETextDOM::Int32	Find (const ATETextDOM::Unicode *name)
	Retrieves a specific Kinsoku object from this set, matching only the name.
ATETextDOM::Int32	Find (KinsokuPredefinedTag tag)
	Retrieves a specific Kinsoku object from this set, matching a tag.
bool	Remove (ATETextDOM::Int32 nIndex)
	Removes a member from the set.
ATETextDOM::Int32	Add (IKinsoku kinsoku)
	Appends a Kinsoku to this set.
bool	Replace (ATETextDOM::Int32 nIndex, IKinsoku kinsoku)
	Replaces a Kinsoku in this set.

---

Detailed Description

Encapsulates a set of Kinsoku as a text resource.

A Kinsoku set contains a collection of IKinsoku objects.

---

Constructor & Destructor Documentation

ATE::IKinsokuSet::IKinsokuSet

(

)

Constructor.

Returns:

The new object.

ATE::IKinsokuSet::IKinsokuSet

(

const IKinsokuSet &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sKinsokuSet.

ATE::IKinsokuSet::IKinsokuSet

(

KinsokuSetRef

kinsokuset

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

kinsokuset

The C object.

Returns:

The new C++ object.

ATE::IKinsokuSet::~IKinsokuSet

(

)

[virtual]

Destructor.

References ATE::sKinsokuSet.

---

Member Function Documentation

ATETextDOM::Int32 ATE::IKinsokuSet::Add

(

IKinsoku

kinsoku

)

Appends a Kinsoku to this set.

Parameters:

kinsoku

The Kinsoku 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::IKinsoku::GetRef(), ATE::sKinsokuSet, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::IKinsokuSet::Find

(

KinsokuPredefinedTag

tag

)

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

Parameters:

tag

The tag. Use kUserDefinedKinsokuTag to get the first customized (not predefined) Kinsoku.

Returns:

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

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

ATETextDOM::Int32 ATE::IKinsokuSet::Find

(

const ATETextDOM::Unicode *

name

)

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

Parameters:

name

The name string.

Returns:

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

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

ATETextDOM::Int32 ATE::IKinsokuSet::Find

(

IKinsoku

kinsoku

)

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

Parameters:

kinsoku

The Kinsoku object.

Returns:

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

References ATE::IKinsoku::GetRef(), ATE::sKinsokuSet, and ATE::Throw_ATE_Exception().

IKinsoku ATE::IKinsokuSet::GetFirst

(

)

Retrieves the first member of this set.

Returns:

The member object.

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

IKinsoku ATE::IKinsokuSet::GetLast

(

)

Retrieves the last member of this set.

Returns:

The member object.

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

KinsokuSetRef ATE::IKinsokuSet::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::IKinsokuSet::GetSize

(

)

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::IKinsokuSet::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sKinsokuSet.

IKinsoku ATE::IKinsokuSet::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::sKinsokuSet, and ATE::Throw_ATE_Exception().

bool ATE::IKinsokuSet::operator!=

(

const IKinsokuSet &

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.

IKinsokuSet & ATE::IKinsokuSet::operator=

(

const IKinsokuSet &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sKinsokuSet.

bool ATE::IKinsokuSet::operator==

(

const IKinsokuSet &

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

(

ATETextDOM::Int32

nIndex

)

Removes a member from the set.

Parameters:

nIndex

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

Returns:

True if a member was successfully removed.

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

bool ATE::IKinsokuSet::Replace	(	ATETextDOM::Int32	nIndex,
		IKinsoku	kinsoku
	)

Replaces a Kinsoku in this set.

Parameters:

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

Returns:

True if an object was successfully replaced.

References ATE::IKinsoku::GetRef(), ATE::sKinsokuSet, and ATE::Throw_ATE_Exception().

---

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

• IText.h
• IText.cpp