IConcreteSelection.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: This is the primary interface on the concrete selection boss. Before
// the boss can be used, it must be initialized. This is done by calling Initialize()
// on this interface (the implementations are responsible for initializing any other
// interfaces which may need this service).
// 
//========================================================================================

#ifndef _IConcreteSelection_
#define _IConcreteSelection_
//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
 #include "IPMUnknown.h"
 #include "PMCollection.h"
 #include "ISelectionManager.h"
 #include "ShuksanID.h"
 #include "K2Vector.h"
 #include "ISelectionMessages.h"
//================================================================================================
//________________________________________________________________________________________________
// CLASS FORWARDS
//________________________________________________________________________________________________
 class IControlView;
 class IDataBase;
 class ISelectionManager;
//________________________________________________________________________________________________
// TYPEDEFS
//________________________________________________________________________________________________
 typedef K2Vector<PMIID> SuiteIIDCollection; 
 enum {kDontNotifySuites = kFalse, kNotifySuites = kTrue};
//________________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________________
class IConcreteSelection : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_ICONCRETESELECTION };

 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 virtual void Startup (IDataBase* database, const UIDRef& owningView) = 0;

 virtual void Shutdown (void) = 0;

 virtual IDataBase* GetDataBase (void) const = 0;

 //........................................................................................
 // Selection Utilities
 //........................................................................................
 virtual bool16 BroadcastQueuedMessages (IdleTimer* timer) const = 0;
 
 virtual void SelectionHasChanged (void) = 0;

 virtual void SelectionHasQueuedMessages (ISelectionMessage::SelectionMessageType selectionMessageType) const = 0;

 virtual void DeselectAll (void) = 0;

 virtual void SelectAll (IActiveContext* iContext) = 0;
 
 virtual bool16 SelectionExists (void) const = 0;

 virtual void BroadcastToIntegratorSuite (const PMIID& pmiid, void* selectionMessage) = 0;

 virtual UIDRef GetSelectionsOwner_Temporary_DoNotUse (void) const = 0;
 
 virtual IPMUnknown* QuerySelectionSuite (const PMIID&) const = 0;

 virtual void UpdateSelectionChangedBroadcastData (void) = 0;

 };

#endif // _IConcreteSelection_