ITextRangeNode Class Reference

#include <itextRangeNode.h>

Inheritance diagram for ITextRangeNode:

Classes
struct	_TextRange

Public Types
enum	{ kDefaultIID = IID_ITEXTRANGENODE }
typedef struct ITextRangeNode::_TextRange	TextRange

Public Member Functions
virtual void	Initialize (ITextRangeNode::TextRange range, UIDRef baseUIDRef, uint32 subItemKey=0)=0
virtual UIDRef	GetBaseUIDRef () const =0
virtual uint32	GetSubKey () const =0
virtual UIDRef	GetOwningStoryUIDRef () const =0
virtual void	SetObjectID (UIDRef baseUIDRef, uint32 subItemKey=0)=0
virtual TextIndex	GetKey () const =0
virtual TextIndex	GetStartIndex () const =0
virtual void	SetStartIndexOffset (TextIndex newOffset)=0
virtual void	SetRangeLength (int32 length)=0
virtual int32	GetRangeLength () const =0
virtual TextRange	GetTextRange () const =0
virtual TextIndex	GetParentOffset () const =0
virtual TextIndex	GetAbsoluteParentOffset () const =0
virtual TextRangeReference	GetSelfRef () const =0
virtual void	SetSelfRef (TextRangeReference ref)=0
virtual TextRangeReference	GetParentRef () const =0
virtual void	SetParentRef (TextRangeReference ref)=0
virtual TextRangeReference	GetLeftRef () const =0
virtual void	SetLeftRef (TextRangeReference ref)=0
virtual TextRangeReference	GetRightRef () const =0
virtual void	SetRightRef (TextRangeReference ref)=0
virtual bool	IsRed () const =0
virtual bool	RightIsRed () const =0
virtual bool	LeftIsRed () const =0
virtual bool	IsThreeNode () const =0
virtual void	MakeRed ()=0
virtual void	MakeBlack ()=0
virtual void	CopyColor (const ITextRangeNode *from)=0
virtual bool	operator< (const ITextRangeNode &t2) 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

This interface represents text range node on the text range Red-Black tree inside text range strand. Each node is a small boss object representing the text range and associated text object. The start index is used as key for each node.

Member Function Documentation

virtual void ITextRangeNode::CopyColor ( const ITextRangeNode *  from )

pure virtual

Copy the color from the specified text range node.

Parameters

from	- text range node to copy color from.

virtual TextIndex ITextRangeNode::GetAbsoluteParentOffset ( ) const

pure virtual

Gets the absolute value of start index offset from the parent node.

Returns

TextIndex - absolute start index offset of the node.

virtual UIDRef ITextRangeNode::GetBaseUIDRef ( ) const

pure virtual

Gets the UIDRef of the text object.

Returns

UIDRef - UIDRef of the text object occupying the range.

virtual TextIndex ITextRangeNode::GetKey ( ) const

pure virtual

Gets the key/start index of the text range node.

Returns

TextIndex - start index of the text range.

virtual UIDRef ITextRangeNode::GetOwningStoryUIDRef ( ) const

pure virtual

Gets the owning story of the text object.

Returns

UIDRef - story of the text object occupying the range.

virtual TextIndex ITextRangeNode::GetParentOffset ( ) const

pure virtual

Gets the start index offset from the parent node.

Returns

TextIndex - start index offset of the node.

virtual int32 ITextRangeNode::GetRangeLength ( ) const

pure virtual

Gets the range length of the text range node.

Returns

int32 - length of the node.

virtual TextRangeReference ITextRangeNode::GetSelfRef ( ) const

pure virtual

Get/Set method of text range reference of the node, its parent and children.

virtual uint32 ITextRangeNode::GetSubKey ( ) const

pure virtual

Gets the sub key of the text object.

Returns

uint32 - sub key of the text object. 0 if the object is UID based object.

virtual TextRange ITextRangeNode::GetTextRange ( ) const

pure virtual

Gets the text range of the text range node.

Returns

TextRange - text range of the node.

virtual void ITextRangeNode::Initialize ( ITextRangeNode::TextRange  range, UIDRef  baseUIDRef, uint32  subItemKey = 0  )

pure virtual

Initialize the text range node.

Parameters

range	- text range of the node.
baseUIDRef	- UIDRef of the text object occupying the range.
subItemKey	- sub key of the text object if it is not a UID based object.

virtual bool ITextRangeNode::IsRed ( ) const

pure virtual

Returns whevher the node is a red node.

virtual bool ITextRangeNode::IsThreeNode ( ) const

pure virtual

Returns whevher both children of the node are red nodes.

virtual bool ITextRangeNode::LeftIsRed ( ) const

pure virtual

Returns whevher the node's left child is a red node.

virtual void ITextRangeNode::MakeBlack ( )

pure virtual

Mark the node as a black node.

virtual void ITextRangeNode::MakeRed ( )

pure virtual

Mark the node as a red node.

virtual bool ITextRangeNode::RightIsRed ( ) const

pure virtual

Returns whevher the node's right child is a red node.

virtual void ITextRangeNode::SetObjectID ( UIDRef  baseUIDRef, uint32  subItemKey = 0  )

pure virtual

Sets the UIDRef and sub key of the text object.

Parameters

baseUIDRef	- UIDRef of the text object occupying the range.
subItemKey	- sub key of the text object. 0 for UID based object.

virtual void ITextRangeNode::SetRangeLength ( int32  length )

pure virtual

Sets the range length of the text range node.

Parameters

length

- length of the node.

virtual void ITextRangeNode::SetStartIndexOffset ( TextIndex  newOffset )

pure virtual

Sets the start index offset of the text range node from its parent.

Parameters

newOffset

- start index offset of the node.