IGuideFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Bob Freeman
// 
// $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 __IGuideFacade__
#define __IGuideFacade__

// ----- Interfaces -----
#include "Utils.h"
#include "IGuideData.h"

// ----- ID.h files -----
#include "GuideID.h"

namespace Facade
 {
 class IGuideFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IGUIDEFACADE };
 
 static const bool16 kVerticalGuide = kFalse;
 static const bool16 kHorizontalGuide = kTrue;

 virtual ErrorCode SetGuideOrientation(const UIDList& guideList, const bool16& orientation) = 0;

 virtual ErrorCode SetGuideColor(const UIDList& guideList, const UID& colorUID) = 0;

 virtual ErrorCode SetGuideViewThreshold(const UIDList& guideList, const PMReal& threshold) = 0;

 virtual ErrorCode SetGuideType(const UIDList& guideList, const IGuideData::GuideType guideType) = 0;

 virtual ErrorCode SetGuideGrowZone(const UIDList& guideList, const PMReal& zone) = 0;



 virtual bool16 GetGuideOrientation(const UIDRef& guideRef) const = 0;

 virtual UID GetGuideColor(const UIDRef& guideRef) const = 0;

 virtual PMReal GetGuideViewThreshold(const UIDRef& guideRef) const = 0;

 virtual IGuideData::GuideType GetGuideType(const UIDRef& guideRef) const = 0;

 virtual PMReal GetGuideGrowZone(const UIDRef& guideRef) const = 0;
 };
}

#endif // __IGuideFacade__