SnpManipulateInCopyCJKGridAttributes Class Reference

Classes
struct	GridAttributes

Public Types
typedef K2Pair< UIDRef, PMString >	RefNamePair
typedef K2Vector< RefNamePair >	RefNamePairs

Public Member Functions
ErrorCode	InspectGridAttributes (const IGridAttributesPrefs *gridAttributesPrefs, GridAttributes &prefsData)
ErrorCode	ModifyGridAttributes (IGridAttributesPrefs *gridAttributesPrefs, const GridAttributes &prefsData)
void	SetAttributes (GridAttributes &prefsData)
void	ReportAttributes (const GridAttributes &prefsData)
RefNamePairs	GetCJKGridAttributeRefNamePairs (IDocument *doc=nil)

Detailed Description

• Inspects and modifies the InCopy CJK grid settings in the text area of an InCopy story document.

CJK grid settings in an InCopy story document are encapsulated in the IGridAttributesPrefs interface. This interface is aggregated on one of the 4 following bosses:

• kDocWorkspaceBoss
• kDocPresetDefaultBoss (accessible via IDocPresetListMgr on kWorkspaceBoss, index 0)
• kDocPresetBoss (accessible via IDocPresetListMgr on kWorkspaceBoss, index other than 0)
• kWorkspaceBoss

Note that this code snippet only loads in the Japanese feature set of InCopy (kInCopyProductFS | kJapaneseLanguageFS), or kInCopyJapaneseFS.

, ,

Member Typedef Documentation

typedef K2Pair<UIDRef, PMString> SnpManipulateInCopyCJKGridAttributes::RefNamePair

Type definition for keeping a UIDRef of the boss that agregates IGridAttributesPres and its description.

typedef K2Vector<RefNamePair> SnpManipulateInCopyCJKGridAttributes::RefNamePairs

A vector of RefNamePair.

See Also

RefNamePair

Member Function Documentation

SnpManipulateInCopyCJKGridAttributes::RefNamePairs SnpManipulateInCopyCJKGridAttributes::GetCJKGridAttributeRefNamePairs

(

IDocument *

doc = nil

)

Gathers the UIDRefs of instances of bosses that aggregate IGridAttributesPrefs and associates each item with a description. The descriptions can be passed on to ISnipRunParameterUtils::GetChoice to help the user pick a specific instance.

Parameters

doc	IN IDocument from a specific document, if available. If doc is non-nil, then the IGridAttributesPrefs from kDocWorkspaceBoss will be included in the returned vector.

Returns

RefNamePairs containing the UIDRef for the boss instance that aggregates IGridAttributesPrefs and a description of that instance.

ErrorCode SnpManipulateInCopyCJKGridAttributes::InspectGridAttributes	(	const IGridAttributesPrefs *	gridAttributesPrefs,
		GridAttributes &	prefsData
	)

Inspects settings in IGridAttributesPrefs.

Parameters

gridAttributesPrefs	IN A specific instance of a IGridAttributesPrefs interface.
prefsData	OUT The inspected preference settings.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateInCopyCJKGridAttributes::ModifyGridAttributes	(	IGridAttributesPrefs *	gridAttributesPrefs,
		const GridAttributes &	prefsData
	)

Modifies settings in a specific instance of IGridAttributesPrefs.

Parameters

gridAttributesPrefs	IN A specific instance of a IGridAttributesPrefs interface.
prefsData	IN The preference settings to set.

Returns

kSuccess on success, other ErrorCode otherwise.

void SnpManipulateInCopyCJKGridAttributes::ReportAttributes

(

const GridAttributes &

prefsData

)

Reports the values in GridAttributes to SNIPLOG. You can pass the GridAttributes gathered with InspectGridAttributes.

Parameters

prefsData

IN GridAttributes filled in.

void SnpManipulateInCopyCJKGridAttributes::SetAttributes

(

GridAttributes &

prefsData

)

Arbitrarily sets the grid attributes data structure so that it could be passed to ModifyGridAttributes.

Modify the contents of this implementation as desired.