SnpPerformTextAttrKenten Class Reference

Public Member Functions
	SnpPerformTextAttrKenten ()
virtual	~SnpPerformTextAttrKenten ()
ErrorCode	ApplyKenten (const InDesign::TextRange &textRange, const SnpKentenDataSettings &kentenData)
ErrorCode	RemoveKenten (const InDesign::TextRange &textRange)
ErrorCode	InspectKenten (const InDesign::TextRange &textRange, SnpKentenDataSettings &kentenData)
void	SetKentenData (const InDesign::TextRange &textRange, SnpKentenDataSettings &kentenData)
void	ReportKentenData (const SnpKentenDataSettings &kentenData, IDataBase *db)

Detailed Description

• How to apply, remove, and inspect kenten text attributes.

This snippet is an extension of what used to be the KentenCreatorJ sample plug-in.

See Also

IAttrReport

IComposeScanner

IKentenStyle

ITextAttrBoolean

ITextAttrClassID

ITextAttrFont

ITextAttrInt16

ITextAttrRealNumber

ITextAttrUID

ITextAttrUtils

ITextFocus

ITextModel

ITextTarget

ITextUtils

Constructor & Destructor Documentation

SnpPerformTextAttrKenten::SnpPerformTextAttrKenten ( )

inline

Constructor.

virtual SnpPerformTextAttrKenten::~SnpPerformTextAttrKenten ( )

inlinevirtual

Destructor..

Member Function Documentation

ErrorCode SnpPerformTextAttrKenten::ApplyKenten	(	const InDesign::TextRange &	textRange,
		const SnpKentenDataSettings &	kentenData
	)

Applies kenten attributes onto the specified text model range.

Parameters

textRange	(in) The text range to which you want to apply kenten.
kentenData	(in) The kenten settings. Use SetKentenData() to fill in the members.

Returns

kSuccess on success, kFailure otherwise.

ErrorCode SnpPerformTextAttrKenten::InspectKenten	(	const InDesign::TextRange &	textRange,
		SnpKentenDataSettings &	kentenData
	)

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

Parameters

textRange	(in) The text range from which you want to inspect kenten.
kentenData	(out) The kenten settings.

Returns

kSuccess on success, kFailure otherwise.

ErrorCode SnpPerformTextAttrKenten::RemoveKenten

(

const InDesign::TextRange &

textRange

)

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

Parameters

textRange

(in) The text range from which you want to remove kenten.

Returns

kSuccess on success, kFailure otherwise.

void SnpPerformTextAttrKenten::ReportKentenData	(	const SnpKentenDataSettings &	kentenData,
		IDataBase *	db
	)

Reports kenten data to SNIPLOG.

Parameters

kentenData	(in) The kenten settings.
db	(in) Database for getting the swatch names.

void SnpPerformTextAttrKenten::SetKentenData	(	const InDesign::TextRange &	textRange,
		SnpKentenDataSettings &	kentenData
	)

Sets the SnpKentenDataSettings structure.

Parameters

textRange	(in) The text range to use as a basis for some kenten settings, particularly those that depend on the base text.
kentenData	(out) The kenten settings that can be passed on to ApplyKenten().