ILayoutTarget.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 _ILayoutTarget_
#define _ILayoutTarget_
//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
 #include "IPMUnknown.h"
 #include "ShuksanID.h"
 #include "UIDList.h"
//================================================================================================
//________________________________________________________________________________________________
// Constants
//________________________________________________________________________________________________
// const bool16 kStripStandoffs = kTrue;
// const bool16 kDontStripStandoffs = kFalse;
// const bool16 kStripIfParentLocked = kTrue;
// const bool16 kDontStripIfParentLocked = kFalse;
//________________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________________
class ILayoutTarget : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_ILAYOUTTARGET };




 template< typename, int v> struct Int2Type { enum { value = v};};

 struct StandoffChoice
 {
 typedef Int2Type< StandoffChoice, 0> DontStripStandoffs;
 typedef Int2Type< StandoffChoice, 1> StripStandoffs;

 /*--------trickery below--------*/
 template<int v> StandoffChoice( const Int2Type<StandoffChoice, v>& ) : value(v) { }
 StandoffChoice( const StandoffChoice& other) : value( other.value) { }
 friend bool operator==( const StandoffChoice& lhs, const StandoffChoice& rhs) { return lhs.value == rhs.value; }
 friend bool operator!=( const StandoffChoice& lhs, const StandoffChoice& rhs) { return lhs.value != rhs.value; }
 private: int value;
 };

 struct LockedParentChoice
 {
 typedef Int2Type< LockedParentChoice, 0> DontStripIfParentLocked;
 typedef Int2Type< LockedParentChoice, 1> StripIfParentLocked;

 /*--------trickery below--------*/
 template<int v> LockedParentChoice( const Int2Type<LockedParentChoice, v>& ) : value(v) { }
 LockedParentChoice( const LockedParentChoice& other) : value( other.value) { }
 friend bool operator==( const LockedParentChoice& lhs, const LockedParentChoice& rhs) { return lhs.value == rhs.value; }
 friend bool operator!=( const LockedParentChoice& lhs, const LockedParentChoice& rhs) { return lhs.value != rhs.value; }
 private: int value;
 };




 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 //........................................................................................
 // (Add to / Remove from) the layout target
 //........................................................................................
 virtual void Add (const UID newItem) = 0;
 virtual void Add (const UIDList& newItems) = 0;
 virtual void Remove (const UID itemToRemove) = 0;
 
 virtual void Clear (void) = 0;
 
 virtual UIDList GetUIDList (StandoffChoice stripStandoffs, LockedParentChoice stripIfParentLocked) const = 0;
 inline UIDList GetUIDList( StandoffChoice stripStandoffs) const;



 virtual void SetUIDList (const UIDList&) = 0; 
 virtual void SetUIDList (const UID) = 0;

// virtual UIDList GetLastUIDList (StandoffChoice stripStandoffs, bool16 stripIfParentLocked = kDontStripIfParentLocked) const = 0; 

 virtual UIDList CreateFlattenedUIDList (const PMIID&) const = 0;
 
 virtual void CalculatePreviousSelectionDifferences (UIDList* addedPageItems, UIDList*removedPageItems) = 0;
 //........................................................................................
 // Utilities
 //........................................................................................
 virtual void Initialize (IDataBase*) = 0;
 virtual bool16 PartOfTarget (const UID&) const = 0;
 
 virtual void TargetChanged (void) = 0;

 virtual bool16 HasContent (void) const = 0;

 virtual UIDRef GetKeyObject (void) const = 0;

 virtual void SetKeyObject (const UIDRef& keyObject) = 0;
 };


const ILayoutTarget::StandoffChoice kStripStandoffs = ILayoutTarget::StandoffChoice::StripStandoffs();
const ILayoutTarget::StandoffChoice kDontStripStandoffs = ILayoutTarget::StandoffChoice::DontStripStandoffs();
const ILayoutTarget::LockedParentChoice kStripIfParentLocked = ILayoutTarget::LockedParentChoice::StripIfParentLocked();
const ILayoutTarget::LockedParentChoice kDontStripIfParentLocked = ILayoutTarget::LockedParentChoice::DontStripIfParentLocked();

inline UIDList ILayoutTarget::GetUIDList( StandoffChoice stripStandoffs) const { return GetUIDList( stripStandoffs, kDontStripIfParentLocked);}


#endif // _ILayoutTarget_