IInCopySwatchContext.h

//========================================================================================
// 
// $File$
// 
// Owner: Jeff Argast
// 
// $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 __IInCopySwatchContext__
#define __IInCopySwatchContext__

#include "IPMUnknown.h"

#include "GraphicTypes.h"
#include "InCopyWorkflowID.h"

class WideString;


//================================================================================================
// Class InCopySwatchContext
//================================================================================================
class IInCopySwatchContext : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IINCOPYSWATCHCONTEXT };


 //----------------------------------------------------------------------------------------
 // Public Member Functions
 //----------------------------------------------------------------------------------------

 
 //----------------------------------------------------------------------------------------
 virtual void Initialize (
 const UIDRef& storyRef
 ) = 0;

 //----------------------------------------------------------------------------------------
 virtual void AddTint(
 const PMString& tintName,
 const PMReal tintPercent,
 const int32 id = 0,
 const bool16 visible = kFalse
 ) = 0;

 //----------------------------------------------------------------------------------------
 virtual void AddGradient(
 const PMString& gradientName,
 const GradientType gradientType,
 K2Vector<UID> stopColor,
 K2Vector<PMReal> stopPos,
 K2Vector<PMReal> midPoint,
 const int32 id = 0,
 const bool16 visible = kFalse
 ) = 0;

 //----------------------------------------------------------------------------------------
 virtual void CreateSwatches() = 0;
};

#endif // __IInCopySwatchContext__