IPrintJobData.h

//========================================================================================
// 
// $File$
// 
// Owner: DBerggren
// 
// $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.
// 
// 
// based on IUIDListData.h - for managing list of inks
// 
//========================================================================================

#ifndef __IPrintJobData__
#define __IPrintJobData__

#include "IPMUnknown.h"
#include "IInkResourceData.h"
#include "PrintID.h"
#include "K2Vector.h"
#include "IPathGeometry.h"
#include "BravoForwardDecl.h"
#include "PMRect.h"

class TrapZoneInfo;
class Font_Info;

class IPrintJobData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IPRINTJOBDATA };

 virtual IInkList* GetInkList(void) const = 0;
 virtual void SetInkList(IInkList *iInkList) = 0;

 // Ink Resource methods - to get/set IInkResourceData for each page
 virtual void InkRsrcInsert(int32 index, IInkResourceData *iInkRsrcData) = 0;
 virtual void InkRsrcRemove(int32 index) = 0;
 virtual void InkRsrcClear(void) = 0;
 virtual int32 InkRsrcLength(void) = 0;
 virtual IInkResourceData *GetNthInkRsrcData(int32 index) const = 0;

 virtual bool16 GetGradientUsed() const = 0;
 virtual void SetGradientUsed(const bool16 bGradientUsed) = 0;

 virtual bool16 GetImagesUsed() const = 0;
 virtual void SetImagesUsed(const bool16 bImagesUsed) = 0;

 virtual bool16 GetTransparencyUsedInJob() const = 0;
 virtual bool16 GetTransparencyUsed(const int32 whichPage) const = 0;
 virtual void SetTransparencyInfo(const K2Vector<int32>& xpPages) = 0;
 virtual int32 NumberOfPagesWithTransparency() const = 0;

 // font collection methods
 virtual void AppendGraphicSuppliedFontName(const PMString& fontName) = 0;

 virtual int32 NumGraphicSuppliedFonts() const = 0;

 virtual void GetNthGraphicSuppliedFontName(int32 n, PMString& fontName) const = 0;

 virtual bool16 GetSVGFontsUsed(const int32 whichPage) const = 0;

 virtual void SetSVGFontsInfo(const K2Vector<int32>& svgPages) = 0;

 virtual void AppendFontInfo(const Font_Info* fontInfo) = 0;
 virtual int32 NumFontInfo() const = 0;
 virtual Font_Info* GetNthFontInfo(int32 n) const = 0;

 virtual int32 NumMissingFonts() const = 0;

 virtual void GetNthMissingFontName(const int32 n, PMString& fontName) const = 0;

 virtual void AppendMissingFontName(const PMString& fontName) = 0;

 // trap zone information
 virtual void TZPathsInsert(int32 index, K2Vector<TrapZoneInfo*> pathList) = 0;
 virtual void TZPathsRemove(int32 index) = 0;
 virtual void TZPathsClear(void) = 0;
 virtual int32 TZPathsLength(void) = 0;
 virtual K2Vector<TrapZoneInfo*> GetNthTZPathsList(int32 index) const = 0;
 
 virtual bool16 GetGradientMeshUsed() const = 0;
 virtual void SetGradientMeshUsed(const bool16 bGradientMeshUsed) = 0;

 virtual void AddPageLabelString(int32 pageIndex, const PMString& pageLabelStr) = 0;
 virtual void RemovePageLabelString(int32 pageIndex) = 0;
 virtual void ClearPageLabelStrings(void) = 0;
 virtual PMString GetPageLabelString(int32 pageIndex) const = 0;

 virtual void AppendLinks(const UIDList& links) = 0;

 virtual const UIDList& GetLinks(void) const = 0;

 // page gap information
 virtual void PageGapsListInsertPage(int32 page, K2Vector<PMRect> vecPageGapsList) = 0;
 virtual void PageGapsListRemovePage(int32 page) = 0;
 virtual void PageGapsListClear(void) = 0;
 virtual K2Vector<PMRect> GetPageGapsListForPage(int32 page) const = 0;

};

class TrapZoneInfo
{
public:
 typedef object_type data_type;

 TrapZoneInfo(PMString& trapStyleName, IPathGeometry *trapZonePath, PMReal offsetPathAmt = PMReal(0.0))
 : fTrapStyleName(trapStyleName),
 fTrapZonePath(trapZonePath, UseDefaultIID()),
 fOffsetPathAmount(offsetPathAmt)
 {}
 PMString &GetTrapStyleName() { return fTrapStyleName; }
 IPathGeometry *GetTrapZonePath() { return fTrapZonePath; }
 PMReal GetOffsetPathAmount() { return fOffsetPathAmount; }

private:
 PMString fTrapStyleName;
 InterfacePtr<IPathGeometry> fTrapZonePath;
 PMReal fOffsetPathAmount;
};

class Font_Info
{
public:
 typedef base_type data_type;

 Font_Info(const CTFontDict* ctFontDict, int32 numDesignVectors = 0, Fixed* designVectors = nil, uint32 flags = 0)
 : fctFontDict(ctFontDict),
 fnumDesignVectors(numDesignVectors),
 fFlags(flags),fDesignVectors(nil)
 {
 if(numDesignVectors){
 fDesignVectors = new Fixed[numDesignVectors];
 std::memcpy(fDesignVectors, designVectors, sizeof(Fixed)*numDesignVectors);
 }
 
 }
 
 
 ~Font_Info(){
 if(fDesignVectors)
 delete[] fDesignVectors;
 fDesignVectors = nil;
 }
 
 const CTFontDict* GetCTFontDict() const { return fctFontDict; }
 size_t GetNumDesignVectors() const { return fnumDesignVectors; }
 void GetDesignVectors(Fixed* dV) const{
 std::memcpy(dV, fDesignVectors, sizeof(Fixed)*fnumDesignVectors);
 }
 uint32 GetFlags() const { return fFlags; }

 Font_Info &operator= (const Font_Info& other)
 {
 if (this != &other)
 {
 fctFontDict = other.fctFontDict;
 fnumDesignVectors = other.fnumDesignVectors;
 Fixed *fiDV = nil;
 if(fnumDesignVectors)
 fiDV = new Fixed[fnumDesignVectors];
 other.GetDesignVectors(fiDV);
 std::memcpy(fDesignVectors, fiDV, sizeof(Fixed)*fnumDesignVectors);
 fFlags = other.fFlags;
 if(fiDV){
 delete[] fiDV;
 }
 }
 return *this;
 }

 bool16 operator==(const Font_Info& fi) const
 {
 bool16 result = kTrue;
 if (fctFontDict != fi.GetCTFontDict()) 
 result = kFalse;
 if (fnumDesignVectors != fi.GetNumDesignVectors()) 
 result = kFalse;
 if(result){
 Fixed *fiDV = nil;
 if(fnumDesignVectors)
 fiDV = new Fixed[fnumDesignVectors];
 fi.GetDesignVectors(fiDV);
 if(std::memcmp(fiDV, fDesignVectors, sizeof(Fixed) * fnumDesignVectors) != 0)
 result = kFalse;
 if (fFlags != fi.GetFlags())
 result = kFalse;
 if(fnumDesignVectors>0)
 delete [] fiDV;
 }
 return result;
 }

 enum {
 // horizontal/vertical
 kIsVertical = 0x00000001
 };

private:
 const CTFontDict* fctFontDict;
 size_t fnumDesignVectors;
 Fixed *fDesignVectors;
 uint32 fFlags;
};


#endif // __IPrintJobData__