IBoundsData.h

//========================================================================================
// 
// $File$
// 
// Owner: Richard Rodseth
// 
// $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.
// 
// 
// Purpose: This interface is attached to commands which alter the dimensions of page items. It
// is used to determine the size of the area (usually the pasteboard) which contains the
// affected page items, and whether the items should be completely contained within the
// area, or simply intersect it.
// 
// IBoundsData
// 
//========================================================================================

#ifndef __IBOUNDSDATA__
#define __IBOUNDSDATA__

#include "IPMUnknown.h"

#include "LayoutUIID.h"
#include "LayoutID.h"
#include "PMRect.h"
#include "TransformTypes.h"

class ITransform;

class IBoundsData : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IBOUNDSDATA };

 enum ContainmentType
 {
 kNoBoundsChecking = 0,
 kNoItemsCompletelyOutside = 1,
 kAllItemsCompletelyInside = 2,
 kUseDefaultBoundsChecking = 3,
 };


 virtual void SetBoundsChecking( ContainmentType containmentType, const PMRect* bounds, const Transform::CoordinateSpace &coordinateSpace) = 0;

 inline void SetDefaultBoundsChecking(){ SetBoundsChecking( kUseDefaultBoundsChecking, nil, Transform::SpreadCoordinates());}

 inline void SetNoBoundsChecking(){ SetBoundsChecking( kNoBoundsChecking, nil, Transform::SpreadCoordinates());}

 virtual ContainmentType GetBoundsChecking( PMRect* bounds, Transform::CoordinateSpace* coordinateSpace) const = 0;

 virtual ContainmentType CalculateBoundsChecking( const UIDRef& item, PMRect* rect, UIDRef* rectParent) = 0;

};

#endif // __IBOUNDSDATA__