IXReferenceUID.h

//========================================================================================
// 
// $File$
// 
// Owner: Edmund Lui
// 
// $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.
// 
// 
// Data interface for copying page items.
// 
//========================================================================================

#ifndef __IXReferenceUID__
#define __IXReferenceUID__

#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "ISession.h"

class ICommand;

class IXReferenceUID : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IXREFERENCEUID };

 virtual int32 BeginXRefSession(IDataBase *pSrcDB, IDataBase *pDestDB) = 0;
 
 virtual int32 EndXRefSession() = 0;

 virtual IDataBase *GetSrcDB() = 0;
 
 virtual IDataBase *GetDestDB() = 0;

 // Need to migrate the functionality below into a reponder the responds
 virtual UID GetDestUID(IDataBase *pSrcDB, IDataBase *pDestDB, UID srcID) = 0;

 virtual void BindSrcAndDestUID(IDataBase *pSrcDB, IDataBase *pDestDB, UID srcUID, UID destUID) = 0;

 // NOT RECOMMENDED FOR CASUAL USE!
 // jwb 1/20/00: not yet ready for prime time; causes problems like 332917 and 334428
 // ddarling 7/9/04: Added back to the public interface for a nasty case with the object styles ref conversion which deletes 
 // a UID in a deferred command during the ending of the xref session. The problem is when the UID is
 // deleted we need to remove it from the XRef session cache
 virtual void UnbindSrcUID( IDataBase* pSrcDB, IDataBase* pDestDB, UID srcUID ) = 0 ; 
 
 virtual ICommand* GetDeferredCmd(IDataBase *pSrcDB, IDataBase *pDestDB, UID srcID) const = 0;

 virtual void BindDeferredCmd(IDataBase *pSrcDB, IDataBase *pDestDB, UID srcID, ICommand *pCmd) = 0;

} ;

class BeginEnd_XrefSession
{
 public:
 BeginEnd_XrefSession(IDataBase* srcDB, IDataBase* destDB):
 fXRef(GetExecutionContextSession(),IID_IXREFERENCEUID)
 {
 if ( fXRef )
 fXRef->BeginXRefSession(srcDB, destDB);
 }
 ~BeginEnd_XrefSession()
 {
 if ( fXRef )
 fXRef->EndXRefSession();
 }
 private:
 InterfacePtr<IXReferenceUID> fXRef; 
};

#endif // __IXReferenceUID__