IBookMarkData Class Reference

#include <IBookMarkData.h>

Inheritance diagram for IBookMarkData:

Public Types
enum	{ kDefaultIID = IID_IBOOKMARKDATA }

Public Member Functions
virtual void	operator= (const IBookMarkData *other)=0
virtual void	SetName (const PMString &bookMark)=0
virtual PMString	GetName () const =0
virtual void	SetIndentLevel (int32 newIndentLevel)=0
virtual int32	GetIndentLevel () const =0
virtual void	SetContainingBookMarkUID (UID parentBookMark)=0
virtual UID	GetContainingBookMarkUID () const =0
virtual void	AddChild (UID childBookmark)=0
virtual void	RemoveChild (UID childBookmark)=0
virtual void	MoveChild (const UID child, int32 newIndex)=0
virtual int32	GetChildCount () const =0
virtual UID	GetNthChild (int32 childIndex) const =0
virtual int32	GetChildWithUID (const UID child) const =0
virtual void	SetDestinationUID (const UID dest)=0
virtual UID	GetDestinationUID () const =0
virtual void	GotoDestination () const =0
virtual ErrorCode	ValidateBookmark ()=0
virtual void	Invariant () const =0
virtual void	Invalidate ()=0
virtual void	AddConversionData (UID parentBookMark, UID destinationUID)=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

Abstract interface to properties associated with bookmarks.

See Also

kBookmarkBoss

Member Function Documentation

virtual void IBookMarkData::AddChild ( UID  childBookmark )

pure virtual

Add a new child to the end of this bookmark

Parameters

childBookmark

- UID of new child to add

Returns

none

virtual void IBookMarkData::AddConversionData ( UID  parentBookMark, UID  destinationUID  )

pure virtual

Add information all at once (used for converting Anna documents to Dragontail)

Parameters

parentBookMark	- The correct parent bookmark
destinationUID	- The correct destination UID

Returns

virtual int32 IBookMarkData::GetChildCount ( ) const

pure virtual

Get the number of children of this bookmark

Parameters

none

Returns

int32 - Number of chilren in child list

virtual int32 IBookMarkData::GetChildWithUID ( const UID  child ) const

pure virtual

Get the index of a specific child by UID

Parameters

child

- UID of the child to get

Returns

int32 - Index of the child

virtual UID IBookMarkData::GetContainingBookMarkUID ( ) const

pure virtual

Get the UID of this bookmarks parent

Parameters

none

Returns

Parent UID (documents UID indicates that this is at the root level)

virtual UID IBookMarkData::GetDestinationUID ( ) const

pure virtual

Get the destination that this bookmark points to

Parameters

none

Returns

UID - Destination's UID

virtual int32 IBookMarkData::GetIndentLevel ( ) const

pure virtual

Get the indent level of the bookmark

Parameters

none

Returns

int32 - The indent level of this bookmark

virtual PMString IBookMarkData::GetName ( ) const

pure virtual

Get the name of the bookmark (This name will be marked as translated)

Parameters

none

Returns

PMString - The name of the bookmark

virtual UID IBookMarkData::GetNthChild ( int32  childIndex ) const

pure virtual

Get a specific child by index

Parameters

childIndex

- Index of child to get

Returns

UID - child at Nth location

virtual void IBookMarkData::GotoDestination ( ) const

pure virtual

Show the destination that this bookmark points to

Parameters

none

virtual void IBookMarkData::Invalidate ( )

pure virtual

Make this bookmark invalid (Used for conversion from Anna to Dragontail)

Parameters

none

Returns

none

virtual void IBookMarkData::Invariant ( ) const

pure virtual

Make sure that after methods in this class change things the bookmark class is still OK

Parameters

none

Returns

none

virtual void IBookMarkData::MoveChild ( const UID  child, int32  newIndex  )

pure virtual

Move a child to a new location

Parameters

child	- The UI of the child to move (Must already be in this bookmark's child list)
newIndex	- The new lcoation to move the child to (-1 == end of list)

Returns

virtual void IBookMarkData::RemoveChild ( UID  childBookmark )

pure virtual

Remove a specific child from this bookmarks child list

Parameters

childBookmark

- UID of the child to remove

Returns

none

virtual void IBookMarkData::SetContainingBookMarkUID ( UID  parentBookMark )

pure virtual

Set the UID of this bookmarks parent

Parameters

parentBookMark

- Parent UID (documents UID indicates that this is at the root level)

Returns

none

virtual void IBookMarkData::SetDestinationUID ( const UID  dest )

pure virtual

Set the destination that this bookmark points to

Parameters

dest	- The appropriate destination

virtual void IBookMarkData::SetIndentLevel ( int32  newIndentLevel )

pure virtual

Set the indent level of the bookmark

Parameters

newIndentLevel

- New indent (0 = root)

Returns

none

virtual void IBookMarkData::SetName ( const PMString &  bookMark )

pure virtual

Set the name of the bookmark

Parameters

&bookMark

- The new name to use

Returns

none

virtual ErrorCode IBookMarkData::ValidateBookmark ( )

pure virtual

Ensure that this bookmark is OK (Make sure that parent and children lists are valid. Also make sure that internal data is in a valid state)

Parameters

none

Returns

ErrorCode - Error state of bookmark - kSuccess = Bookmark is OK