IInkMgrUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IInkMgrUtils__
#define __IInkMgrUtils__

#include "IPMUnknown.h"
#include "Utils.h"

#include "IColorData.h"

#include "PrintID.h"
#include "ColorSystemID.h"
#include "ShuksanID.h"
#include "PMString.h"
#include "UIDList.h"
#include "IInkData.h"
#include "BravoForwardDecl.h"


class IWorkspace;
class ISwatchList;
class UIDList;
class PMReal;
class IDataBase;
class IInkList;
class IPMInkBossData;


class IInkMgrUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IINKMGRUTILS };
 
 typedef enum {
 kPSProcess = 1,
 
 kPSHexachrome
 } PSProcessInkType;

 virtual IInkList* _QueryActiveInkList (IActiveContext* = nil) = 0;

 virtual IInkList* _QueryActiveDocInkList () = 0;

 virtual IInkList* QueryDocInkList (IDataBase* iDataBase) = 0;

 virtual UIDList GetInkAliasListFromInkList (IInkList* iInkList, bool16 excludeSwatchAliases = kFalse) = 0;

 virtual UID GetInksAliasInfo (IInkList* iInkList, UID inkUID, PMString& aliasInkName, bool16& isProcessInk, int32& plateOrder, ColorArray& colorValue) = 0;
 
 virtual UID GetInksAliasUID (IInkList* iInkList, PMString& inkName) = 0; 

 virtual UID GetInksAliasUID (IInkList* iInkList, UID inkUID) = 0; 
 
 virtual bool16 InksSwatchIsAliased (IInkList* iInkList, const UIDRef& inkRef) = 0;

 virtual int32 GetPrintInkPlateOrder (IInkList* iInkList, UID inkUID) = 0;
 
 virtual UIDRef GetSpotInksColorSwatchUID (const UIDRef& inkRef, IPMUnknown* iSwatchOrInkList = nil) = 0;

 virtual bool16 GetSpotInSwatchList (IDataBase* iDB, const PMString& spotName, PSProcessInkType type) = 0;

 virtual IInkData::InkType GetInksColorUsageType (const UIDRef& swatchRef, ISwatchList* iSwatchList = nil) = 0;

 virtual void _InvokeInkManagerDialog (IInkList* iInkList = nil, RsrcID dlgID = 0) = 0;
 
 virtual PMString GetInkUIName (IPMInkBossData* iInkBossData) = 0;
 
 virtual PMString GetInkPSName (IPMInkBossData*) = 0;
 
 virtual UIDList GetVisibleInkListFromInkList (IInkList* iInkList, bool16 allToProcess) = 0;

 virtual UID FindInk(IInkList*, PMString inkName) = 0;
 
 virtual UID FindPSInk(IInkList*, PMString inkName, PSProcessInkType psInkType) = 0;
 
 virtual UIDList GetInkConvertToProcessListFromInkList(IInkList* iInkList) = 0;
 
 virtual bool16 ColorsAreModified(IInkList*, UIDList swatchUIDList) = 0;
 
 virtual CAGMColorSpace CreateAliasedColorSpace(IInkList* iInkList, UID& aliasee, bool16 doPrint = kFalse) = 0;

 virtual bool16 InkListHasSpotInks (IInkList* iInkList = nil, bool16 ignoreConvert2Process = kFalse) = 0;

 virtual UIDList GetInksUsedOnSpread(UIDRef& spreadRef, int32 flags, IInkList* iInkList = nil, PMRect* pBoundsRect = nil) = 0;
};


#endif // __IInkMgrUtils__