IXMLExportUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Stephens
// 
// $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 __IXMLExportUtils__
#define __IXMLExportUtils__

#include "IPMUnknown.h"
#include "IXMLExportOptions.h"
#include "TransformTypes.h"

class IPMStream;
class XMLReference;
class IXMLExportOptions;
class IXMLOutStream;
class PMString;
class ILinkObject;
class ILinkResource;

typedef void* ExportSessionToken;

class IXMLExportUtils : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IXMLEXPORTUTILS};

 enum ExportImageOption
 {
 kCopyOriginal, 
 kOptimizeOriginal, 
 kFormatOriginal
 };


 virtual ErrorCode GenerateOptimizedImage(const IPMUnknown *pageItem, IPMStream *outStream, const IXMLExportOptions* options, const PMReal& desiredWidth = 0) = 0;
 
 virtual ErrorCode GenerateFormattedImage(const IPMUnknown *pageItem, IPMStream *outStream, const IXMLExportOptions* options, bool32 includeFrameInRendering = kTrue,bool16 bItemBackgroundExportAsPng = kFalse, bool16 bDrawNonPrintingObjects = kTrue, PMReal greekBelowPtSize = 0.0) = 0; 

 virtual IXMLExportOptions::ImageType GetBestOptimizedImageType(const IPMUnknown *pageItem) const = 0;

 virtual IXMLExportOptions::ImageType GetBestFormattedImageType(const IPMUnknown *pageItem, bool16 shouldKeepSVGAsEmbededSVGImage = kFalse) const = 0;

 virtual void CopyOriginal(IXMLOutStream *stream, const IDFile& imagesFolder, ILinkObject* iLinkObject, ExportSessionToken sessionToken, const PMString* linkName = nil) const = 0;

 virtual void CopyOriginal(IXMLOutStream *stream, const IDFile& imagesFolder, const IDFile& sourceFile, ExportSessionToken sessionToken) const = 0;

 virtual void OptimizeOriginal(IXMLOutStream *stream, IXMLExportOptions* exportOptions, const IDFile& imagesFolder, ILinkObject* iLinkObject, ExportSessionToken sessionToken, const PMReal& desiredWidth = 0) const = 0;

 virtual void FormatOriginal(IXMLOutStream *stream, 
 IXMLExportOptions* exportOptions, 
 const IDFile& imagesFolder, 
 ILinkObject* iLinkObject, 
 const XMLReference *element, 
 ExportSessionToken sessionToken,
 bool32 includeFrameInRendering = kTrue) const = 0;

 virtual bool16 HasTransparency(const IPMUnknown *pageItem) const = 0;

 virtual PMString GetDestinationImageName( ExportImageOption exportImageOption, const IDFile& imagesFolder, ILinkObject* iLinkObject, const IXMLExportOptions* exportOptions, bool16 overwriteDestination = kFalse ) const = 0;
 
 virtual void WriteDocumentHeader(IXMLOutStream *xmlStream, IXMLExportOptions* exportOptions, const PMString& rootName) const = 0;

 virtual void OpenFileInApp( const IDFile& appFile, const PMString& fileURL ) const = 0; 
 
 virtual bool32 NeedsRasterizationOrSVG(const IPMUnknown *imageItem,
 bool32 checkForRotationOrSkew = kTrue, 
 bool32 checkForTransparency = kTrue,
 bool32 checkForImageClipping = kTrue,
 bool32 checkForFrameCropping = kTrue,
 bool32 checkForVectorGraphic = kTrue) const = 0;
 virtual bool16 isSVGItem(const IPMUnknown *imageItem) const = 0;

 virtual void OptimizeOriginal2(IXMLOutStream *stream, IXMLExportOptions* exportOptions, const IDFile& imagesFolder, bool32 useOriginalImageNameOnly, ILinkObject* iLinkObject, ExportSessionToken sessionToken, const PMReal& desiredWidth = 0) const = 0;

 virtual void FormatOriginal2(IXMLOutStream *stream, 
 IXMLExportOptions* exportOptions, 
 const IDFile& imagesFolder, 
 bool32 useOriginalImageNameOnly,
 ILinkObject* iLinkObject, 
 const XMLReference *element, 
 ExportSessionToken sessionToken, 
 bool32 includeFrameInRendering = kTrue
 ) const = 0;

 virtual ErrorCode GenerateFormattedImageForText(const IPMUnknown *pageItem, 
 IPMStream *outStream, 
 const IXMLExportOptions* options, 
 bool32 includeFrameInRendering = kTrue,
 bool16 bItemBackgroundExportAsPng = kTrue, // by default export as PNG
 bool16 excludeText = kFalse
 ) = 0; 

 
 virtual PMRect GetPrintedBBoxForTextFrame(const UIDRef &textFrameRef, const PMMatrix& theMatrix, const Transform::CoordinateSpace& coordinateSpace /*= Transform::PasteboardCoordinates()*/, bool32 includeAdornments = kTrue) = 0;

 virtual ErrorCode GenerateFormattedImage2(const IPMUnknown *pageItem, IPMStream *outStream, const IXMLExportOptions* options, bool32 includeFrameInRendering = kTrue, bool16 bItemBackgroundExportAsPng = kFalse, bool16 bDrawNonPrintingObjects = kTrue, PMReal greekBelowPtSize = 0.0, bool16 includeOtherBackgroundObjects = kFalse) = 0;

 virtual ErrorCode GenerateFormattedImageForText2(const IPMUnknown *pageItem,
 IPMStream *outStream,
 const IXMLExportOptions* options,
 bool32 includeFrameInRendering = kTrue,
 bool16 bItemBackgroundExportAsPng = kTrue, // by default export as PNG
 bool16 excludeText = kFalse,
 bool16 includeOtherBackgroundObjects = kFalse
 ) = 0;

 virtual void CopyOriginal(IXMLOutStream *stream, const IDFile& imagesFolder, ILinkResource* iLinkResource, ExportSessionToken sessionToken, const PMString* linkName = nil) const = 0;
};


#endif