Inheritance diagram for IHierarchyCmdData:

Public Types
enum	{ kDefaultIID = IID_IHIERARCHYCMDDATA }

Public Member Functions
virtual void	SetParent (const UIDList &parentList)=0

virtual const UIDList &	GetParent () const =0

virtual void	SetIndexInParent (const K2Vector< int32 > &indexList)=0

virtual const K2Vector< 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

A command interface for kAddToHierarchyCmdBoss. Similar to INewPageItemCmd, you need the parent's UIDRef in order to do AddToHierarchyCmd.

Member Function Documentation

virtual const K2Vector<int32>& IHierarchyCmdData::GetIndexInParent ( ) const

pure virtual

Returns index positions for each item in its parent hierarchy (from SetIndexInParent)

Returns: K2Vector<int32>& Returns a reference to a vector of parent indices for each item in item list for kAddToHierarchyCmdBoss.

virtual const UIDList& IHierarchyCmdData::GetParent ( ) const

pure virtual

Returns the parent list from SetParent

virtual void IHierarchyCmdData::SetIndexInParent ( const K2Vector< int32 > & indexList )

pure virtual

The item's index in the parent for IHierarchy::Add. Must match up with the itemlist passed to the command (kAddToHierarchyCmdBoss).

Parameters

indexList [IN] index list for each item in command's item list in the parent hierarchy. Typically IHierarchy::kAtTheEnd.

virtual void IHierarchyCmdData::SetParent ( const UIDList & parentList )

pure virtual

Set the item's parent. Could be the UID of a spread layer, a graphic frame, etc.

Parameters

parentList [IN] list of parent's for each item in the item list for the command (kAddToHierarchyCmdBoss)