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

#ifndef __IINXInfo_h__
#define __IINXInfo_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"
//#include "IINXImportPolicy.h"
#include "IScript.h"
#include "IPMUnknown.h"

// ----- Includes -----

#include "DOMAttributeValue.h"
#include "ScriptInfo.h"

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

#include "INXCoreID.h"

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

class WideString;

#define kInvalidMetadataID ((IINXInfo::MetadataID)kInvalidScriptID)

class IINXInfo : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IINXINFO };

 enum INXNameStyle
 {
 kINXNameAsFormat, // decide by INX format style 
 kINXNameLong, // always get verbose name
 kINXNameShort // always get short name (INX traditional)
 };

 typedef K2Vector<DOMAttributeValue> MetadataValueList;
 typedef ScriptID MetadataID;

public:
 virtual void Reset() = 0;
 
 // Metadata
 virtual bool16 GetElementMetadata(IDOMElement::DOMElementID elemID, MetadataID keyID, MetadataValueList &values) const = 0;

 // Metadata
 virtual bool16 GetElementMetadata_ElementOnly(IDOMElement::DOMElementID elemID, MetadataID keyID, DOMAttributeValue &value) const = 0;

 virtual bool16 GetAttributeMetadata(IDOMElement::DOMElementID elemID, IDOMElement::DOMAttributeID attrID, MetadataID keyID, MetadataValueList &values) const = 0;

 // Name <--> ID
 virtual WideString GetElementName(IDOMElement::DOMElementID elemID, INXNameStyle style = kINXNameAsFormat) const = 0;

 virtual WideString GetElementName(const ScriptInfo::ObjectScriptElement* pElem) const = 0;

 virtual IDOMElement::DOMElementID GetElementID(const WideString &name) const = 0;

 virtual const ObjectScriptElement * GetElementID(const WideString &name, IDOMElement::DOMElementID &elemID) const = 0;

 virtual WideString GetPropertyName(IDOMElement::DOMElementID elemID, IDOMElement::DOMAttributeID propID) const = 0;

 virtual IDOMElement::DOMAttributeID GetPropertyID(IDOMElement::DOMElementID elemID, const WideString &propName) const = 0;

 virtual IDOMElement::DOMAttributeID GetPropertyID(const ScriptInfo::ObjectScriptElement* pElem, const WideString &propName) const = 0;

 virtual const PropertyScriptElement * GetPropertyID(const ScriptInfo::ObjectScriptElement* pElem, const WideString &propName, IDOMElement::DOMAttributeID &attrID) const = 0;

 virtual WideString GetEnumValueName(ScriptID eValueID) const = 0;

 virtual ScriptID GetEnumValueID(const WideString &name) const = 0;
 
 // Element info
 virtual bool16 IsExcludedChild(const ObjectScriptElement* parentInfo, const ObjectScriptElement* childInfo) const = 0;

 virtual bool16 DoesElementInheritFrom(IDOMElement::DOMElementID elemType, IDOMElement::DOMElementID ancestorType) const = 0;

 virtual bool16 IsPreferenceObject(IDOMElement *element) const = 0;

 virtual const EngineContext &GetRequestContext() const = 0;

 virtual bool16 IsINXContextActive() const = 0;

 // return kTrue if INX export session in progress
 virtual bool16 IsINXExportSession() const = 0;

 // return kTrue if INX import session in progress
 virtual bool16 IsINXImportSession() const = 0;
};

#endif // __IINXInfo_h__