IXPUtils.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 __IXPUtils__
#define __IXPUtils__

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

#include "IXPManager.h"
#include "IFlattenerSettings.h"
#include "IViewPortAttributes.h"
#include "BravoForwardDecl.h"

class IDocument;
class IControlView;

class IXPUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IXPUTILS };

 // Used for CreateFlattener() below
 typedef enum
 {
 kModeLegacy, // Preserve spots/overprint
 kModeSimPress, // Do OPP
 kModeSimScreen // Without OPP (no spots declared)
 } FlattenOutputMode;

 // Used for CreateFlattener() below
 class FlattenSettings
 {
 public:
 PMReal fLevel;
 PMReal fInternalDPI;
 PMReal fExternalDPI;
 PMReal fMapDPI;
 PMReal fPathDPI;

 // Note: if CreateFlattener() returns a non-nil value here, you're
 // responsible for releasing it via IXPUtils::ReleaseBlendSpace().
 // Otherwise you'll get a memory leak.
 AGMColorSpace* fBlendSpace; 
 };

 // QueryXPManager: Gets the transparency manager for the specified doc. 
 // Note: If doc == nil, fails (there is no xpmanager on the default doc).
 // The IDataBase form requires a non-nil iDB, which must be a doc DB.
 virtual IXPManager *QueryXPManager(IDocument *iDoc) = 0;
 virtual IXPManager *QueryXPManager(IDataBase *iDB) = 0;

 // Determines whether OPP is enabled in the specified view.
 virtual bool32 IsOPPEnabledInView(IControlView* iView) = 0;

 enum
 {
 // If not set, honors spread overrides.
 kXPCF_IgnoreSpreadOverrides = (1L<<0), 
 
 // If not set, we'll tell the flattener to set up doc spots in
 // legacy and simPress modes.
 kXPCF_NoSpotSetup = (1L<<1), 
 
 // Forces flattener to rasterize bad boy paints.
 kXPCF_RasterizeAGMPrintIncompatiblePaints = (1L<<2),

 // Don't use page's doc for inklist, use active book's inklist.
 kXPCF_UseActiveBookInkList = (1L<<3)
 };
 
 // CreateFlattener: This utility creates a flattening port using a flattening style
 // and applying any spread overrides (depending on 'kXPCF_IgnoreSpreadOverrides'). The
 // output mode determines whether spots will be added to the flattening port and
 // how various flags get set up. If you need to know what the final settings were
 // you can pass a FlattenSettings object and this fn will fill it in for you.
 // NOTE: This method will return an invalid (nil) port if an error occurs OR if
 // the spread override says not to enable the flattener.
 virtual AGMPort* CreateFlattener(
 UIDRef pageRef, // The page or spread you're exporting
 UID flatStyleUID, // The UID of the global flattening style
 uint32 xpcfFlags, // kXPCF_*
 IXPUtils::FlattenOutputMode mode, // Determines spot and flag setup
 const PMRect& pgBounds, // The drawing bounds
 IXPUtils::FlattenSettings* returnSettings = nil,
 void* pAGMFlattenerSettings = nil,
 AGMColorSpace* preferredBlendSpace = nil) = 0;

 // This is used to release the blend space optionally returned from CreateFlattener().
 virtual void ReleaseBlendSpace(AGMColorSpace* theBlendSpace) = 0;

 // This is used to obtain a suitable output profile to eliminate stitching
 // artifacts caused by a different blend and device (and proofing, and
 // overprint simulation) profiles. Pass in your profiles, and this will
 // return an appropriate new device profile to match the planar map vs non
 // planar mapped object path. Note that you need to release the profile
 // via the appropriate BIB dereferencer or ReleaseProfile, below.
 virtual AGMColorProfile* CreateAntistitchingProfile
 (
 AGMColorProfile* profBlend, // required; if not flattening, then don't call this function
 AGMColorProfile* profDevice, // required
 AGMColorProfile* profCMYK = nil, // nil = not doing overprint preview
 AGMColorProfile* profProof = nil // nil = not proofing anything
 ) = 0;

 virtual void ReleaseProfile(AGMColorProfile*) = 0;

 virtual IFlattenerSettings* QueryFlattenerSettings( IWorkspace* pWorkspace,
 UID uidFlatStyle ) = 0;

 virtual bool16 GetFlattenerSettings( IWorkspace* pWorkspace,
 UID uidFlatStyle,
 bool16 bIgnoreSpreadOverrides,
 UIDRef& uidPageItem,
 InterfacePtr<IFlattenerSettings>& pSettings,
 InterfacePtr<IFlattenerSettings>& pOverrides ) = 0;

 virtual bool16 SetupViewPortAttrs( IWorkspace* pWorkspace,
 UID uidFlatStyle, 
 bool32 bIgnoreOverrides, 
 UIDRef const& uidPage, 
 IViewPortAttributes* iAttr) = 0;

 virtual AGMPaint* CreateImagePaintServer( _t_AGMImageRecord* imgRec, 
 PMMatrix* m, 
 int32 flags, 
 AGMColorSpace* theSpace) = 0;

 virtual void ReleasePaintServer(AGMPaint* agmPaint) = 0;

 virtual UIDList* GetGraphicsAffectedByTransparency(UIDRef spreadRef, const PMString& styleName = PMString(), bool32 ignoreSpreadOverrides = kFalse) = 0;

 virtual bool32 IsStrokeTransparent(IPMUnknown* item) = 0;
};


#endif // __IXPUtils__