IINXManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Steve Pellegrin
// 
// $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.
// 
// 
// This file simply includes the sources file from the AXE Core Tech XML parser required
// to be built on the client side for initilaiztion and termination.
// 
//========================================================================================

#ifndef __IINXManager_h__
#define __IINXManager_h__

// Adobe Patent or Adobe Patent Pending Invention Included Within this File
// Adobe patent application tracking B234, entitled Method and apparatus for formatting portion of content, inventors: Craig Rainwater, Steve Pellegrin, Robin Briggs 

// ----- Interfaces -----

#include "IDOMElement.h"

// ----- Includes -----
#include "PMString.h"

// ----- ID.h files -----

#include "INXCoreID.h"

// ----- Forward -----

class IINXImportPolicy;
class IINXExportPolicy;
class IINXImportValidation;
class INXOptions;
class IPMStream;
class IINXErrorHandler;

class IINXManager : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IINXMANAGER };

 typedef IINXErrorHandler * (*CreateINXErrorHandler) ();

public:
 // INX export related function.
 virtual ErrorCode ExportINX(const IDOMElement::ElementList &roots, IINXExportPolicy *policy, 
 IPMStream *stream, UIFlags uiFlags = kFullUI) = 0;

 virtual void BeginExportSession() = 0;

 virtual void EndExportSession() = 0;


 // INX import related function
 virtual ErrorCode ValidateINX(IPMStream *stream, IINXImportValidation *validation = nil) = 0;

 virtual ErrorCode ImportINX(IDOMElement * root, IINXImportPolicy *policy, IPMStream *stream,
 const PMString *progressBarTitle = nil, UIFlags uiFlags = kFullUI, IDOMElement **object = nil) = 0;

 virtual void BeginImportSession() = 0;

 virtual void EndImportSession() = 0;


 // INX error handling related function
 virtual void SetINXErrorHandler(CreateINXErrorHandler handlerOwner) = 0;

 virtual IINXErrorHandler * GetINXErrorHandler(CreateINXErrorHandler * fnPointer = nil) const = 0;

 //NOTE: Adobe internal use only
 virtual void ImportHelperAddCacheEntry(const PMString& inKey, const PMString& inValue) = 0;
 virtual PMString ImportHelperGetCacheEntry(const PMString& inKey) = 0;
};

#endif // __IINXManager_h__