#include <IStyleUtils.h>

Inheritance diagram for IStyleUtils:

Public Types
enum	{ kDefaultIID = IID_ISTYLEUTILS }

Public Member Functions
virtual void	CreateUniqueName (IStyleNameTable *pStyleTable, PMString &sName, bool16 appendCopy=kFalse)=0

virtual void	CreateUniqueName (const IStyleGroupHierarchy *hierarchy, PMString &sName)=0

virtual ICommand *	CreateEditStyleCmd (const ScriptInfo::RequestContext &context, const IStyleInfo style, const IPMUnknown addAttribute=nil, ClassID removeAttribute=kInvalidClass)=0

virtual ICommand *	CreateEditStyleCmd (const ScriptInfo::RequestContext &context, const IStyleInfo *style, const AddAttributeList &addAttrList, const RemoveAttributeList &removeAttrList)=0

virtual IStyleNameTable *	QueryStyleNameTable (const IScript *script, const ScriptInfo::RequestContext &context, const ScriptID &desiredType)=0

virtual IStyleGroupManager *	QueryStyleGroupManager (const IScript *script, const ScriptInfo::RequestContext &context, const ScriptID &desiredType)=0

virtual ErrorCode	GetStyleRef (const ScriptInfo::RequestContext &context, IScript *script, const ScriptID &propID, UIDRef &styleRef)=0

virtual ErrorCode	AccessStyle (IScriptRequestData data, IScript script, const ScriptID &propID, ScriptID dataLocation, bool16 clearOverrides=kTrue)=0

virtual bool16	CopyStyle (const IStyleInfo pFrom, IStyleInfo pTo, bool16 bCopyInherited)=0

virtual void	CopyStyleInfo (const IStyleInfo pFrom, IStyleInfo pTo)=0

virtual ICommand *	CreateEditStyleCmd (const IStyleInfo style, const IPMUnknown addAttribute=nil, ClassID removeAttribute=kInvalidClass)=0

virtual ICommand *	CreateEditStyleCmd (const IStyleInfo *style, const AddAttributeList &addAttrList, const RemoveAttributeList &removeAttrList)=0

virtual void	LogStyleApplied (IDataBase *db, const UID styleUID)=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

Utilities related to styles (Paragraph, Character, Table, Object...)

e.g.

Utils&;t;IStyleUtils>()->MethodName( ... ) ;

Member Function Documentation

virtual ErrorCode IStyleUtils::AccessStyle	(	IScriptRequestData *	data,
		IScript *	script,
		const ScriptID &	propID,
		ScriptID	dataLocation,
		bool16	clearOverrides = `kTrue`
	)

pure virtual

Handle the applied style properties

virtual bool16 IStyleUtils::CopyStyle	(	const IStyleInfo *	pFrom,
		IStyleInfo *	pTo,
		bool16	bCopyInherited
	)

pure virtual

CopyStyle – copy the info and the attributes from pFrom to pTo. if bCopyInherited is true, then the attributes will contain all attributes of the style plus what it is based on. StyleInfo is still from pFrom itself.

Parameters

pFrom	- the style to copy
pTo	- the style to copy to
bCopyInherited	- whether to copy based on style

Returns: false if pFrom == pTo already.

virtual void IStyleUtils::CopyStyleInfo	(	const IStyleInfo *	pFrom,
		IStyleInfo *	pTo
	)

pure virtual

CopyStyleInfo – copy JUST the style info fields from pFrom to pTo.

Parameters

pFrom	- the style to copy
pTo	- the style to copy to

virtual ICommand* IStyleUtils::CreateEditStyleCmd	(	const ScriptInfo::RequestContext &	context,
		const IStyleInfo *	style,
		const IPMUnknown *	addAttribute = `nil`,
		ClassID	removeAttribute = `kInvalidClass`
	)

pure virtual

DEPRECATED: Use the version that doesn't pass ScriptInfo::RequestContext as a parameter. Create a command to change the attributes of a style

Parameters

context	- the scripting request context
style	- the style to edit
addAttribute	- an attribute to add (or nil for none)
removeAttribute	- an attribute to remove (or kInvalidClass for none)

virtual ICommand* IStyleUtils::CreateEditStyleCmd	(	const IStyleInfo *	style,
		const IPMUnknown *	addAttribute = `nil`,
		ClassID	removeAttribute = `kInvalidClass`
	)

pure virtual

Create a command to change the attributes of a style

Parameters

style	- the style to edit
addAttribute	- an attribute to add (or nil for none)
removeAttribute	- an attribute to remove (or kInvalidClass for none)

virtual void IStyleUtils::CreateUniqueName	(	IStyleNameTable *	pStyleTable,
		PMString &	sName,
		bool16	appendCopy = `kFalse`
	)

pure virtual

Return a unique style name within the specified style name table.

Parameters

pStyleTable	is the style name table in which to make sName unique
sName	is the base name("My Para "), a number is appended to make the name unique like "My Para 1".
appendCopy	is set to true if translated "Copy" should be appended to the sName separated by a space before making the name unquie by appending a number. Example: "My copy Para" -> "My copy Para copy n", "My Para copy" -> "My Para copy n", where n is a number appended.

virtual void IStyleUtils::CreateUniqueName	(	const IStyleGroupHierarchy *	hierarchy,
		PMString &	sName
	)

pure virtual

Returns a unique style name with in immediate children of a hierarchy.

Parameters

hierarchy	[IN] Style set hierarchy which is to be searched.
sName	[INOUT] sName is the base name(My Para), a number is appended to make the name unique like My Para 1.

virtual ErrorCode IStyleUtils::GetStyleRef	(	const ScriptInfo::RequestContext &	context,
		IScript *	script,
		const ScriptID &	propID,
		UIDRef &	styleRef
	)

pure virtual

Get the applied style

virtual void IStyleUtils::LogStyleApplied	(	IDataBase *	db,
		const UID	styleUID
	)

pure virtual

LogStyleApplied – logs the highbeam data that a paragraph style is applied

Parameters

db	- style data base - style UID

virtual IStyleGroupManager* IStyleUtils::QueryStyleGroupManager	(	const IScript *	script,
		const ScriptInfo::RequestContext &	context,
		const ScriptID &	desiredType
	)

pure virtual

Query the appropriate style set manager

virtual IStyleNameTable* IStyleUtils::QueryStyleNameTable	(	const IScript *	script,
		const ScriptInfo::RequestContext &	context,
		const ScriptID &	desiredType
	)

pure virtual

Query the appropriate style name table

Public Types

Public Member Functions

Detailed Description

Member Function Documentation