#include <IINXInfo.h>

Inheritance diagram for IINXInfo:

Public Types
enum	{ kDefaultIID = IID_IINXINFO }

enum	INXNameStyle { kINXNameAsFormat, kINXNameLong, kINXNameShort }

typedef K2Vector < DOMAttributeValue >	MetadataValueList

typedef ScriptID	MetadataID

Public Member Functions
virtual void	Reset ()=0

virtual bool16	GetElementMetadata (IDOMElement::DOMElementID elemID, MetadataID keyID, MetadataValueList &values) const =0

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

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

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

virtual bool16	IsINXExportSession () const =0

virtual bool16	IsINXImportSession () const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Provides information about INX elements and attributes.

This interface is intened to be used under INX context (both import and export). If you use this interface outside of INX context, result is not predictable. You may crash or get wrong return value.

Member Function Documentation

virtual bool16 IINXInfo::DoesElementInheritFrom	(	IDOMElement::DOMElementID	elemType,
		IDOMElement::DOMElementID	ancestorType
	)		const

pure virtual

Determines whether a particular type of element is a subclass of another.

Parameters

elemType	IN The type to test.
ancestorType	IN The ancestor type of interest.

Returns: kTrue if the type is a subclass of the ancestor, kFalse if not.

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

pure virtual

Returns metadata associated with a type of DOM attribute.

Parameters

elemID	IN The element type.
attrID	IN The attribute type.
keyID	IN The metadata type.
values	OUT The metadata values, if any.

Returns: kTrue if values were found, kFalse if not.

See Also: INXMetadataDefs.h

virtual IDOMElement::DOMElementID IINXInfo::GetElementID ( const WideString & name ) const

pure virtual

Get the ID of a DOM element.

Parameters

name	IN The element name.

Returns: The element ID. An invalid ID will be returned if the name is unknown.

virtual const ObjectScriptElement* IINXInfo::GetElementID	(	const WideString &	name,
		IDOMElement::DOMElementID &	elemID
	)		const

pure virtual

Get the ID and object script element of a DOM element. This version is only for new markup language environment (IDML).

Parameters

name	IN The element name.
elemID	OUT The element ID

Returns: The ObjectScriptElement *. A null point will be returned if the name is unknown.

virtual bool16 IINXInfo::GetElementMetadata	(	IDOMElement::DOMElementID	elemID,
		MetadataID	keyID,
		MetadataValueList &	values
	)		const

pure virtual

Returns metadata associated with a type of DOM element, will use the DOM element's inheritance hierarchy to find any and all matches

Parameters

elemID	IN The element type.
keyID	IN The metadata type.
values	OUT The metadata values, if any.

Returns: kTrue if values were found, kFalse if not.

See Also: INXMetadataDefs.h

virtual bool16 IINXInfo::GetElementMetadata_ElementOnly	(	IDOMElement::DOMElementID	elemID,
		MetadataID	keyID,
		DOMAttributeValue &	value
	)		const

pure virtual

Returns metadata associated with a type of DOM element, searching only that DOM element for associated data.

Parameters

elemID	IN The element type.
keyID	IN The metadata type.
value	OUT The metadata valuep, if any.

Returns: kTrue if values were found, kFalse if not.

See Also: INXMetadataDefs.h

virtual WideString IINXInfo::GetElementName	(	IDOMElement::DOMElementID	elemID,
		INXNameStyle	style = `kINXNameAsFormat`
	)		const

pure virtual

Get the name of a DOM element.

Parameters

elemID	IN The element type.
style	IN The style of name requested.

Returns: The element name. The string will be empty if the element type is unknown.

virtual WideString IINXInfo::GetElementName ( const ScriptInfo::ObjectScriptElement * pElem ) const

pure virtual

Get the name of a DOM element. Note: This method is more efficient than the one that uses an element ID.

Parameters

elemID IN The element type.

Returns: The element name. The string will be empty if the element type is unknown.

virtual ScriptID IINXInfo::GetEnumValueID ( const WideString & name ) const

pure virtual

Get an enum value's ID.

Parameters

name	IN The enum value name.

Returns: The enum value ID. An invalid ID will be returned if the name is unknown.

virtual WideString IINXInfo::GetEnumValueName ( ScriptID eValueID ) const

pure virtual

Get an enum value's name.

Parameters

eValueID IN The enum value ID.

Returns: The enum value's name. The string will be empty if the enum value is unknown.

virtual IDOMElement::DOMAttributeID IINXInfo::GetPropertyID	(	IDOMElement::DOMElementID	elemID,
		const WideString &	propName
	)		const

pure virtual

Get the ID of an element's attribute.

Parameters

elemID	IN The element type.
propName	IN The attribute name.

Returns: The attribute ID. An invalid ID will be returned if the name is unknown.

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

pure virtual

Get the ID of an element's attribute. Note: This method is more efficient than the one that uses an element ID.

Parameters

pElem	IN The element type.
propName	IN The attribute name.

Returns: The attribute ID. An invalid ID will be returned if the name is unknown.

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

pure virtual

Get the ID and property script element of an element's attribute. This version is only for new markup language environment (IDML).

Parameters

pElem	IN The element type.
propName	IN The attribute name.
attrID	OUT The attribute ID

Returns: The PropertyScriptElement *. A null point will be returned if the name is unknown.

virtual WideString IINXInfo::GetPropertyName	(	IDOMElement::DOMElementID	elemID,
		IDOMElement::DOMAttributeID	propID
	)		const

pure virtual

Get the name of an element's attribute.

Parameters

elemID	IN The element type.
propID	IN The attribute type.

Returns: The attribute name. The string will be empty if the attribute is unknown.

virtual const EngineContext& IINXInfo::GetRequestContext ( ) const

pure virtual

Access the current request context

virtual bool16 IINXInfo::IsExcludedChild	(	const ObjectScriptElement *	parentInfo,
		const ObjectScriptElement *	childInfo
	)		const

pure virtual

Determine whether a particular type of element should be ignored when it appears as a child of another type of element.

Parameters

parentInfo	IN The parent element info.
childInfo	IN The child element info.

Returns: kTrue if the child type should be ignored, kFalse if not.

virtual bool16 IINXInfo::IsINXContextActive ( ) const

pure virtual

Returns: kTrue if INX is active

virtual bool16 IINXInfo::IsPreferenceObject ( IDOMElement * element ) const

pure virtual

Determine whether an element is a type of preference object.

Parameters

element IN The element.

Returns: kTrue if it is a preference object, kFalse if not.

virtual void IINXInfo::Reset ( )

pure virtual

Release all cached resources. Should be called when a client is finished using this interface.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation