IAssignmentUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Jon Pugh
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Functions to aid in InCopy Document file actions
// 
//========================================================================================

#ifndef __IAssignmentUtils__
#define __IAssignmentUtils__

#include "AssignmentID.h"
#include "Utils.h"

#include "KeyValuePair.h"

class IAssignment;
class IAssignedStory;
class IAssignedDocument;
class IHierarchy;
class IScript;
class ITextFrameColumn;


class IAssignmentUtils : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IASSIGNMENTUTILS};

 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;
};

#endif //__IAssignmentUtils__