IXMLHierarchyCmdData Class Reference

#include <IXMLHierarchyCmdData.h>

Inheritance diagram for IXMLHierarchyCmdData:

Public Types
enum	{ kDefaultIID = IID_IXMLHIERARCHYCMDDATA }

Public Member Functions
virtual void	Set (const XMLReference &newItem, const XMLReference &parent, int32 indexInParent)=0
virtual const XMLReference &	GetElementToAdd () const =0
virtual const XMLReference &	GetParent () const =0
virtual int32	GetIndexInParent () 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

Data interface for adding elements to the logical structure tree. Similar to IHierarchyCmdData, but handles adding only one element at a time. Not likely to be used from client code, use IXMLElementCommands wrapper methods rather than processing low-level command.

Member Function Documentation

virtual const XMLReference& IXMLHierarchyCmdData::GetElementToAdd ( ) const

pure virtual

Return the item to add

Returns

XMLReference of item to add

virtual int32 IXMLHierarchyCmdData::GetIndexInParent ( ) const

pure virtual

Return the index within the parent's list of children

Returns

int32 giving the index within the parent's list of children

virtual const XMLReference& IXMLHierarchyCmdData::GetParent ( ) const

pure virtual

Return the parent element for the new item

Returns

XMLReference of parent of new item

virtual void IXMLHierarchyCmdData::Set ( const XMLReference &  newItem, const XMLReference &  parent, int32  indexInParent  )

pure virtual

Specify where on the hierarchy to insert the new item; the parent element, and the index within the parent's list of children.

Parameters

newItem	specifies item to add
parent	specifies its parent
indexInParent	specifies where in the parent the item should be added