Inheritance diagram for IPathStrokerUtils:

Public Types
enum	{ kDefaultIID = IID_IPATHSTROKERUTILS }

enum	StrokeStyleImportError { kErrorSuccess, kErrorFileDamaged, kFailedToCopyStroke, kErrorUnknown }

Public Member Functions
virtual uint32	GetPathStrokerCount (IDocument const *document) const =0

virtual IPathStroker *	QueryNthPathStroker (IDocument const *document, uint32 index) const =0

virtual IPathStrokerList *	QueryPathStrokerList (IDataBase *db) const =0

virtual IPathStrokerList *	QueryPathStrokerList (IDocument const *document) const =0

virtual IPathStrokerList *	_QueryActivePathStrokerList () const =0

virtual bool16	FindNamedPathStroker (IPathStrokerList const *strokerList, PMString const &name, uint32 &index, bool16 useTranslatedNames=kTrue) const =0

virtual bool16	FindPathStroker (IPathStrokerList const *strokerList, ClassID const &classId, UID const &uid, uint32 &index) const =0

virtual IPathStroker *	QueryPathStroker (IPathStrokerList const *strokerList, ClassID const &classId, UID const &uid) const =0

virtual IPathStroker *	QueryPathStrokerFromGSDesc (IPathStrokerList const strokerList, IGraphicStyleDescriptor gsDesc) const =0

virtual bool16	IsCustomStroker (IPathStroker const *stroker) const =0

virtual bool16	IsCustomStroker (ClassID const &classId, UID const &uid) const =0

virtual PMString	GetPathStrokerName (IPathStroker const *stroker, bool16 translateName=kTrue) const =0

virtual PMString	GetUniqueStrokerName (IPathStrokerList const *list, PMString const &basename) const =0

virtual IPathStrokerMetadata *	QueryPathStrokerMetadata (IPathStroker const *stroker) const =0

virtual IPathStrokerMetadata *	QueryPathStrokerMetadata (IPathStrokerList const *strokerList, ClassID const &classId, UID const &uid) const =0

virtual uint32	GetMetadataCount () const =0

virtual IPathStrokerMetadata *	QueryNthMetadata (uint32 index) const =0

virtual IPathStrokerMetadata *	QueryPathStrokerMetadataByClass (ClassID const &metadataClass) const =0

virtual IPathStrokerMetadata *	QueryPathStrokerMetadataByName (PMString const &name) const =0

virtual bool16	CanStrokerBeDuplicated (IPathStrokerList const *strokerList, ClassID const &classId, UID const &uid) const =0

virtual IPathStroker *	DuplicatePathStroker (IPathStrokerList const strokerList, ClassID const &classId, UID const &uid, IDataBase db, bool16 addToList) const =0

virtual IPathStroker *	DuplicatePathStroker (IPathStroker const source, IDataBase db, bool16 addToList) const =0

virtual IPathStroker *	NewPathStroker (IPathStrokerMetadata const metadata, IDataBase db, bool16 addToList) const =0

virtual ErrorCode	GetLineStyleUID (UID &uid, IGraphicStyleDescriptor *styleDesc) const =0

virtual IGraphicAttrClassID *	CreateLineStyleAttribute (UID const &styleUID) const =0

virtual ErrorCode	AddLineStyleAttribute (UID const &styleUID, IGraphicStyleAttributeBossList *attributeList) const =0

virtual ICommand *	CreateLineStyleCommand (UID const &styleUID, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify) const =0

virtual ErrorCode	ReplacePathStrokers (UIDList const &strokerList, ClassID const &replaceClass, UID const &replaceUID) const =0

virtual void	GetReferencedPathStrokers (IPathStrokerList const *strokerList, SortedUIDList &refdStrokers) const =0

virtual ErrorCode	SetPathStrokerName (IPathStroker *pathStroker, PMString const &name) const =0

virtual ErrorCode	DeleteAndReplacePathStroker (UIDList const &deleteList, ClassID const &replaceClass, UID const &replaceUID) const =0

virtual IPathStrokerUtils::StrokeStyleImportError	ImportStyles (IDFile const &file, IDataBase *destination) const =0

virtual IPathStrokerUtils::StrokeStyleImportError	ExportStyles (IDFile const &file, IDataBase *source, UIDList const &styles, SysOSType const &creator, SysOSType const &fileType) const =0

virtual IScript *	CreateStrokeStyleScriptObject (const ScriptInfo::RequestContext &context, IScript *parent, const ClassID &clsID) const =0

virtual ErrorCode	GetStrokeStyleForGetProperty (IScriptRequestData data, IScript script, const ScriptID &propID, IDataBase *db, const ClassID &classID, const UID &uid, bool16 returnName=kFalse) const =0

virtual ErrorCode	GetStrokeStyleForSetProperty (const IScriptRequestData data, const ScriptID &propID, IDataBase &db, ClassID &classID, UID &uid, bool16 allowNone=kFalse) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual IPathStrokerList* IPathStrokerUtils::_QueryActivePathStrokerList ( ) const

pure virtual

Queries active IPathStrokerList

Returns: AddRef'd pointer to path stroker list interface, or nil

virtual ErrorCode IPathStrokerUtils::AddLineStyleAttribute	(	UID const &	styleUID,
		IGraphicStyleAttributeBossList *	attributeList
	)		const

pure virtual

Adds style attribute to attribute list. Attribute is implicitly given a ClassID of kCustomPathStrokerBoss

Parameters

styleUID	The UID for the style
attributeList	The list

Returns: kSuccess if successful, else error code

virtual bool16 IPathStrokerUtils::CanStrokerBeDuplicated	(	IPathStrokerList const *	strokerList,
		ClassID const &	classId,
		UID const &	uid
	)		const

pure virtual

Determines if specified path stroker can be duplicated

Parameters

strokerList	The list
classId	The class id for the stroker
uid	The UID for the stroker

Returns: kTrue if the stroker can be duplicated, else kFalse

virtual IGraphicAttrClassID* IPathStrokerUtils::CreateLineStyleAttribute ( UID const & styleUID ) const

pure virtual

Creates new line style attribute. Attribute is implicitly given a ClassID of kCustomPathStrokerBoss.

Parameters

uid	The UID for the style

Returns: AddRef'd pointer to the attribute

virtual ICommand* IPathStrokerUtils::CreateLineStyleCommand	(	UID const &	styleUID,
		const UIDList *	targetItemList,
		bool16	doPrePost,
		bool16	enableDoNotify
	)		const

pure virtual

Creates command to install line style. Attribute is implicitly given a ClassID of kCustomPathStrokerBoss

Parameters

styleUID	The UID for the style
targetItemList	The target
doPrePost	kTrue if command should use pre/post actions
enableDoNotify	kTrue if command should notify

Returns: AddRef'd pointer to command interface, or nil

virtual IScript* IPathStrokerUtils::CreateStrokeStyleScriptObject	(	const ScriptInfo::RequestContext &	context,
		IScript *	parent,
		const ClassID &	clsID
	)		const

pure virtual

Built-in strokers aren't persistent, so need to create a proxy object for scripts

Parameters

context	is the request context
parent	is the parent script object
clsID	is the stroker class

Returns: IScript* is the proxy script object

virtual ErrorCode IPathStrokerUtils::DeleteAndReplacePathStroker	(	UIDList const &	deleteList,
		ClassID const &	replaceClass,
		UID const &	replaceUID
	)		const

pure virtual

Deletes and replaces path stroker

Parameters

deleteList	List of strokers to delete
replaceClass	Class ID for replacement
replaceUID	UID for replacement

virtual IPathStroker* IPathStrokerUtils::DuplicatePathStroker	(	IPathStrokerList const *	strokerList,
		ClassID const &	classId,
		UID const &	uid,
		IDataBase *	db,
		bool16	addToList
	)		const

pure virtual

Duplicates the given path stroker in the specified database. Does not set stroker's name, nor does it add the stroker to the database's stroker list.

Parameters

classId	The class id for the stroker
uid	The UID for the stroker
db	The database in which the stroker is duplicated
addToList	If kTrue, new stroker is added to database's list (its name is made unique)

Returns: The cloned path stroker

virtual IPathStroker* IPathStrokerUtils::DuplicatePathStroker	(	IPathStroker const *	source,
		IDataBase *	db,
		bool16	addToList
	)		const

pure virtual

Duplicates the given path stroker in the specified database. Does not set stroker's name, nor does it add the stroker to the database's stroker list.

Parameters

source	The path stroker to duplicate
db	The database in which the stroker is duplicated
addToList	If kTrue, new stroker is added to database's list (its name is made unique)

Returns: The cloned path stroker

virtual IPathStrokerUtils::StrokeStyleImportError IPathStrokerUtils::ExportStyles	(	IDFile const &	file,
		IDataBase *	source,
		UIDList const &	styles,
		SysOSType const &	creator,
		SysOSType const &	fileType
	)		const

pure virtual

Exports line styles to a file

Parameters

file	File to export styles to
destination	Document to export styles from
styles	List of styles to export
creator	Output file creator
fileType	Output file type

virtual bool16 IPathStrokerUtils::FindNamedPathStroker	(	IPathStrokerList const *	strokerList,
		PMString const &	name,
		uint32 &	index,
		bool16	useTranslatedNames = `kTrue`
	)		const

pure virtual

Finds named path stroker in list, returning its index if found

Parameters

strokerList	The list to be searched
name	Name of stroker to find
index	OUT param: index of found item if successful
useTranslatedNames	Whether to translate stroker names before compare (default is kTrue)

Returns: kTrue if specified stroker was found, else kFalse

virtual bool16 IPathStrokerUtils::FindPathStroker	(	IPathStrokerList const *	strokerList,
		ClassID const &	classId,
		UID const &	uid,
		uint32 &	index
	)		const

pure virtual

Retrieves index of path stroker with given class ID and UID in the given list

Parameters

strokerList	The list to be searched
classId	Class id of stroker
uid	UID of stroker
index	OUT param: index of found item if successful

Returns: kTrue if specified stroker was found, else kFalse

virtual ErrorCode IPathStrokerUtils::GetLineStyleUID	(	UID &	uid,
		IGraphicStyleDescriptor *	styleDesc
	)		const

pure virtual

Gets the line style UID from graphic style descriptor

Parameters

uid	OUT param: The UID in the descriptor, if successful
styleDesc	The style descriptor

Returns: kSuccess if successful, else error code

virtual uint32 IPathStrokerUtils::GetMetadataCount ( ) const

pure virtual

Returns the number of path stroker metadata class known to the application. This number is determined by counting available metadata services and is consequently static

Returns: the number of available path stroker metadata classes

virtual uint32 IPathStrokerUtils::GetPathStrokerCount ( IDocument const * document ) const

pure virtual

Get number of path strokers for the specified document

Parameters

document The document to be checked

Returns: The number of path strokers in the document

virtual PMString IPathStrokerUtils::GetPathStrokerName	(	IPathStroker const *	stroker,
		bool16	translateName = `kTrue`
	)		const

pure virtual

Returns name for the stroker. If path stroker is custom, returns the name for the stroker instance; otherwise, returns the name for the stroker class

Parameters

stroker	The name of the path stroker
translateName	Whether to translate the name returned (default is kTrue)

Returns: its name

virtual void IPathStrokerUtils::GetReferencedPathStrokers	(	IPathStrokerList const *	strokerList,
		SortedUIDList &	refdStrokers
	)		const

pure virtual

Retrieves list of referenced path strokers in the specified list

Parameters

strokerList	The path stroker list to search
refdStrokers	The list of referenced strokers

virtual ErrorCode IPathStrokerUtils::GetStrokeStyleForGetProperty	(	IScriptRequestData *	data,
		IScript *	script,
		const ScriptID &	propID,
		IDataBase *	db,
		const ClassID &	classID,
		const UID &	uid,
		bool16	returnName = `kFalse`
	)		const

pure virtual

Set the stroke style for a script object into the return data for a get property request

Parameters

data	is the script event data [in/out]
db	is the database of the script object [in]
classID	is the ClassID of the line type [in] (see )
uid	is the UID of custom line type [in]
returnName	if true, will return the name of the stroke style instead of the object

virtual ErrorCode IPathStrokerUtils::GetStrokeStyleForSetProperty	(	const IScriptRequestData *	data,
		const ScriptID &	propID,
		IDataBase *&	db,
		ClassID &	classID,
		UID &	uid,
		bool16	allowNone = `kFalse`
	)		const

pure virtual

Get the stroke style specified by parameter data for a set property request

Parameters

data	is the script event data [in]
propID	is the property id [in]
db	is the database of the script object (reset to the database of the stroke style object) [in/out]
classID	is the ClassID of the line type [out] (see )
uid	is the UID of custom line type [out]
allowNone	if true, will return kNonePathStrokerBoss if parameter is empty, nil, or Nothing

virtual PMString IPathStrokerUtils::GetUniqueStrokerName	(	IPathStrokerList const *	list,
		PMString const &	basename
	)		const

pure virtual

Returns a unique name based on given base. Uses same heuristic as is used in the swatch panel (appends 'copy', then 'copy 2', 'copy 3', etc., as necessary)

Parameters

strokerList	The list
basename	Name used as the base for the calculated name

Returns: New name guaranteed to be unique in the specified list

virtual IPathStrokerUtils::StrokeStyleImportError IPathStrokerUtils::ImportStyles	(	IDFile const &	file,
		IDataBase *	destination
	)		const

pure virtual

Imports line styles from a file

Parameters

file	File to import styles from
destination	Document to import styles into

virtual bool16 IPathStrokerUtils::IsCustomStroker ( IPathStroker const * stroker ) const

pure virtual

Returns kTrue if stroker is custom

Parameters

stroker The stroker

Returns: kTrue if stroker is custom, else kFalse if it's built-in

virtual bool16 IPathStrokerUtils::IsCustomStroker	(	ClassID const &	classId,
		UID const &	uid
	)		const

pure virtual

Returns kTrue if stroker is custom

Parameters

classId	Class id of stroker
uid	UID of stroker

Returns: kTrue if stroker is custom, else kFalse if it's built-in

virtual IPathStroker* IPathStrokerUtils::NewPathStroker	(	IPathStrokerMetadata const *	metadata,
		IDataBase *	db,
		bool16	addToList
	)		const

pure virtual

Creates new instance of path stroker based on metadata

Parameters

metadata	The path stroker metadata to use to create the new instance
db	The database in which the stroker is duplicated
addToList	If kTrue, new stroker is added to database's list (its name is made unique)

Returns: The new path stroker

virtual IPathStrokerMetadata* IPathStrokerUtils::QueryNthMetadata ( uint32 index ) const

pure virtual

Queries for path stroker metadata interface by index

Parameters

index The index

Returns: AddRef'd pointer to path metadata interface, or nil

virtual IPathStroker* IPathStrokerUtils::QueryNthPathStroker	(	IDocument const *	document,
		uint32	index
	)		const

pure virtual

Instantiates nth path stroker for the specified document

Parameters

document	The document
index	Index of the path stroker to instantiate

Returns: AddRef'd pointer to nth stroker, or nil if failure

virtual IPathStroker* IPathStrokerUtils::QueryPathStroker	(	IPathStrokerList const *	strokerList,
		ClassID const &	classId,
		UID const &	uid
	)		const

pure virtual

Queries for a path stroker given its ClassID and UID

Parameters

strokerList	The list
classId	Class id of stroker
uid	UID of stroker

Returns: AddRef'd pointer to stroker, or nil

virtual IPathStroker* IPathStrokerUtils::QueryPathStrokerFromGSDesc	(	IPathStrokerList const *	strokerList,
		IGraphicStyleDescriptor *	gsDesc
	)		const

pure virtual

Queries for a path stroker based on a graphic style descriptor

Parameters

strokerList	Path stroker list
gsDesc	The style descriptor

Returns: AddRef'd pointer to stroker, or nil

virtual IPathStrokerList* IPathStrokerUtils::QueryPathStrokerList ( IDataBase * db ) const

pure virtual

Queries for IPathStrokerList interface on given database

Parameters

db	The database

Returns: AddRef'd pointer to path stroker list interface, or nil

virtual IPathStrokerList* IPathStrokerUtils::QueryPathStrokerList ( IDocument const * document ) const

pure virtual

Queries for IPathStrokerList interface on given document

Parameters

document The database

Returns: AddRef'd pointer to path stroker list interface, or nil

virtual IPathStrokerMetadata* IPathStrokerUtils::QueryPathStrokerMetadata ( IPathStroker const * stroker ) const

pure virtual

Queries for path stroker's metadata, if it has one. Returns nil if not a custom stroker

Parameters

stroker The path stroker

Returns: AddRef'd pointer to path stroker metadata interface, or nil

virtual IPathStrokerMetadata* IPathStrokerUtils::QueryPathStrokerMetadata	(	IPathStrokerList const *	strokerList,
		ClassID const &	classId,
		UID const &	uid
	)		const

pure virtual

Queries for path stroker's metadata, if it has one. Returns nil if not a custom stroker

Parameters

strokerList	The list
classId	Class id of stroker
uid	UID of stroker

Returns: AddRef'd pointer to path stroker metadata interface, or nil

virtual IPathStrokerMetadata* IPathStrokerUtils::QueryPathStrokerMetadataByClass ( ClassID const & metadataClass ) const

pure virtual

Queries for path stroker metadata by class id

Parameters

metadataClass The class id for the metadata

Returns: AddRef'd pointer to path metadata interface, or nil

virtual IPathStrokerMetadata* IPathStrokerUtils::QueryPathStrokerMetadataByName ( PMString const & name ) const

pure virtual

Queries for path stroker metadata by name

Parameters

name	The name of the metadata

Returns: AddRef'd pointer to path metadata interface, or nil

virtual ErrorCode IPathStrokerUtils::ReplacePathStrokers	(	UIDList const &	strokerList,
		ClassID const &	replaceClass,
		UID const &	replaceUID
	)		const

pure virtual

Replaces instances of path strokers with new instance

Parameters

strokerList	UIDList of path strokers to replace
replaceClass	ClassID of path stroker to replace with
replaceUID	UID of path stroker to replace with

Returns: ErrorCode describing success/failure of function

virtual ErrorCode IPathStrokerUtils::SetPathStrokerName	(	IPathStroker *	pathStroker,
		PMString const &	name
	)		const

pure virtual

Sets the name of a path stroker

Parameters

pathStroker	The path stroker
name	New name

Returns: kSuccess, or ErrorCode

Public Types

Public Member Functions

Member Function Documentation