IChangeManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Lonnie Millett
// 
// $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 __ICHANGEMANAGER__
#define __ICHANGEMANAGER__

#ifndef __PMTYPES__
#include "PMTypes.h"
#endif

#include "IPMUnknown.h"
#include "ShuksanID.h" // IID_ICHANGEMANAGER

//----------------------------------------------------------------------------------------
// Typedefs
//----------------------------------------------------------------------------------------

typedef int32 DependencyLabels;
 // The valid range of labels

//----------------------------------------------------------------------------------------
// Constants
//----------------------------------------------------------------------------------------

const DependencyLabels kNoLabel = 0;

//----------------------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------------------
class ISubject;
class IObserver;
class IPMUnknown;
class LazyNotificationData;
//----------------------------------------------------------------------------------------
// IChangeManager: Abstract Superclass of change managers
//----------------------------------------------------------------------------------------

class IChangeManager : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ICHANGEMANAGER };
 
 virtual void AddDependency(ISubject* subject, IObserver* observer,
 const PMIID& observerIID, const PMIID& interestedIn,
 bool lazy) = 0;
 
 virtual void RemoveDependency(ISubject* subject, IObserver* observer,
 const PMIID& observerIID, const PMIID& interestedIn,
 bool lazy) = 0;
 
 virtual bool16 HasDependency(ISubject* subject, IObserver* observer,
 const PMIID& observerIID, const PMIID& interestedIn,
 bool lazy) = 0;

 virtual void RemoveSubject(ISubject* theSubject) = 0;

 virtual void RemoveObserver(IObserver* theObserver, const PMIID& observerIID) = 0;

 virtual void RemoveSubject(const UIDRef& theSubject) = 0;

 virtual void RemoveObserver(const UIDRef& theObserver, const PMIID& observerIID) = 0;

 virtual void SubjectChanged(ISubject* subject, ClassID theChange,
 const PMIID& interestedIn, void* changedBy) = 0;
 
 //-------------------------------------------------------------------------------


 /* Similar to the previous method but this one lets you start the dependency notification
 part way along the dependecy chain, i.e. with subject's observers but notifying them that
 it was in fact originalSubject that changed. */
 virtual void SubjectChanged(ISubject* originalSubject, ISubject* subject, 
 ClassID theChange, const PMIID& interestedIn, void* changedBy) = 0;

 virtual void SubjectModelChanged(ISubject* subject, IDataBase* model, 
 ClassID theChange, const PMIID& interestedIn, 
 void* changedBy, LazyNotificationData* data) = 0;

 virtual void SubjectModelChanged(ISubject* originalSubject, ISubject* subject, IDataBase* model, 
 ClassID theChange, const PMIID& interestedIn, 
 void* changedBy, LazyNotificationData* data) = 0;

 virtual void LazySubjectChanged(ISubject* subject, const PMIID& interestedIn, 
 const LazyNotificationData* data) = 0;

#ifdef DEBUG
 // returns IID that observer is attached to.
 virtual PMIID IsObserverAttached(IObserver* theObserver, const PMIID& observerIID) = 0;
 virtual void Dump() = 0;
#endif

 virtual bool16 CanSendMessage() const = 0;

 protected:
 IChangeManager();

};

//----------------------------------------------------------------------------------------
// inlines
//----------------------------------------------------------------------------------------

//----------------------------------------------------------------------------------------
// IChangeManager constructor 
//----------------------------------------------------------------------------------------

inline IChangeManager::IChangeManager()
{
}


#endif