IGuideUtils.h

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

#include "GuideID.h"
#include "IPMUnknown.h"
#include "Utils.h"
#include "PMPoint.h"
#include "UIDRef.h"

class ICommand;
class IGuideData;
class IColorData;

class IGuideUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGUIDEUTILS };

 virtual UID GetNewOwnerUID(IGuideData *guideData, const PMPoint &locationPoint) = 0;

 virtual void GetSortedSliceGuides(const UIDRef& pageRef, UIDList& horizontalGuides, UIDList& verticalGuides) const = 0;
 virtual void GetSortedSliceGuides( const UIDRef& pageRef, const PMRect& pageBoundsSpreadCoordinates, UIDList& horizontalGuides, UIDList& verticalGuides) const = 0;

 typedef enum
 {
 kMaskNothing = 0x00000000,
 kMaskHiddenLayers = 0x00000001,
 kMaskLockedLayers = 0x00000002,
 kMaskHiddenAndLockedLayers = kMaskHiddenLayers + kMaskLockedLayers
 } LayerMaskFlags;

 virtual UIDList GetGuidesOnSpread(const UIDRef& spreadRef, const LayerMaskFlags flags) const = 0;

 virtual void FilterNonGuides(UIDList& list) = 0;

};

#endif // __IGuideUtils__