Public Member Functions
	SnpApplyTextStyleAttributes ()

virtual	~SnpApplyTextStyleAttributes ()

ErrorCode	ToggleUnderline (ITextAttributeSuite *suite)

ErrorCode	CycleSmallAllCaps (ITextAttributeSuite *suite)

ErrorCode	ApplyFontVariant (ITextAttributeSuite *suite, const PMString &typeStyle)

ErrorCode	ToggleBold (ITextAttributeSuite *suite)

ErrorCode	ToggleItalic (ITextAttributeSuite *suite)

ErrorCode	ApplyAlignment (ITextAttributeSuite *suite, const ICompositionStyle::TextAlignment alignment)

const UID	CreateSDKStyleGroup (IDocument document, IStyleGroupManager styleGroupMgr)

ErrorCode	CreateParaStyle (ITextAttributeSuite suite, const PMString &styleName, IDocument document)

ErrorCode	ApplyParaStyle (ITextAttributeSuite suite, const PMString &styleName, IDocument document)

ErrorCode	CreateCharStyle (ITextAttributeSuite suite, const PMString &styleName, IDocument document)

ErrorCode	ApplyCharStyle (ITextAttributeSuite suite, const PMString &styleName, IDocument document)

ErrorCode	IncrementalCharRotation (ITextAttributeSuite *suite, const PMReal angle)

ErrorCode	ApplyTsume (ITextAttributeSuite *suite, const PMReal tsume)

ErrorCode	ApplyMojikumiSpacing (ITextAttributeSuite *suite, const PMReal space, const bool16 isBefore=kTrue)

ErrorCode	ApplyJidori (ITextAttributeSuite *suite, const int16 jidori)

ErrorCode	ApplyShatai (ITextAttributeSuite *suite, const PMReal lens, const PMReal angle)

ErrorCode	SetSingleColumn (ITextModel *textModel, const RangeData &range)

ErrorCode	SetSpanColumns (ITextModel *textModel, const RangeData &range, int16 spanNumber)

ErrorCode	SetSplitColumns (ITextModel *textModel, const RangeData &range, int16 splitNumber, PMReal insideGutter, PMReal outsideGutter)

const UID	ResolveRGBColorSwatch (const PMString &swatchName, const PMReal rRed, const PMReal rGreen, const PMReal rBlue, IDocument *document)

ErrorCode	ToggleParaBorder (ITextAttributeSuite *suite)

ErrorCode	ToggleParaShading (ITextAttributeSuite *suite)

Detailed Description

How to apply text attributes that control by high level ITextAttributeSuite API,
How to create and apply of paragraph style and character style,
The attributes that control Underline, SmallAllCaps, Font Variant, Alignment, and Japanese Features Character rotete, Tsume, Mojikumi spacing, Jidori, Shatai,
This code snippet is the same as the sample code TextStyler of InDesign 2.0 SDK.

See Also: ITextAttributeSuite

Constructor & Destructor Documentation

SnpApplyTextStyleAttributes::SnpApplyTextStyleAttributes ( )

inline

Constructor.

virtual SnpApplyTextStyleAttributes::~SnpApplyTextStyleAttributes ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpApplyTextStyleAttributes::ApplyAlignment	(	ITextAttributeSuite *	suite,
		const ICompositionStyle::TextAlignment	alignment
	)

Alignment is applied by creating a "alignment" attribute applied to text. kTextAttrAlignBodyBoss and kTextAttrAlignLastBoss are obsolete, and have been replaced with kTextAttrAlignmentBoss.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
alignment	The text alignment.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpApplyTextStyleAttributes::ApplyCharStyle	(	ITextAttributeSuite *	suite,
		const PMString &	styleName,
		IDocument *	document
	)

Looks up the character style in the corresponding style table. The name of the style is hardcoded. If the UID is found to be valid, the style is applied using the TextAttributeSuite.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
styleName	PMSString for the character style name.
document	Active document.

Returns: kSuccess if value is successfully set, kFailure otherwise.

ErrorCode SnpApplyTextStyleAttributes::ApplyFontVariant	(	ITextAttributeSuite *	suite,
		const PMString &	typeStyle
	)

Applies the specified font face, by taking the name of the font variant (e.g., "Bold"), and then querying the text attribute suite to determine how many instances of the font variant exist.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
typeStyle	PMString for the type face name.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpApplyTextStyleAttributes::ApplyJidori	(	ITextAttributeSuite *	suite,
		const int16	jidori
	)

InDesign Japanese Feature. Applies Jidori (effective EmBoxes to occupy) in the selected text. Jidori composes the selected characters in the specified number of character-widths.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
jidori	Number of characters for jidori.

Returns: kSuccess if value is successfully set, kFailure otherwise.

ErrorCode SnpApplyTextStyleAttributes::ApplyMojikumiSpacing	(	ITextAttributeSuite *	suite,
		const PMReal	space,
		const bool16	isBefore = `kTrue`
	)

InDesign Japanese Feature. Inserts mojikumi space before or after the characters in the selected text. Default is "insert before".

Parameters

space	The percent of the mojikumi spacing.
isBefore	Flag indicating if we want to set the mojikumi spacing before or after. Default is "before"(kTrue).

ErrorCode SnpApplyTextStyleAttributes::ApplyParaStyle	(	ITextAttributeSuite *	suite,
		const PMString &	styleName,
		IDocument *	document
	)

Looks up the paragraph style in the corresponding style table. The name of the style is hardcoded. If the UID is found to be valid, the style is applied using the TextAttributeSuite.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
styleName	PMSString for the paragraph style name.
document	Active document.

Returns: kSuccess if value is successfully set, kFailure otherwise.

ErrorCode SnpApplyTextStyleAttributes::ApplyShatai	(	ITextAttributeSuite *	suite,
		const PMReal	lens,
		const PMReal	angle
	)

InDesign Japanese Feature. Apply shatai in the selected text. Shatai is not Italic, It is an optical effect applied by a lens. Shatai uses a lens magnification (Reduction rate) and an angle parameter.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
lens	Lens magnification (Reduction rate).
angle	Shatai angle.

Returns: kSuccess if value is successfully set, kFailure otherwise.

ErrorCode SnpApplyTextStyleAttributes::ApplyTsume	(	ITextAttributeSuite *	suite,
		const PMReal	tsume
	)

InDesign Japanese Feature. Set the tsume value on the selected text.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
tsume	The Moji-Tsume of the characters by the percent.

Returns: kSuccess if value is successfully set, kFailure otherwise.

ErrorCode SnpApplyTextStyleAttributes::CreateCharStyle	(	ITextAttributeSuite *	suite,
		const PMString &	styleName,
		IDocument *	document
	)

Creates a character style with defaults, but blue. The character style table is first queried so that we can be sure the style is not already in the document – if it is, a log message will inform the user that the style has already been created and choose a different name. If the style does not exist, it is created.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
styleName	PMSString for the character style name.
document	Active document.

Returns: kSuccess if value is successfully set, kFailure otherwise.

ErrorCode SnpApplyTextStyleAttributes::CreateParaStyle	(	ITextAttributeSuite *	suite,
		const PMString &	styleName,
		IDocument *	document
	)

Creates a paragraph style with all the defaults, but 18 point font size. The paragraph style table is first queried so that we can be sure the style is not already in the document – if it is, a log message will inform the user that the style has already been created and choose a different name. If the style does not exist, it is created.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
styleName	PMSString for the paragraph style name.

Returns: kSuccess on success, other ErrorCode otherwise.

const UID SnpApplyTextStyleAttributes::CreateSDKStyleGroup	(	IDocument *	document,
		IStyleGroupManager *	styleGroupMgr
	)

Create a SDK group to organize the styles created in this snippets, also to demo the new feature available in CS3

Parameters

document	We are creating the style as part of doc workspace, this is the doc associated with the style
styleGroupMgr	the doc's style group manager, could be either for char or para style, depends on how you query it.

ErrorCode SnpApplyTextStyleAttributes::CycleSmallAllCaps ( ITextAttributeSuite * suite )

Queries the TextAttributeSuite for the CapsMode attribute. Finding one instance of the normal/small/all caps attribute in the selected text range means that it may or may not be applied, and the mode must be queried to determine this. Finding multiple instances means that there is a mix of modes (part of the text is small/all caps, part is not).

Parameters

suite The active ITextAttributeSuite for the current text selection.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpApplyTextStyleAttributes::IncrementalCharRotation	(	ITextAttributeSuite *	suite,
		const PMReal	angle
	)

InDesign Japanese Feature. Incremental rotation to characters individually in the specified angle.

Parameters

suite	The active ITextAttributeSuite for the current text selection.
angle	Angle of character rotation.

Returns: kSuccess if value is successfully set, kFailure otherwise.

const UID SnpApplyTextStyleAttributes::ResolveRGBColorSwatch	(	const PMString &	swatchName,
		const PMReal	rRed,
		const PMReal	rGreen,
		const PMReal	rBlue,
		IDocument *	document
	)

Finds or creates a color in the swatch list, returning a UID to the color. We use a color swatch for the character style.

Parameters

swatchName	Swatch Name
rRed	Red (0.0...1.0)
rGreen	Green (0.0...1.0)
rBlue	Blue (0.0...1.0)
document	Active document.

Returns: returning a UID to the color.

ErrorCode SnpApplyTextStyleAttributes::SetSingleColumn	(	ITextModel *	textModel,
		const RangeData &	range
	)

For paragraphy layout, set single column.

Parameters

textModel	The text model for the current text selection.
range	The text range.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpApplyTextStyleAttributes::SetSpanColumns	(	ITextModel *	textModel,
		const RangeData &	range,
		int16	spanNumber
	)

For paragraphy layout, set span columns.

Parameters

textModel	The text model for the current text selection.
range	The text range.
spanNumber	The number of the columns which need be spanned.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpApplyTextStyleAttributes::SetSplitColumns	(	ITextModel *	textModel,
		const RangeData &	range,
		int16	splitNumber,
		PMReal	insideGutter,
		PMReal	outsideGutter
	)

For paragraphy layout, set split columns.

Parameters

textModel	The text model for the current text selection.
range	The text range.
splitNumber	The number of the sub-columns.
insideGutter	The inside gutter of split columns.
outsideGutter	The outside gutter of split columns.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpApplyTextStyleAttributes::ToggleBold ( ITextAttributeSuite * suite )

Toggles the Bold font style state.

Parameters

suite The active ITextAttributeSuite for the current text selection.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpApplyTextStyleAttributes::ToggleItalic ( ITextAttributeSuite * suite )

Toggles the Italic font style state.

Parameters

suite The active ITextAttributeSuite for the current text selection.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpApplyTextStyleAttributes::ToggleUnderline ( ITextAttributeSuite * suite )

Toggles the underline state.

Parameters

suite The active ITextAttributeSuite for the current text selection.

Returns: kSuccess on success, other ErrorCode otherwise.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation