INewGuideCmdData.h

//========================================================================================
// 
// $File$
// 
// Owner: Stacy Molitor
// 
// $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 __INewGuideCmdData__
#define __INewGuideCmdData__

#include "IPMUnknown.h"
#include "UIDRef.h"
#include "IGuideData.h"
#include "GuideID.h"
//#include "PMPoint.h"
//#include "GenericID.h"

class INewGuideCmdData : public IPMUnknown {
public:
 enum { kDefaultIID = IID_INEWGUIDECMDDATA };
 // the data needed when creating a NewGuideCmd
 
 virtual void Set(const UIDRef& parent, bool16 isHoriz, const PMReal &distance, const UID &ownerUID, 
 bool16 isShort = kTrue, const PMReal &threshold = kDefaultViewThreshold, 
 const int32 colorIndex = IUIColorUtils::kStockRulerGuide, const IGuideData::GuideType guideType = IGuideData::kRulerGuide) = 0;
 // set all the command data

 virtual void SetMultiple(bool16 isMultiple) = 0;
 // Set to true if the guide is part of a multiple guide command (horizontal + vertical), false (default) otherwise
 // Separate from Set method. All guide commands are either vertical or horizontal, only after appending commands
 // together is the SetMultiple used.
 
 virtual void SetType(const IGuideData::GuideType guideType) = 0;
 
 virtual IGuideData::GuideType GetType() const = 0;
 
 virtual void SetLiquidGrowZoneSize(const PMReal& size) = 0;
 
 virtual PMReal GetLiquidGrowZoneSize() const = 0;
 
 virtual void SetLocation(const PMReal& location) = 0;
 virtual PMReal GetLocation() const = 0;

 virtual const UIDRef& GetParent() = 0;
 // returns the parent of the new guide page item, this is a layer UIDRef (which is usually set to the active layer)

 virtual bool16 GetIsHoriz() const = 0;
 // return true if the guide is horizontal, otherwise it's vertical

 virtual bool16 GetIsMultiple() const = 0;
 // return true if the guide is part of a multiple guide command (horizontal + vertical), false (default) otherwise

 virtual const PMReal& GetDistance() const = 0;
 // return the distance the guide is located at

 virtual const UID& GetOwnerUID() const = 0;
 // return the id of the owner, for short guides this is the page it's located on, 
 // for long guides it's the pasteboard

 virtual const PMReal& GetThreshold() const = 0;
 // return the default the threshold when creating a new guide

 virtual const int32 GetColorIndex() const = 0;

 virtual bool16 GetIsShort() const = 0;
};



#endif // __INewGuideCmdData__