IPrintUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Easter
// 
// $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.
// 
// 
// Purpose:
// 
//========================================================================================

#ifndef __IPrintUtils__
#define __IPrintUtils__


#include "IPMUnknown.h"

#include "PMRect.h"
#include "PrintID.h"
#include "Utils.h"

class ICMSProofing;
class IColorPresetsSettings;
class IDocument;
class IOutputPages;
class IPrintData;
class IPrintDeviceInfo;
class IPrintDialogData;
class IViewPortAttributes;
class IInkList;
class IPrintJobData;
class GraphicsData;

#define PRINTUTILS Utils<IPrintUtils>()

class IPrintUtils : public IPMUnknown
{
public:
 enum PrintStage {

 kBeforePrintJobParamsInit = 0,
 kAfterPrintJobParamsInit,

 kBeforePrintLoop,

 kBeginPageEvent,

 kBeforeDrawPageEvent,
 kBeforeDrawPage,
 kAfterDrawPageEvent,

 kEndPageEvent,

 kBeforeDrawGalleyPageEvent,
 kBeforeDrawGalleyPage,
 kAfterDrawGalleyPageEvent,

 kEndPrintingEvent
 };

public:
 enum { kDefaultIID = IID_IPRINTUTILS };

 virtual bool16 IsCompositeMode(int32 outputMode) = 0;
 virtual bool16 IsSeparationMode(int32 outputMode) = 0;
 virtual int32 GetDefaultOutputMode(const IPrintDeviceInfo* iPrintDeviceInfo) = 0;

 virtual bool16 BleedIsOn(const IPrintData* iPD) = 0;
 virtual bool16 MarksAreOn(const IPrintData* iPD) = 0;

 virtual PMString GetUsedProfileName(const IPrintData* iPrintData, IDocument* iDocument) = 0;
 virtual PMString GetDocumentProfileName(const IPrintData* iPrintData, IDocument* iDocument) = 0;
 virtual PMString GetDocumentProfileName(IDocument* iDocument, int32 source) = 0;
 virtual PMString GetWorkingProfileName(const IPrintData* iPrintData) = 0;
 virtual PMString GetWorkingProfileName(int32 source) = 0;

 virtual ICMSProofing* QueryICMSProofing(IDocument* iDocument) = 0;
 virtual void UpdateInkScreening(IPrintDialogData* iPrintDialogData) = 0;

 virtual void InitPrintDataAndInks(IDocument* doc) = 0;
 virtual void FixupPrintDataForPub(IDocument* doc) = 0;

 virtual void FigureCustomPaperSizeSettings(int32 whichPage, // input
 IPrintData* iPrintData, // input 
 IOutputPages* iOutputPages, // input
 PMReal& nWidth, // output
 PMReal& nHeight, // output 
 PMReal& nWidthOffset) = 0; // output

 virtual void ThumbCalculateRowsAndColumns(uint32 thumbsPerPage,
 PMRect const& pageRect,
 IPrintData const* iPrintData,
 uint32& rows,
 uint32& columns) = 0;

 virtual bool16 IsDocumentWide(PMRect const& pageRect, IPrintData const* printData) = 0;
 virtual bool16 IsPrinterWide(IPrintData const* printData) = 0;


 virtual PMReal GetCorrectedTilingOverlap(const IPrintData* iPrintData) const = 0;

 virtual bool16 InitializeOutputPages(IDocument *iDoc, IPrintData *iPrintData, IOutputPages *iPrintPages) = 0;

 virtual void SetupPSViewPortAttrs( IViewPortAttributes* pAttrs, IPrintData* pConfig, IInkList* iInkList ) = 0;

 virtual void SetupNonPSViewPortAttrs( IViewPortAttributes* pAttrs, IPrintData* pConfig ) = 0;

 virtual bool16 InvokePrintSetupServices( 
 PrintStage printStage,
 IPrintData* iPrintData = nil,
 IOutputPages* iOutputPages = nil,
 IPrintJobData* iPrintJobData = nil,
 int32* whichPage = nil,
 PMRect* outputRect = nil,
 GraphicsData* gd = nil
 ) = 0;

 virtual bool16 InvokePrintSetupError( 
 IPrintData* iPrintData,
 ErrorCode& errorNum,
 PMString& errComponent,
 PMString& errText,
 PMString& errOtherInfo
 ) = 0;

 virtual PMReal CalculateImageResolution( IPrintData* pConfig, IInkList* iInkList ) = 0;

#ifdef DEBUG
 virtual bool16& gShowImageableArea() = 0;
 virtual bool16& gCheckPaperRects() = 0;
 virtual int32& gDownloadFontGlyphThreshold() = 0;
 virtual bool16& gTraceFlattenerInput() = 0;
 virtual bool16& gTraceFlattenerOutput() = 0;
#endif
};

#endif // __IPrintUtils__