IDocument.h

//========================================================================================
// 
// $File$
// 
// Owner: jack_kirstein
// 
// $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.
// 
//========================================================================================

#ifndef __IDOCUMENT__
#define __IDOCUMENT__

#include "PMTypes.h"
#include "DocumentID.h"
#include "AsyncWork.h"

class PMString;

class IDocument : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IDOCUMENT };
 enum class saveType {kNativeType=0,kCloudType};
 enum UndoSupport {
 kFullUndoSupport,
 kPartialUndoSupport
 };


 virtual void Save() = 0;
 

 virtual void SaveAs(const IDFile& destFile) = 0;
 

 virtual void SaveACopy(const IDFile& destFile) = 0;
 

 virtual void Close() = 0;
 
 virtual bool16 IsSaved() = 0;
 

 virtual bool16 IsRecovered() = 0;
 
 virtual bool16 IsConverted() = 0;

 virtual void SetConverted() = 0;
 

 virtual bool16 IsReadOnly() = 0;
 
 virtual bool16 IsMissingPlugins() = 0;
 

 virtual void SetMissingPlugins() = 0;
 
 virtual bool16 IsModified() = 0;
 

 virtual void GetName(PMString& name) const = 0;
 
 virtual void SetName(const PMString& name) = 0;


 virtual UIDRef GetDocWorkSpace() const = 0; 

 virtual UndoSupport GetUndoSupport() const = 0;

 virtual int32 GetUntitledCount() const = 0;

 virtual void SetUntitledCount(int32 untitledCount) = 0;
 
 virtual bool16 IsCloudDoc() const = 0;

 virtual void NotifyDocBasedAsyncJobQueued(AsyncWorkPacketID packetId) = 0;
 virtual void SetAsCloudDoc() = 0;

 virtual void SetAssetRefForThisDoc(const std::string & assetRef) = 0;
 virtual std::string GetAssetRefForThisDoc() const = 0;
 virtual bool IsDocumentConflicted() const =0;
 virtual void SetIsDocumentConflicted(const bool conflicted) =0;
 virtual void SaveAsCloudDoc(const IDFile& path ,const std::string& docPathValue) =0;
 virtual void SaveCloudDoc()=0;
 virtual bool IsDocumentSyncedOnce() const =0;
 virtual void SetIsDocumentSynced(const bool syncedonce)=0;
 virtual void SaveCloudDocAsNative(const IDFile& destFile)=0;

};

#endif // __IDOCUMENT__