IRIDXNotifierUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Danielle Darling
// 
// $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 __IRIDXNOTIFIERUTILS__
#define __IRIDXNOTIFIERUTILS__

#include "IPMUnknown.h"
#include "IRIDX.h"
#include "IRIDXNotifierHandler.h"
#include "AppFrameworkID.h"
#include "K2SmartPtr.h"
#include "Utils.h"

// ===================================================================================
// class IRIDXNotifierUtils 
// ===================================================================================
class RIDXNotifierCacheData
{
public:
 RIDXNotifierCacheData ():
 fRIDXQuery (nil), fTargetClassID (kInvalidClass) {}
 
 ~RIDXNotifierCacheData () 
 {
 if (fRIDXQuery != nil) fRIDXQuery->Release ();
 }

public:
 boost::shared_ptr<K2Vector<InterfacePtr<IRIDXNotifierHandler> > > fHandlers;
 IRIDXQuery* fRIDXQuery;
 ClassID fTargetClassID;
};

class IRIDXNotifierUtils : public IPMUnknown
{
public:
 // ----- Constants -----
 enum {kDefaultIID = IID_IRIDXNOTIFIERUTILS};

 virtual void BeingDeleted(IDataBase *db, UID targetUID, const IPMUnknown* iDataForDeleting) const = 0;

 virtual void BeingDeleted(IDataBase *db, const UIDList& targetUIDList, const IPMUnknown* iDataForDeleting) const = 0;

 virtual void WillBeModified(IDataBase *db, UID targetUID, const IPMUnknown* iDataForModifying) const = 0;

 virtual void WillBeModified(IDataBase *db, const UIDList& targetUIDList, const IPMUnknown* iDataForModifying) const = 0;

 virtual bool16 IsActivelyUsed(IDataBase *db, UID targetUID, const IPMUnknown* iOptionData = nil, RIDXNotifierCacheData* pNotifierCache = nil) const = 0;

 virtual void SwatchesWillBeConvertedLocalToGlobal (IDataBase *db, const UIDList& targetUIDList, const IPMUnknown* iData) const = 0;
};

#endif