ISelectionManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Martz
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================

#ifndef _ISelectionManager_
#define _ISelectionManager_
//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
 //.......Interface headers....................................................................
 #include "IPMUnknown.h"
 #include "ISelectionMessages.h"
 
 //.......ID headers...........................................................................
 #include "ShuksanID.h"

//________________________________________________________________________________________________
// DEFINES
//________________________________________________________________________________________________
//#define USE_ILDETASK_FOR_SELATTR_CHANGED 1
//#define USE_ILDETASK_FOR_SEL_CHANGED 1
//================================================================================================
//________________________________________________________________________________________________
// CLASS FORWARDS
//________________________________________________________________________________________________
 class SelectionMessage;
 class IConcreteSelection;
 class IDefaultCSB;
 class IDataBase;
 class PrivateSelectionAccess;
 class IActiveContext;
 class InternalSelectionMessage;
 class IdleTimer;
//________________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________________
class ISelectionManager : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Do Not copy this idiom
 //
 // DO NOT ADD FRIENDS TO THIS CLASS WITHOUT DISCUSSING IT WITH MICAHEL MARTZ
 //
 //____________________________________________________________________________________________
 friend class PrivateSelectionAccess;
 
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_ISELECTIONMANAGER };

 enum ConcreteBossListType { kEnabledCSBs, kDisabledCSBs, kDefaultCSB, kSelectionCSBs, kAllCSBs };
 enum ExistsType { kUniqueSelection, kMixedSelection, kAnySelection };
 enum InterfaceType { kEnabledInterface, kAnyInterface};

 typedef K2Vector<InterfacePtr<IPMUnknown> > ConcreteSelectionBossCollection; 
 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 //........................................................................................
 // Utility
 //........................................................................................
 virtual bool16 IsInterfaceEnabled (const PMIID& interfaceID) const = 0;
 
 virtual IPMUnknown* QueryIntegratorSuite (const PMIID& interfaceID, InterfaceType) const = 0;

 //........................................................................................
 // View Selection
 //........................................................................................
 virtual void Startup (IDataBase* db, const UIDRef& owner) = 0;
 virtual void Shutdown (void) = 0;
 
 virtual IDataBase* GetDataBase (void) const = 0;

 virtual UIDRef GetSelectionsOwner (void) const = 0; 

 virtual bool16 SelectionExists (ClassID, ExistsType = kAnySelection) const = 0;

#ifdef ID_DEPRECATED

 virtual IConcreteSelection* QueryConcreteSelectionBoss (ClassID) const = 0;
#endif // ID_DEPRECATED

 virtual void BroadcastMessage (SuiteBroadcastData*) const = 0;

 virtual void SelectAll (IActiveContext* iContext, K2Vector<ClassID>* csbList) const = 0;

 virtual void DeselectAll (K2Vector<ClassID>* csbList) const = 0;


 inline void DeselectAllNoBroadcast(K2Vector<ClassID>* csbList) const
 { //implement this to not notify selection observers so that the UI doesn't flash
 DeselectAll (csbList);
 }
 
 virtual void DeselectAllExcept (K2Vector<ClassID>* csbKeepList) const = 0;

 //........................................................................................
 // Internal Selection Utilities
 //........................................................................................
 virtual bool16 BroadcastQueuedMessages (IdleTimer*) = 0;

 virtual void CSBSelectionChanged (ISelectionMessage*, SuiteBroadcastData*) = 0;

 virtual void CSBHasQueuedMessages (ClassID, ISelectionMessage::SelectionMessageType) = 0;

 private:
 virtual IConcreteSelection* QueryConcreteSelectionBoss_Private (ClassID) const = 0;
 virtual IDefaultCSB* QueryDefaultSelectionBoss_Private (void) const = 0;
 virtual ConcreteSelectionBossCollection* QueryConcreteSelectionBosses_Private (ConcreteBossListType, const PMIID&) const = 0;
 };

#endif // _ISelectionManager_