ISubject.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 __ISUBJECT__
#define __ISUBJECT__

#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "K2SmartPtr.h"
#include "LazyNotificationData.h"

class IObserver;
class IChangeManager;
class IDataBase;
struct void_type
{};


//----------------------------------------------------------------------------------------
// Class ISubject
//----------------------------------------------------------------------------------------

class ISubject : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISUBJECT };
 
 virtual bool16 IsAttached(IObserver* observer, 
 const PMIID& interestedIn,
 const PMIID& asObserver = IID_IOBSERVER) = 0;

 virtual void AttachObserver(IObserver* observer,
 const PMIID& interestedIn,
 const PMIID& asObserver = IID_IOBSERVER) = 0;

 virtual void DetachObserver(IObserver* observer,
 const PMIID& interestedIn,
 const PMIID& asObserver = IID_IOBSERVER) = 0;

 virtual void Change(ClassID theChange, const PMIID& interestedIn = IID_IUNKNOWN, void* changedBy = nil) = 0;

 virtual void Change(ISubject* originalSubject, ClassID theChange, const PMIID& interestedIn = IID_IUNKNOWN, void* changedBy = nil) = 0;

 virtual void Mute(bool16 muteOn) = 0;

 virtual bool16 IsMuted() const = 0;

 virtual IChangeManager* GetChangeManager() const = 0;

 
 virtual void ModelChange(ClassID theChange, const PMIID& interestedIn, 
 void* changedBy = nil, LazyNotificationData* data = nil) = 0;

 virtual void ModelChange(ISubject* originalSubject, ClassID theChange, const PMIID& interestedIn, 
 void* changedBy = nil, LazyNotificationData* data = nil) = 0;

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

 enum AttachmentType
 {
 kRegularAttachment = 0, 
 kLazyAttachment, 
 kBothAttachments
 } ;

 virtual bool16 IsAttached(AttachmentType attachType, IObserver* observer, const PMIID& interestedIn, const PMIID& asObserver) = 0;

 virtual void AttachObserver(AttachmentType attachType, IObserver* observer, const PMIID& interestedIn, const PMIID& asObserver) = 0;

 virtual void DetachObserver(AttachmentType attachType, IObserver* observer, const PMIID& interestedIn, const PMIID& asObserver) = 0;
};

#endif