SnpPerformTextAttrTateChuYoko Class Reference

Public Member Functions
	SnpPerformTextAttrTateChuYoko ()
virtual	~SnpPerformTextAttrTateChuYoko ()
ErrorCode	ApplyTateChuYoko (const InDesign::TextRange &textRange, const SnpTateChuYokoSttings &TCYData)
ErrorCode	ApplyAutomaticTateChuYoko (const InDesign::TextRange &textRange, const SnpTateChuYokoSttings &TCYData)
ErrorCode	RemoveTateChuYoko (const InDesign::TextRange &textRange)
ErrorCode	RemoveAutomaticTateChuYoko (const InDesign::TextRange &textRange)
ErrorCode	InspectTateChuYoko (const InDesign::TextRange &textRange, SnpTateChuYokoSttings &TCYData)
void	SetTateChuYokoData (SnpTateChuYokoSttings &TCYData)
void	ReportTateChuYokoData (const SnpTateChuYokoSttings &TCYData)

Detailed Description

• How to apply, remove, and inspect Japanese TateChuYoko text attributes.

See Also

IAttrReport

IComposeScanner

ITextAttrBoolean

ITextAttrClassID

ITextAttrInt16

ITextAttrRealNumber

ITextFocus

ITextModel

ITextTarget

ITextModelCmds

IVerticalRelatedStyle

Constructor & Destructor Documentation

SnpPerformTextAttrTateChuYoko::SnpPerformTextAttrTateChuYoko ( )

inline

Constructor.

virtual SnpPerformTextAttrTateChuYoko::~SnpPerformTextAttrTateChuYoko ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpPerformTextAttrTateChuYoko::ApplyAutomaticTateChuYoko	(	const InDesign::TextRange &	textRange,
		const SnpTateChuYokoSttings &	TCYData
	)

Applies automatic TateChuYoko attributes onto the specified paragraph.

Parameters

[in]	textRange	The text range to which you want to apply TateChuYoko.
[in]	TCYData	The TateChuYoko settings. Use SetTateChuYokoData() to fill in the members.

Returns

kSuccess on success, kFailure otherwise.

ErrorCode SnpPerformTextAttrTateChuYoko::ApplyTateChuYoko	(	const InDesign::TextRange &	textRange,
		const SnpTateChuYokoSttings &	TCYData
	)

Applies TateChuYoko attributes onto the specified text model range.

Parameters

[in]	textRange	The text range to which you want to apply TateChuYoko.
[in]	TCYData	The TateChuYoko settings. Use SetTateChuYokoData() to fill in the members.

Returns

kSuccess on success, kFailure otherwise.

ErrorCode SnpPerformTextAttrTateChuYoko::InspectTateChuYoko	(	const InDesign::TextRange &	textRange,
		SnpTateChuYokoSttings &	TCYData
	)

Inspects TateChuYoko attributes over the specified text model range. The details are printed onto the SNIPLOG.

Parameters

[in]	textRange	The text range from which you want to inspect TateChuYoko.
[out]	TCYData	The TateChuYoko settings.

Returns

kSuccess on success, kFailure otherwise.

ErrorCode SnpPerformTextAttrTateChuYoko::RemoveAutomaticTateChuYoko

(

const InDesign::TextRange &

textRange

)

Removes (or simply turns off) automatic TateChuYoko attributes from the specified paragraph.

Parameters

[in]

textRange

The text range from which you want to remove TateChuYoko.

Returns

kSuccess on success, kFailure otherwise.

ErrorCode SnpPerformTextAttrTateChuYoko::RemoveTateChuYoko

(

const InDesign::TextRange &

textRange

)

Removes (or simply turns off) TateChuYoko attributes from the specified text model range.

Parameters

[in]

textRange

The text range from which you want to remove TateChuYoko.

Returns

kSuccess on success, kFailure otherwise.

void SnpPerformTextAttrTateChuYoko::ReportTateChuYokoData

(

const SnpTateChuYokoSttings &

TCYData

)

Reports TateChuYoko data to SNIPLOG.

Parameters

[in]

TCYData

The TateChuYoko settings.

void SnpPerformTextAttrTateChuYoko::SetTateChuYokoData

(

SnpTateChuYokoSttings &

TCYData

)

Sets the SnpTateChuYokoSttings structure.

Parameters

[out]

TCYData

The TateChuYoko settings that can be passed on to ApplyTateChuYoko().