IPrintDeviceInfo.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.
// 
//========================================================================================

#ifndef __IPrintDeviceInfo__
#define __IPrintDeviceInfo__

#if PRAGMA_ONCE
#endif

#ifdef MACINTOSH
#define OSX_HACK
#endif

#include "PMRect.h"
#include "PrintID.h"
#include "K2Vector.h"
#include "KeyValuePair.h"

class PMReal;
class IOutputPages;

//========================================================================================
// CLASS IPrintDeviceInfo
//========================================================================================

class IPrintDeviceInfo : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPRINTDEVICEINFO };

 virtual bool16 IsPrintSessionActive() const = 0;
 
 virtual void Begin(bool16 initPPDList = kTrue) = 0;
 virtual void End() = 0;
 
 enum SetupDialogType {
 kPrinterSetup,
 kPageSetup
 };

 virtual ErrorCode ProcessPlatformPrintDialog(SetupDialogType dialogType, IOutputPages *iOutputPages = nil) = 0;

 virtual ErrorCode UpdatePrinterInfo(PMString& newPrinterStr, PMString& newPPDModelStr, bool16 bUsePrintData = kFalse, PMString newPPDFileStr = PMString()) = 0;

 virtual bool16 HasDefaultPrinter() const = 0;
 virtual PMString GetDefaultPrinterName() const = 0;
 virtual bool16 IsDefaultPrinterPDFWriter() const = 0;

 virtual int32 GetNumDevices() const = 0;
 virtual PMString GetNthDevice(const int32 index) const = 0;
 virtual int32 GetDeviceIndex(const PMString& deviceName) const = 0;
 
 virtual int32 GetNumPPDNames() const = 0;
 virtual PMString GetNthPPDModelName(const int32 index) const = 0;
 virtual PMString GetNthPPDFileName(const int32 index) const = 0;
 virtual int32 GetPPDIndexFromModelName(const PMString& ppdModelName) const = 0;
 virtual int32 GetPPDIndexFromFileName(const PMString& ppdFileName) const = 0;

 virtual int32 GetNumPaperSizes() const = 0;
 virtual PMString GetNthPaperSize(const int32 index) const = 0;
 virtual int32 GetPaperSizeIndex(const PMString& paperSizeName) const = 0;
 virtual PMString GetMediaSizeName() const = 0;
 virtual PMString GetPaperSizeName(const PMString& mediaSizeName) const = 0;
 virtual PMString GetPaperSizeName(const PMRect& paperSizeRect, const PMRect& imageableAreaRect = PMRect(), const PMString& paperSizeName = PMString()) const = 0;

 virtual PMRect GetPaperSize(const int32 index = 0) const = 0;
 virtual PMRect GetImageablePaperSize(const int32 index = 0) const = 0;
 virtual uchar *GetPaperSizeSelector(uint32 &outSize, const int32 index = 0) const = 0;
 
 virtual bool16 GetDeviceSupportsCustomPaperSizes() const = 0;
 virtual bool16 GetDeviceSupportsCustomPaperTransverse() const = 0;
 virtual void GetDeviceCustomPaperWidthRange(PMReal &outMinWidth, PMReal &outMaxWidth) const = 0;
 virtual void GetDeviceCustomPaperHeightRange(PMReal &outMinHeight, PMReal &outMaxHeight) const = 0;
 virtual void GetDeviceCustomPaperWidthOffsetRange(PMReal &outMinOffset, PMReal &outMaxOffset) const = 0;

 virtual bool16 GetDeviceSupportsInRIPTrapping() const = 0;
 virtual bool16 GetDeviceSupportsInRIPSeparations() const = 0;
 virtual bool16 GetDeviceSupportsBinaryData() const = 0;
 
 enum DefColorSpace {
 kGray,
 kRGB,
 kCMYK,
 kUnchanged
 };

 virtual DefColorSpace GetDeviceDefaultColorSpace() const = 0;
 virtual bool16 GetDeviceSupportsColorSpace(DefColorSpace colorSpace) const = 0;
 
 enum PSLevel {
 kPSLevel_Unknown,
 kPSLevel_1,
 kPSLevel_2,
 kPSLevel_3
 };

 virtual bool16 IsPostScriptDevice() const = 0;
 virtual bool16 DeviceSupportsNormalizedPostScript() const = 0;
 virtual PSLevel GetDevicePostScriptLevel() const = 0;
 
 virtual int32 GetNumCompositeFrequencies() const = 0;
 virtual PMString GetNthCompositeFrequency(const int32 index) const = 0;

 virtual PMReal GetDeviceCompositeAngle(PMString& resStr) const = 0;
 virtual PMReal GetDeviceCompositeFrequency(PMString& resStr) const = 0;

 virtual int32 GetCompositeFrequencyIndex(const PMString& compFreqName) const = 0;
 
 virtual int32 GetNumSeparationFrequencies() const = 0;
 virtual PMString GetNthSeparationFrequency(const int32 index) const = 0;
 virtual int32 GetSeparationFrequencyIndex(const PMString& sepFreqName) const = 0;
 virtual int32 GetDefaultSeparationFrequencyIndex() const = 0;
 
 enum InkSelector {
 kCyan,
 kMagenta,
 kYellow,
 kBlack,
 kSpot
 };
 
 virtual PMReal GetDeviceDefaultInkAngle(InkSelector inInkSelector) const = 0;
 virtual PMReal GetDeviceDefaultInkFrequency(InkSelector inInkSelector) const = 0;
 
 virtual PMReal GetDeviceInkAngle(InkSelector inInkSelector, PMString& resStr) const = 0;
 virtual PMReal GetDeviceInkFrequency(InkSelector inInkSelector, PMString& resStr) const = 0;

 virtual bool16 GetDeviceRequiresFlattener() const = 0;

 virtual ErrorCode GetPPDValues(PMString& keyIn, K2Vector<KeyValuePair<PMString, PMString> >& valueOut) const = 0;
 virtual ErrorCode GetPPDOptionKeys(PMString& keyIn, K2Vector<PMString>& keysOut) const = 0;
 virtual ErrorCode GetPPDOptionValue(PMString& keyIn, PMString& subKeyIn, PMString& subKeyTranslationOut, K2Vector<KeyValuePair<PMString, PMString> >& valueOut) const = 0;
};

#endif // __IPrintDeviceInfo__

// End, IPrintDeviceInfo.h.