IInCopyDocUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: chris parrish
// 
// $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 __IInCopyDocUtils__
#define __IInCopyDocUtils__

#include "InCopyWorkflowID.h"
#include "IDocFileHandler.h"
#include "IOpenFileCmdData.h"

class IDataLink;
class IDocument;
class SysFileList;
class UIDList;
class ITextModel;
class INewDocCmdData;
class IInCopyImportOptions;

class IInCopyDocUtils : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IINCOPYDOCUTILS};

 //----- File Actions
 virtual void DoSave(const UIDRef& textModel, UIFlags uiFlags = kFullUI) = 0;

 virtual void DoSaveAll(const UIDRef& doc, UIFlags uiFlags = kFullUI) = 0;

 virtual void DoSaveAs(const UIDRef& doc, bool16 copy = kFalse, const IDFile *destFile = nil, UIFlags uiFlags = kFullUI, bool8 asStationary = kFalse, FileTypeInfoID fileTypeID = kInvalidFileTypeInfoID) = 0;

 virtual UIDRef DoOpen(const IDFile& filesToOpen, IOpenFileCmdData::OpenFlags flags, bool16 showWindow = kTrue, IDocument::UndoSupport undoSupport = IDocument::kFullUndoSupport, UIFlags = kFullUI) = 0;

 virtual UIDRef DoNew(bool16 openWin = kTrue, IDocument::UndoSupport undoSupport = IDocument::kFullUndoSupport) = 0;

 virtual void DoRevert(const UIDRef& doc, UIFlags uiFlags = kFullUI) = 0;

 virtual void DoUpdateDesign(const UIDRef& docRef, UIFlags uiFlags = kFullUI) = 0;

 virtual void DoNewWindow(const UIDRef& doc) = 0;

 virtual void DoClose(const UIDRef& doc, UIFlags uiFlags, bool16 allowCancel, IDocFileHandler::CloseCmdMode cmdMode) = 0;

 virtual IDocFileHandler* QueryDocFileHandler() = 0;
 
 virtual bool16 ShouldDoSaveAs(IDocument* doc) = 0;
 
 virtual bool16 CanDoSave(const UIDRef& doc) = 0;

 virtual bool16 CanDoSaveAll(const UIDRef& doc) = 0;

 virtual bool16 CanDoRevert(const UIDRef& doc) = 0;

 virtual bool16 CanDoUpdateDesign(const UIDRef& doc) = 0;

 virtual bool16 IsReadOnly(IDocument* iDoc) = 0;

 virtual void ExportAllLinkedStories(IDocument* doc, const FileTypeInfoID& fileTypeID, UIFlags uiFlags = kFullUI) = 0;

 virtual void ExportStoryAndCreateLink(const UIDRef& story, const IDFile& file, const FileTypeInfoID& fileTypeID) = 0;

 virtual ErrorCode ExportLinkedStory(const UIDRef& story, const FileTypeInfoID& fileTypeID) = 0;
 
 virtual void ImportAllLinkedStories(IDocument* doc, const FileTypeInfoID& fileTypeID, IInCopyImportOptions* options) = 0;

 virtual ErrorCode ImportStoryAndCreateLink(const UIDRef& story, IPMStream* stream, IInCopyImportOptions* options, const FileTypeInfoID& fileTypeID, bool16 createLink = kTrue, UIDRef *importedItem = nil) = 0;

 virtual ErrorCode ImportLinkedStory(const UIDRef& story, const FileTypeInfoID& fileTypeID, IInCopyImportOptions* options = nil) = 0;
 
 virtual UIDRef GetFirstUserStory(IDocument* doc) = 0;

 virtual void GetLinkedStories(IDocument* doc, UIDList* stories, UIDList* links, IDataBase* db = nil) = 0;

 virtual UIDRef CreateDefaultTextFrame(IDocument* doc) = 0;

 virtual UIDRef CreateDefaultGraphicFrame(IDocument* doc) = 0;

 virtual IDocFileHandler::CloseOptions 
 CheckOnClose(const UIDRef& doc, UIFlags uiFlags, bool8 allowCancel) = 0;

 virtual bool16 CheckOnRevertStory(const UIDRef& storyRef) = 0;
 
 virtual bool16 IsFileAlreadyOpen(const IDFile& file, UIDRef* doc, UIDRef* foundStory = nil) = 0;
 
 virtual void GetCopyDefaultName(const UIDRef& doc, IDFile *name, bool16& useSystemDefaultDir) = 0; 
 
 virtual bool16 GetOpenFileType(const IDFile& sysFile, SysOSType &type) = 0;

 virtual bool16 GetStreamFileType(IPMStream* stream, SysOSType &type) = 0;

 virtual void SetInCopyUserFile(IDocument *doc, const IDFile &newFile) = 0;
 
 virtual void LockNonInCopyStories(const UIDRef& doc) = 0;

};

#endif //__IInCopyDocUtils__