#include <IKinsokuTable.h>

Inheritance diagram for IKinsokuTable:

Public Types
enum	{ kDefaultIID = IID_IKINSOKUTABLE }

enum	KinsokuCharType { kKinsoku_CannotBeginLine = 0, kKinsoku_CannotEndLine, kKinsoku_Hanging, kKinsoku_Nonseparatable }

Public Member Functions
virtual void	AddKinsokuBefore (const WideString &characters)=0

virtual void	AddKinsokuAfter (const WideString &characters)=0

virtual void	AddKinsokuHanging (const WideString &characters)=0

virtual void	AddKinsokuNotSeparate (const WideString &characters)=0

virtual void	GetKinsokuBefore (WideString &characters) const =0

virtual void	GetKinsokuAfter (WideString &characters) const =0

virtual void	GetKinsokuHanging (WideString &characters) const =0

virtual void	GetKinsokuNotSeparate (WideString &characters) const =0

virtual bool16	NoBreakBefore (UTF32TextChar c) const =0

virtual bool16	NoBreakAfter (UTF32TextChar c) const =0

virtual bool16	IsHangingCharacter (UTF32TextChar c) const =0

virtual bool16	IsNotSeparateCharacter (UTF32TextChar c) const =0

virtual int32	KinsokuBeforeNum () const =0

virtual int32	KinsokuAfterNum () const =0

virtual int32	KinsokuHangingNum () const =0

virtual int32	KinsokuNotSeparateNum () const =0

virtual void	Clear ()=0

virtual void	ClearKinsokuBefore ()=0

virtual void	ClearKinsokuAfter ()=0

virtual void	ClearKinsokuHanging ()=0

virtual void	ClearKinsokuNotSeparate ()=0

virtual UTF32TextChar	GetOneKinsokuCharacter (const int32 index, KinsokuCharType type) const =0

virtual void	AppendOneKinsokuCharacter (const UTF32TextChar ch, KinsokuCharType type)=0

virtual void	CopyKinsokuTableData (const IKinsokuTable *from)=0

virtual bool16	GetEditability () const =0

virtual void	SetEditability (bool16 editability)=0

virtual void	AddKinsokuBetween (const textchar characters1, const textchar characters2, int32 number)=0

virtual bool16	NoBreakBetween (UTF32TextChar c1, UTF32TextChar c2) const =0

virtual int32	NoBreakBetweenNum () const =0

virtual void	ClearNoBreakBetween ()=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

The Kinsoku Table contains characters in four categories: Characters that cannot begin a line, characters that cannot end a line, characters that are inseparable (no-break, no-justify) and characters that can hang outside the right margin.

Member Function Documentation

virtual void IKinsokuTable::AddKinsokuAfter ( const WideString & characters )

pure virtual

Add characters that cannot end a line to the table

Parameters

characters [IN] cannot end line characters

virtual void IKinsokuTable::AddKinsokuBefore ( const WideString & characters )

pure virtual

Add characters that cannot begin a line to the table

Parameters

characters [IN] cannot begin line characters

virtual void IKinsokuTable::AddKinsokuHanging ( const WideString & characters )

pure virtual

Add characters that can hang off line end to the table

Parameters

characters [IN] hanging characters

virtual void IKinsokuTable::AddKinsokuNotSeparate ( const WideString & characters )

pure virtual

Add characters that cannot be separated or justified

Parameters

characters [IN] inseparable characters

virtual void IKinsokuTable::AppendOneKinsokuCharacter	(	const UTF32TextChar	ch,
		KinsokuCharType	type
	)

pure virtual

Add a single kinsoku character of the requested type to that buffer

Parameters

ch	[IN] the kinsoku character to add
type	[IN] which buffer

virtual void IKinsokuTable::Clear ( )

pure virtual

Clear the contents of the table

virtual void IKinsokuTable::ClearKinsokuAfter ( )

pure virtual

Clear the contents of the no-break after table

virtual void IKinsokuTable::ClearKinsokuBefore ( )

pure virtual

Clear the contents of the no-break before table

virtual void IKinsokuTable::ClearKinsokuHanging ( )

pure virtual

Clear the contents of the kinsoku hanging table

virtual void IKinsokuTable::ClearKinsokuNotSeparate ( )

pure virtual

Clear the contents of the inseparables table

virtual void IKinsokuTable::CopyKinsokuTableData ( const IKinsokuTable * from )

pure virtual

Copy Kinsoku table data from other table

Parameters

from	[IN] table to copy from

virtual bool16 IKinsokuTable::GetEditability ( ) const

pure virtual

Returns: kTrue if this Kinsoku table is editable

virtual void IKinsokuTable::GetKinsokuAfter ( WideString & characters ) const

pure virtual

Get characters that cannot end a line

Parameters

characters [OUT] cannot end line characters

virtual void IKinsokuTable::GetKinsokuBefore ( WideString & characters ) const

pure virtual

Get characters that cannot begin a line

Parameters

characters [OUT] cannot begin line characters

virtual void IKinsokuTable::GetKinsokuHanging ( WideString & characters ) const

pure virtual

Get characters that can hang off the end of a line

Parameters

characters [OUT] hanging characters

virtual void IKinsokuTable::GetKinsokuNotSeparate ( WideString & characters ) const

pure virtual

Get characters that cannot be separated or justified

Parameters

characters [OUT] inseparable characters

virtual UTF32TextChar IKinsokuTable::GetOneKinsokuCharacter	(	const int32	index,
		KinsokuCharType	type
	)		const

pure virtual

Get a single kinsoku character of the requested type

Parameters

index	[IN] index into the buffer of kinsoku characters
type	[IN] which buffer

Returns: the kinsoku character

virtual bool16 IKinsokuTable::IsHangingCharacter ( UTF32TextChar c ) const

pure virtual

Get whether or not a character is in the hanging character table

Parameters

c	[IN] character

Returns: kTrue if character is found in the table

virtual bool16 IKinsokuTable::IsNotSeparateCharacter ( UTF32TextChar c ) const

pure virtual

Get whether or not a character is in the inseparables character table

Parameters

c	[IN] character

Returns: kTrue if character is found in the table

virtual int32 IKinsokuTable::KinsokuAfterNum ( ) const

pure virtual

Get number of kinsoku characters that cannot begin a line

Returns: number of kinsoku characters that cannot begin a line

virtual int32 IKinsokuTable::KinsokuBeforeNum ( ) const

pure virtual

Get number of kinsoku characters that cannot end a line

Returns: number of kinsoku characters that cannot end a line

virtual int32 IKinsokuTable::KinsokuHangingNum ( ) const

pure virtual

Get number of kinsoku characters that can hang at line end

Returns: number of kinsoku characters that can hang at line end

virtual int32 IKinsokuTable::KinsokuNotSeparateNum ( ) const

pure virtual

Get number of kinsoku characters that cannot be separated or justified

Returns: number of kinsoku characters that cannot be separated or justified

virtual bool16 IKinsokuTable::NoBreakAfter ( UTF32TextChar c ) const

pure virtual

Get whether or not a character is in the cannot begin line character table

Parameters

c	[IN] character

Returns: kTrue if character is found in the table

virtual bool16 IKinsokuTable::NoBreakBefore ( UTF32TextChar c ) const

pure virtual

Get whether or not a character is in the cannot end line character table

Parameters

c	[IN] character

Returns: kTrue if character is found in the table

virtual void IKinsokuTable::SetEditability ( bool16 editability )

pure virtual

Parameters

editability [IN] sets whether or not the table is user-editable

Public Types

Public Member Functions

Detailed Description

Member Function Documentation