Inheritance diagram for ITrapStyleUtils:

Public Types
enum	{ kDefaultIID = IID_ITRAPSTYLEUTILS }

Public Member Functions
virtual ITrapStyleListMgr *	QueryTrapStyleListMgr (IDocument *doc)=0

virtual ITrapStyleListMgr *	QueryTrapStyleListMgr (const UIDRef &listRef)=0

virtual ErrorCode	AssignStyleToPageList (const UIDList &pageUIDList, UIDRef trapStyleRef)=0

virtual ErrorCode	ReplaceAndDeleteTrapStyles (ITrapStyleListMgr iListMgr, K2Vector< int32 > &styleIndexList, bool16 doReplacement=kFalse, const UIDList pPageUIDList=nil, const UIDRef *pReplacmentStyleRef=nil)=0

virtual UIDList	GetDocumentTrapStylePageList (IDocument *, const K2Vector< PMString > &)=0

virtual void	BuildDocumentPageTrapStyleUsageInfo (IDocument *iDoc, const K2Vector< PMString > &trapStyleList, PMString &trapStyleUseSummaryText)=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

An utility interface for trap styles.

Member Function Documentation

virtual ErrorCode ITrapStyleUtils::AssignStyleToPageList	(	const UIDList &	pageUIDList,
		UIDRef	trapStyleRef
	)

pure virtual

Assign the specified trap style to the list of pages.

Parameters

pageUIDList	list of page UIDs.
trapStyleRef	is the trap style to assign.

virtual void ITrapStyleUtils::BuildDocumentPageTrapStyleUsageInfo	(	IDocument *	iDoc,
		const K2Vector< PMString > &	trapStyleList,
		PMString &	trapStyleUseSummaryText
	)

pure virtual

Build a summary text containing the document's trap style usages.

Parameters

trapStyleList	specifies the list of trap styles
trapstyleUseSummaryText	is the string containing the usage information for the specified trap styles.

virtual UIDList ITrapStyleUtils::GetDocumentTrapStylePageList	(	IDocument *	,
		const K2Vector< PMString > &
	)

pure virtual

Get a page list (UIDList) in the specified document whose assigned trap style matches the specified trap stye list.

Parameters

iDoc	is the document
styleIndexList	is the list of trap styles

virtual ITrapStyleListMgr* ITrapStyleUtils::QueryTrapStyleListMgr ( IDocument * doc )

pure virtual

Returns the trap style list manager for the specified document.

Parameters

doc	is the document.

virtual ITrapStyleListMgr* ITrapStyleUtils::QueryTrapStyleListMgr ( const UIDRef & listRef )

pure virtual

Returns the trap style list manager for the specified list UIDRef.

Parameters

listRef specifies the UIDRef of the trap style list. If UIDRef is UIDRef::gNull then the session workspace's trap style list manager is returned.

virtual ErrorCode ITrapStyleUtils::ReplaceAndDeleteTrapStyles	(	ITrapStyleListMgr *	iListMgr,
		K2Vector< int32 > &	styleIndexList,
		bool16	doReplacement = `kFalse`,
		const UIDList *	pPageUIDList = `nil`,
		const UIDRef *	pReplacmentStyleRef = `nil`
	)

pure virtual

Delete the specified trap styles specified by styleIndexList.

Parameters

iListMgr	is the trap style list manager to use
styleIndexList	is the list of styles to delete
doReplacement	if set to true, the replacement trap style is assigned to the specified page list before deleting the trap styles.
pPageUIDList	is the list of page UIDs
pRelacementStyleRef	ist he replacement trap style