IGuideDataSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Yeming Liu
// 
// $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 __IGUIDEDATASUITE__
#define __IGUIDEDATASUITE__

// ----- Interface files

#include "IPMUnknown.h"
#include "IColorData.h"
#include "IGuideData.h"

// ----- ID files

#include "ShuksanID.h" // for IID_IGUIDEDATASUITE

class IGuideDataSuite : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IGUIDEDATASUITE };

 // ----- Abilities

 virtual bool16 AreGuidesSelected() const = 0;

 virtual void GetViewThreshold(K2Vector<PMReal>& thresholdList) = 0;

 virtual void GetColorUID(K2Vector<UID>& colorUIDList) = 0;

 virtual void GetType(K2Vector<IGuideData::GuideType>& typeList) = 0;

 virtual void GetGrowZone(K2Vector<PMReal>& growZoneList) = 0;


 // ----- Execution
 
 virtual ErrorCode DeselectGuideUnderViewThreshold(PMReal viewTheshold) = 0;

 virtual ErrorCode DoSetColor(const UID& colorUID) = 0;
 
 virtual ErrorCode DoSetThreshold(const PMReal& viewTheshold) = 0;

 virtual ErrorCode DoSetType(IGuideData::GuideType type) = 0;

 virtual ErrorCode DoSetGrowZone(const PMReal& growZone) = 0;
};

#endif // __IGUIDEDATASUITE__