ATE::IKinsoku Class Reference

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

#include <IText.h>

List of all members.

Public Member Functions
	IKinsoku ()
	Constructor.
	IKinsoku (const IKinsoku &src)
	Copy constructor.
IKinsoku &	operator= (const IKinsoku &rhs)
	Assignment operator.
bool	operator== (const IKinsoku &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IKinsoku &rhs) const
	Comparison operator tests for inequality.
	IKinsoku (KinsokuRef kinsoku)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IKinsoku ()
	Destructor.
KinsokuRef	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 Kinsoku.
ATETextDOM::Int32	GetNameSize () const
	Retrieves the number of characters in the name of this Kinsoku.
void	SetName (const ATETextDOM::Unicode *name)
	Sets the name of this Kinsoku.
bool	MatchesPredefinedResourceTag (ATE::KinsokuPredefinedTag tag) const
	Reports whether this object matches a predefined tag.
ATETextDOM::Int32	GetNoStartCharSet (ATETextDOM::Unicode *noStartCharSet, ATETextDOM::Int32 maxLength) const
	Retrieves the characters that cannot be used to start this Kinsoku.
ATETextDOM::Int32	GetNoStartCharSetSize () const
	Retrieves the number of characters in the no-start character set of this Kinsoku.
void	SetNoStartCharSet (const ATETextDOM::Unicode *noStartCharSet)
	Sets the characters that cannot be used to start this Kinsoku.
ATETextDOM::Int32	GetNoEndCharSet (ATETextDOM::Unicode *noEndCharSet, ATETextDOM::Int32 maxLength) const
	Retrieves the characters that cannot be used to end this Kinsoku.
ATETextDOM::Int32	GetNoEndCharSetSize () const
	Retrieves the number of characters in the no-end character set of this Kinsoku.
void	SetNoEndCharSet (const ATETextDOM::Unicode *noEndCharSet)
	Sets the characters that cannot be used to end this Kinsoku.
ATETextDOM::Int32	GetNoBreakCharSet (ATETextDOM::Unicode *noBreakCharSet, ATETextDOM::Int32 maxLength) const
	Retrieves the characters that cannot be used at a break in this Kinsoku.
ATETextDOM::Int32	GetNoBreakCharSetSize () const
	Retrieves the number of characters in the no-break character set of this Kinsoku.
void	SetNoBreakCharSet (const ATETextDOM::Unicode *noBreakCharSet)
	Sets the characters that cannot be used at a break in this Kinsoku.
ATETextDOM::Int32	GetHangingCharSet (ATETextDOM::Unicode *hangingCharSet, ATETextDOM::Int32 maxLength) const
	Retrieves the characters that can be left hanging in this Kinsoku.
ATETextDOM::Int32	GetHangingCharSetSize () const
	Retrieves the number of characters in the hanging character set of this Kinsoku.
void	SetHangingCharSet (const ATETextDOM::Unicode *hangingCharSet)
	Sets the characters that can be left hanging in this Kinsoku.
bool	IsNoStartChar (ATETextDOM::Unicode character) const
	Reports whether a character is in the no-start set of this Kinsoku.
bool	IsNoEndChar (ATETextDOM::Unicode character) const
	Reports whether a character is in the no-end set of this Kinsoku.
bool	IsNoBreakChar (ATETextDOM::Unicode character) const
	Reports whether a character is in the no-break set of this Kinsoku.
bool	IsHangingChar (ATETextDOM::Unicode character) const
	Reports whether a character is in the hanging set of this Kinsoku.
bool	IsEquivalent (IKinsoku rhsKinsoku) const
	Does a shallow equivalency test Does a deep equivalency test.
bool	IsModified () const
	Reports whether the resource been modified since it became editable.
bool	IsPredefined () const
	Reports whether this is a predefined Kinsoku.
IKinsoku	Duplicate () const
	Creates a new object by duplicating the information in this one.

---

Detailed Description

Encapsulates a Kinsoku as a text resource.

The methods allow you to add, access, and manipulate Kinsoku for use with the Adobe Text Engine (ATE). The IKinsokuSet collects IKinsoku objects.

---

Constructor & Destructor Documentation

ATE::IKinsoku::IKinsoku

(

)

Constructor.

Constructs an empty Kinsoku.

Returns:

The new object.

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

Referenced by Duplicate().

ATE::IKinsoku::IKinsoku

(

const IKinsoku &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sKinsoku.

ATE::IKinsoku::IKinsoku

(

KinsokuRef

kinsoku

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

kinsoku

The C object.

Returns:

The new C++ object.

ATE::IKinsoku::~IKinsoku

(

)

[virtual]

Destructor.

References ATE::sKinsoku.

---

Member Function Documentation

IKinsoku ATE::IKinsoku::Duplicate

(

)

const

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

Returns:

The new object

References IKinsoku(), ATE::sKinsoku, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::IKinsoku::GetHangingCharSet	(	ATETextDOM::Unicode *	hangingCharSet,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the characters that can be left hanging in this Kinsoku.

Parameters:

	hangingCharSet	[out] A buffer in which to return the hanging character string.
	maxLength	The number of characters in the buffer.

Returns:

The number of characters in the returned string.

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

ATETextDOM::Int32 ATE::IKinsoku::GetHangingCharSetSize

(

)

const

Retrieves the number of characters in the hanging character set of this Kinsoku.

Returns:

The number of characters needed in the buffer to get the hanging set.

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

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

Retrieves the name of this Kinsoku.

Parameters:

	name	[out] A buffer in which to return the name string.
	maxLength	The number of characters in the buffer.

Returns:

The number of characters in the returned string.

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

ATETextDOM::Int32 ATE::IKinsoku::GetNameSize

(

)

const

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

Returns:

The number of characters needed in the buffer to get the name.

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

ATETextDOM::Int32 ATE::IKinsoku::GetNoBreakCharSet	(	ATETextDOM::Unicode *	noBreakCharSet,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the characters that cannot be used at a break in this Kinsoku.

Parameters:

	noBreakCharSet	[out] A buffer in which to return the no-break character string.
	maxLength	The number of characters in the buffer.

Returns:

The number of characters in the returned string.

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

ATETextDOM::Int32 ATE::IKinsoku::GetNoBreakCharSetSize

(

)

const

Retrieves the number of characters in the no-break character set of this Kinsoku.

Returns:

The number of characters needed in the buffer to get the no-break set.

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

ATETextDOM::Int32 ATE::IKinsoku::GetNoEndCharSet	(	ATETextDOM::Unicode *	noEndCharSet,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the characters that cannot be used to end this Kinsoku.

Parameters:

	noEndCharSet	[out] A buffer in which to return the no-end character string.
	maxLength	The number of characters in the buffer.

Returns:

The number of characters in the returned string.

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

ATETextDOM::Int32 ATE::IKinsoku::GetNoEndCharSetSize

(

)

const

Retrieves the number of characters in the no-end character set of this Kinsoku.

Returns:

The number of characters needed in the buffer to get the no-end set.

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

ATETextDOM::Int32 ATE::IKinsoku::GetNoStartCharSet	(	ATETextDOM::Unicode *	noStartCharSet,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the characters that cannot be used to start this Kinsoku.

Parameters:

	noStartCharSet	[out] A buffer in which to return the no-start character string.
	maxLength	The number of characters in the buffer.

Returns:

The number of characters in the returned string.

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

ATETextDOM::Int32 ATE::IKinsoku::GetNoStartCharSetSize

(

)

const

Retrieves the number of characters in the no-start character set of this Kinsoku.

Returns:

The number of characters needed in the buffer to get the no-start set.

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

KinsokuRef ATE::IKinsoku::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::IKinsokuSet::Add(), ATE::IKinsokuSet::Find(), IsEquivalent(), ATE::IKinsokuSet::Replace(), and ATE::IParaFeatures::SetKinsoku().

bool ATE::IKinsoku::IsEquivalent

(

IKinsoku

rhsKinsoku

)

const

Does a shallow equivalency test Does a deep equivalency test.

Reports whether this object represents the same Kinsoku as another Kinsoku object.

Parameters:

rhsKinsoku

The comparison object.

Returns:

True if the two objects are the same.

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

bool ATE::IKinsoku::IsHangingChar

(

ATETextDOM::Unicode

character

)

const

Reports whether a character is in the hanging set of this Kinsoku.

Parameters:

character

The character.

Returns:

True if this character is in the set.

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

bool ATE::IKinsoku::IsModified

(

)

const

Reports whether the resource been modified since it became editable.

Returns:

True if the resource has been modified.

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

bool ATE::IKinsoku::IsNoBreakChar

(

ATETextDOM::Unicode

character

)

const

Reports whether a character is in the no-break set of this Kinsoku.

Parameters:

character

The character.

Returns:

True if this character is in the set.

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

bool ATE::IKinsoku::IsNoEndChar

(

ATETextDOM::Unicode

character

)

const

Reports whether a character is in the no-end set of this Kinsoku.

Parameters:

character

The character.

Returns:

True if this character is in the set.

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

bool ATE::IKinsoku::IsNoStartChar

(

ATETextDOM::Unicode

character

)

const

Reports whether a character is in the no-start set of this Kinsoku.

Parameters:

character

The character.

Returns:

True if this character is in the set.

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

bool ATE::IKinsoku::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sKinsoku.

bool ATE::IKinsoku::IsPredefined

(

)

const

Reports whether this is a predefined Kinsoku.

Returns:

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

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

bool ATE::IKinsoku::MatchesPredefinedResourceTag

(

ATE::KinsokuPredefinedTag

tag

)

const

Reports whether this object matches a predefined tag.

Parameters:

tag

The tag object.

Returns:

True if this object matches the tag.

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

bool ATE::IKinsoku::operator!=

(

const IKinsoku &

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.

IKinsoku & ATE::IKinsoku::operator=

(

const IKinsoku &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sKinsoku.

bool ATE::IKinsoku::operator==

(

const IKinsoku &

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

void ATE::IKinsoku::SetHangingCharSet

(

const ATETextDOM::Unicode *

hangingCharSet

)

Sets the characters that can be left hanging in this Kinsoku.

Parameters:

hangingCharSet

The string containing the characters.

Returns:

Nothing.

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

void ATE::IKinsoku::SetName

(

const ATETextDOM::Unicode *

name

)

Sets the name of this Kinsoku.

Parameters:

name

The name string.

Returns:

Nothing.

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

void ATE::IKinsoku::SetNoBreakCharSet

(

const ATETextDOM::Unicode *

noBreakCharSet

)

Sets the characters that cannot be used at a break in this Kinsoku.

Parameters:

noBreakCharSet

The string containing the characters.

Returns:

Nothing.

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

void ATE::IKinsoku::SetNoEndCharSet

(

const ATETextDOM::Unicode *

noEndCharSet

)

Sets the characters that cannot be used to end this Kinsoku.

Parameters:

noEndCharSet

The string containing the characters.

Returns:

Nothing.

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

void ATE::IKinsoku::SetNoStartCharSet

(

const ATETextDOM::Unicode *

noStartCharSet

)

Sets the characters that cannot be used to start this Kinsoku.

Parameters:

noStartCharSet

The string containing the characters.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp