IActiveContext.h

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

#include "IPMUnknown.h"

#include "K2Vector.h"
#include "KeyValuePair.h"

#include "DocumentID.h"
#include "ShuksanID.h"
#include "widgetid.h"
#include "WorkspaceID.h"

class IDocument;
class ISelectionManager;
class IControlView;
class IWorkspace;
class ISubject;

class IActiveContext : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IACTIVECONTEXT };

 IDocument* GetContextDocument() const { return (IDocument*)GetContextInterface(IID_IDOCUMENT); } ;
 ISelectionManager* GetContextSelection() const { return (ISelectionManager*)GetContextInterface(IID_ISELECTIONMANAGER); } ;
 IControlView* GetContextView() const { return (IControlView*)GetContextInterface(IID_ICONTROLVIEW); } ;
 IWorkspace* GetContextWorkspace() const { return (IWorkspace*)GetContextInterface(IID_IWORKSPACE); } ;

 virtual IPMUnknown* GetContextInterface( const PMIID& id ) const = 0 ; 

 // When the context is changed, observers are notified and the "changedBy" parameter
 // passed to the Observer's Update method is a pointer to a ContextInfo.
 // The PMIID field holds the PMIID of the protocol that was changed.
 // The IPMUnknown* field holds the previous value of the active context for the PMIID.
 // NOTE: Old code casts the "changedBy" parameter to be a pointer to a PMIID and
 // uses the PMIID, so it's important that the first field in this class is the PMIID.
 // All code should be migrated to expecting a pointer to a ContextInfo class,
 // rather than the old (const PMIID*), but both will work for now.
 typedef KeyValuePair<PMIID, IPMUnknown*> ContextInfo;
 typedef K2Vector<ContextInfo> ContextTable;

 virtual void GetContextInterfaces( ContextTable& table ) const = 0;
 virtual void SetContextInterfaces( const ContextTable& table ) = 0;
 virtual void ChangeContextInterfaces( const ContextTable& table ) = 0;

 virtual void SetContextDelegate( IActiveContext* newDelegate ) = 0;
 virtual bool16 IsContextDelegate( IActiveContext* am_I_your_delegate ) const = 0;
};

#endif