PnlTrvFileNodeID Class Reference

#include <PnlTrvFileNodeID.h>

Inheritance diagram for PnlTrvFileNodeID:

Public Types
enum	{ kNodeType = kPnlTrvTreeViewWidgetBoss }
Public Types inherited from NodeIDClass
typedef int32	NodeType

Public Member Functions
virtual	~PnlTrvFileNodeID ()
virtual NodeType	GetNodeType () const
virtual int32	Compare (const NodeIDClass *NodeID) const
virtual NodeIDClass *	Clone () const
virtual void	Read (IPMStream *stream)
virtual void	Write (IPMStream *stream) const
const PMString &	GetPath () const
virtual PMString	GetDescription () const
Public Member Functions inherited from NodeIDClass
	NodeIDClass (const NodeIDClass &)=delete
NodeIDClass &	operator= (const NodeIDClass &)=delete

Static Public Member Functions
static NodeID_rv	Create ()
static NodeID_rv	Create (const PMString &path)

Detailed Description

Represents a node in some notional file system; this could be a platform file system, or a file within a repository such as Perforce. Overriding this class lets us populate the tree with our own data type that represents whatever we want on each node.

Constructor & Destructor Documentation

virtual PnlTrvFileNodeID::~PnlTrvFileNodeID ( )

inlinevirtual

Destructor

Member Function Documentation

NodeIDClass * PnlTrvFileNodeID::Clone ( ) const

virtual

Create a copy of this

Returns

Implements NodeIDClass.

static NodeID_rv PnlTrvFileNodeID::Create ( )

inlinestatic

Factory method to create 

new object of this class

Returns

new instance of this class

static NodeID_rv PnlTrvFileNodeID::Create ( const PMString &  path )

inlinestatic

Factory method to create new object of this class

Parameters

path	[IN] specifies initial path

Returns

new instance of this class

virtual PMString PnlTrvFileNodeID::GetDescription ( ) const

inlinevirtual

This is mostly a debug call so that TreeView asserts have more useful information

Reimplemented from NodeIDClass.

virtual NodeType PnlTrvFileNodeID::GetNodeType ( ) const

inlinevirtual

Returns

type of this node

Implements NodeIDClass.

const PMString& PnlTrvFileNodeID::GetPath ( ) const

inline

Accessor for the path associated with this node

Returns

const PMString&

void PnlTrvFileNodeID::Read ( IPMStream *  stream )

virtual

Read this from the given stream

Parameters

stream

[IN] specified stream

Returns

Implements NodeIDClass.

void PnlTrvFileNodeID::Write ( IPMStream *  stream ) const

virtual

Write this to the given stream

Parameters

[OUT]

stream

Returns

Implements NodeIDClass.