ICusDtLnkUITreeDataModel Class Reference

#include <ICusDtLnkUITreeDataModel.h>

Inheritance diagram for ICusDtLnkUITreeDataModel:

Public Types
enum	{ kDefaultIID = IID_ICUSDTLNKUITREEDATAMODEL }

Public Member Functions
virtual void	Rebuild (IWorkspace *ws)=0
virtual IWorkspace *	GetWorkspace () const =0
virtual PMString	GetRootNodeUniqueKey () const =0
virtual CusDtLnkUITreeDataNode *	GetRootNode () const =0
virtual CusDtLnkUITreeDataNode *	GetNode (const PMString &uniqueKey) const =0
virtual PMString	GetParentPath (const PMString &path) const =0
virtual int32	GetChildCount (const PMString &path)=0
virtual PMString	GetNthChildPath (const PMString &path, int32 nth)=0
virtual int32	GetChildIndexFor (const PMString &par, const PMString &kid)=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

From SDK sample; interface to data model representing tree of assets, with database files as child of root, and assets as child nodes of those.

Member Function Documentation

virtual int32 ICusDtLnkUITreeDataModel::GetChildCount ( const PMString &  path )

pure virtual

Determine the number of children given a path

Parameters

path	[IN] specifies given path

Returns

Returns number of children

Implemented in CusDtLnkUITreeDataModel.

virtual int32 ICusDtLnkUITreeDataModel::GetChildIndexFor ( const PMString &  par, const PMString &  kid  )

pure virtual

Determine the index in the parent's list of kids for a particular child

Parameters

par	[IN] specifies parent
kid	[IN] specifies kid

Returns

Returns index

Implemented in CusDtLnkUITreeDataModel.

virtual CusDtLnkUITreeDataNode* ICusDtLnkUITreeDataModel::GetNode ( const PMString &  uniqueKey ) const

pure virtual

Accessor for arbitrary node by unique key

Parameters

[IN]

uniqueKey

Returns

CusDtLnkUITreeDataNode* for node with given unique key, nil if it couldn't be found

Implemented in CusDtLnkUITreeDataModel.

virtual PMString ICusDtLnkUITreeDataModel::GetNthChildPath ( const PMString &  path, int32  nth  )

pure virtual

Get the path associated with the specified child

Parameters

path	[IN] specifies given path
nth	[IN] specifies which child

Returns

Returns path as string

Implemented in CusDtLnkUITreeDataModel.

virtual PMString ICusDtLnkUITreeDataModel::GetParentPath ( const PMString &  path ) const

pure virtual

Given a path, discover the path of its parent

Parameters

path	[IN] specifies given path

Returns

Returns path as string

Implemented in CusDtLnkUITreeDataModel.

virtual CusDtLnkUITreeDataNode* ICusDtLnkUITreeDataModel::GetRootNode ( ) const

pure virtual

Accessor for the root node

Returns

CusDtLnkUITreeDataNode* root node reference

Implemented in CusDtLnkUITreeDataModel.

virtual PMString ICusDtLnkUITreeDataModel::GetRootNodeUniqueKey ( ) const

pure virtual

Accessor for the root path

Returns

PMString giving the path associated with the root node

Implemented in CusDtLnkUITreeDataModel.

virtual IWorkspace* ICusDtLnkUITreeDataModel::GetWorkspace ( ) const

pure virtual

Access current workspace

Returns

IWorkspace* current workspace

Implemented in CusDtLnkUITreeDataModel.

virtual void ICusDtLnkUITreeDataModel::Rebuild ( IWorkspace *  ws )

pure virtual

Call to explicitly rebuild the model

Implemented in CusDtLnkUITreeDataModel.