#include <IAssignmentUtils.h>

Inheritance diagram for IAssignmentUtils:

Public Types
enum	{ kDefaultIID = IID_IASSIGNMENTUTILS }

Public Member Functions
virtual IAssignment *	GetAssignment (const IScript *script)=0

virtual IAssignedStory *	GetStory (const IScript *script)=0

virtual void	NormalizeTextModelRef (UIDRef &ref)=0

virtual bool16	IsDataBaseOpen (IDataBase *db)=0

virtual UIDRef	GetParent (UIDRef object)=0

virtual UID	TextFrameToGraphicFrame (ITextFrameColumn *frame)=0

virtual UID	TextFrameToGraphicFrame (IHierarchy *frame)=0

virtual UID	TextFrameToGraphicFrame (const UIDRef &frame)=0

virtual UID	GraphicFrameToTextFrame (IHierarchy *frame, bool16 bFirstFrame)=0

virtual UID	GraphicFrameToTextFrame (const UIDRef &frame, bool16 bFirstFrame)=0

virtual PMString	GetDefaultAssignmentFolder (IDataBase *db)=0

virtual bool16	IsAssignmentFileTypeID (const FileTypeInfoID &fileTypeID) const =0

virtual bool16	IsAssignmentFileExtension (const PMString &fileExt) const =0

virtual bool16	IsInCopyAssignmentPackageFileTypeID (const FileTypeInfoID &fileTypeID) const =0

virtual bool16	IsInDesignAssignmentPackageFileTypeID (const FileTypeInfoID &fileTypeID) const =0

virtual bool16	StoryFormatCompatible (IAssignment *toAssignment, UIDRef storyRef) 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

Detailed Description

Utilities relating to assignments.

See Also: IAssignmentMgr

Member Function Documentation

virtual IAssignment* IAssignmentUtils::GetAssignment ( const IScript * script )

pure virtual

Get the assignment for a particular IScript object.

Parameters

script - The IScript object provided by the scripting subsystem.

Returns: - The assignment, or nil if things are not going according to plan

virtual PMString IAssignmentUtils::GetDefaultAssignmentFolder ( IDataBase * db )

pure virtual

Given a database, determines the default assignment folder. This is a folder in the same location as the InDesign document name after the InDesign document with " Assignments" appended. Example: c:.indd, default assignement folder would be c: Assignments.

Parameters

db	- Database of the InDesign document.

Returns: - The default folder name.

virtual UIDRef IAssignmentUtils::GetParent ( UIDRef object )

pure virtual

Given a UIDRef, find out its parent on Assignment Manager structure. If object is a kAssignedStoryBoss, return its parent kAssignmentBoss UIDRef. If object is a kAssignmentBoss, return its parent kDocBoss UIDRef. If object is none of above, return UIDRef::gNull.

Parameters

object

Returns: - the parent UIDRef of the object

virtual IAssignedStory* IAssignmentUtils::GetStory ( const IScript * script )

pure virtual

Get the assigned story for a particular IScript object.

Parameters

script - The IScript object provided by the scripting subsystem.

Returns: - The assigned story, or nil if things are not going according to plan

virtual UID IAssignmentUtils::GraphicFrameToTextFrame	(	IHierarchy *	frame,
		bool16	bFirstFrame
	)

pure virtual

Finds the UID of the text frame contained by a graphic frame, optionally finding the first frame of the text thread instead of the supplied frame.

Parameters

frame	- The graphic frame's IHierarchy interface.
bFirstFrame	- A boolean indicating whether the first text frame is desired.

Returns: - The UID of the text frame.

virtual UID IAssignmentUtils::GraphicFrameToTextFrame	(	const UIDRef &	frame,
		bool16	bFirstFrame
	)

pure virtual

Finds the UID of the text frame contained by a graphic frame, optionally finding the first frame of the text thread instead of the supplied frame.

Parameters

frame	- The graphic frame's UIDRef.
bFirstFrame	- A boolean indicating whether the first text frame is desired.

Returns: - The UID of the text frame.

virtual bool16 IAssignmentUtils::IsAssignmentFileExtension ( const PMString & fileExt ) const

pure virtual

Tests if a specified file extension is for an Assignment document filetype (*.inca *.icma).

Parameters

fileExt is a file extension.

Returns: kTrue if the file extension is for an Assignment document file; kFalse otherwise.

virtual bool16 IAssignmentUtils::IsAssignmentFileTypeID ( const FileTypeInfoID & fileTypeID ) const

pure virtual

Tests if a specified FileTypeInfoID is for an Assignment document filetype (*.inca *.icma).

Parameters

fileTypeID is a FileTypeInfoID.

Returns: kTrue if the fileTypeID is for an Assignment document file; kFalse otherwise.

virtual bool16 IAssignmentUtils::IsDataBaseOpen ( IDataBase * db )

pure virtual

Walks the open document list to see if the given database is still open.

Parameters

db	- A database pointer which may or may not still be open

Returns: - whether or not this database is still open

virtual bool16 IAssignmentUtils::IsInCopyAssignmentPackageFileTypeID ( const FileTypeInfoID & fileTypeID ) const

pure virtual

Tests if a specified FileTypeInfoID is for an InCopy Assignment package filetype (*.incp *.icap).

Parameters

fileTypeID is a FileTypeInfoID.

Returns: kTrue if the fileTypeID is for an InCopy Assignment package file; kFalse otherwise.

virtual bool16 IAssignmentUtils::IsInDesignAssignmentPackageFileTypeID ( const FileTypeInfoID & fileTypeID ) const

pure virtual

Tests if a specified FileTypeInfoID is for an InDesign Assignment package filetype (*.indp *.idap).

Parameters

fileTypeID is a FileTypeInfoID.

Returns: kTrue if the fileTypeID is for an InDesign Assignment package file; kFalse otherwise.

virtual void IAssignmentUtils::NormalizeTextModelRef ( UIDRef & ref )

pure virtual

Given a frame, this will figure out if it contains a text model and change the reference to point at that instead.

Parameters

ref	- IN/OUT the spline which may become a text model

virtual bool16 IAssignmentUtils::StoryFormatCompatible	(	IAssignment *	toAssignment,
		UIDRef	storyRef
	)		const

pure virtual

Tests if a the format type of the specified story is compatible with the specified assignment. That is, INCX and INCD are compatible with IAssignment::kAssignmentCS3Compatibility and ICML are compatibile with IAssignment::kAssignmentCS4Compatibility. All story formats are compatible with Unassigned Stories assignment.

Parameters

toAssignment	Assignment whose compatibility so compared
storyRef	UIDRef of the story whose format type is compared.

Returns: bool16 Return kTrue if the format type is compatibile with the assignment compatibility; kFalse otherwise.

See Also: IAssignment::AssignmentCompatibility

virtual UID IAssignmentUtils::TextFrameToGraphicFrame ( ITextFrameColumn * frame )

pure virtual

Returns the UID of the graphic frame of the text frame.

Parameters

frame - The ITextFrameColumn to find the graphic frame from.

Returns: - The UID of the IGraphicFrameData

virtual UID IAssignmentUtils::TextFrameToGraphicFrame ( IHierarchy * frame )

pure virtual

Returns the UID of the graphic frame of the IHierarchy frame.

Parameters

frame - The IHierarchy to find the graphic frame from.

Returns: - The UID of the IGraphicFrameData

virtual UID IAssignmentUtils::TextFrameToGraphicFrame ( const UIDRef & frame )

pure virtual

Returns the UID of the graphic frame of the frame.

Parameters

frame - The frame UIDRef to find the graphic frame from.

Returns: - The UID of the IGraphicFrameData

Public Types

Public Member Functions

Detailed Description

Member Function Documentation