IAlignAndDistributeSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Paul Sorrick
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================

#ifndef __IAlignAndDistributeSuite__
#define __IAlignAndDistributeSuite__

#include "IPMUnknown.h"
#include "IAlignCmdData.h"
#include "IDistributeCmdData.h"
#include "UIDRef.h"
#include "ShuksanID.h"

class IAlignAndDistributeSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IALIGNANDDISTRIBUTESUITE };

 
// ----- Abilities
 
 virtual bool16 CanAlign (AlignType alignHow) const = 0;

 virtual bool16 CanDistribute (DistributeType distributeHow, const PMReal& spacingValue, UseDistributeValue useValue) const = 0;

 virtual bool16 CanSetKeyObject() const = 0;

 virtual bool16 CanCancelKeyObject() const = 0;

 virtual bool16 CanToggleKeyObject() const = 0;

 virtual bool16 IsKeyObjectSelected() const = 0;

// ----- Manipulators

 virtual ErrorCode DoAlign (AlignType alignHow) = 0;

 virtual ErrorCode DoDistribute (DistributeType distributeHow, const PMReal& spacingValue, UseDistributeValue useValue) = 0;

 virtual ErrorCode DoSetKeyObject(const UIDRef& item = kInvalidUIDRef) = 0;
 
 virtual ErrorCode DoCancelKeyObject() = 0;

 virtual ErrorCode DoToggleKeyObject(const UIDRef& item) = 0;
};

#endif // __IAlignAndDistributeSuite__