IGTTxtEdtSnapshotInterface Class Reference

#include <IGTTxtEdtSnapshotInterface.h>

Inheritance diagram for IGTTxtEdtSnapshotInterface:

Public Types
enum	{ kDefaultIID = IID_IGTTXTEDTSNAPSHOTINTERFACE }

Public Member Functions
virtual UIDRef &	GetStory ()=0
virtual void	SetStory (UIDRef story)=0
virtual bool16	StoryValid ()=0
virtual TextIndex	GetStoryIndex ()=0
virtual void	SetStoryAndIndex (UIDRef story, TextIndex index)=0
virtual void	SetStoryIndex (TextIndex index)=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

Maintains the last edited story position.

Member Function Documentation

virtual UIDRef& IGTTxtEdtSnapshotInterface::GetStory ( )

pure virtual

get the cached story

Returns

the story.

Implemented in GTTxtEdtSnapshotInterface.

virtual TextIndex IGTTxtEdtSnapshotInterface::GetStoryIndex ( )

pure virtual

get the text index of the story.

Returns

the index within the story.

Implemented in GTTxtEdtSnapshotInterface.

virtual void IGTTxtEdtSnapshotInterface::SetStory ( UIDRef  story )

pure virtual

set the cached story

Parameters

story

IN the story.

Implemented in GTTxtEdtSnapshotInterface.

virtual void IGTTxtEdtSnapshotInterface::SetStoryAndIndex ( UIDRef  story, TextIndex  index  )

pure virtual

Set the cached story and the index within it.

Parameters

story	IN the story.
index	IN the text index.

Implemented in GTTxtEdtSnapshotInterface.

virtual void IGTTxtEdtSnapshotInterface::SetStoryIndex ( TextIndex  index )

pure virtual

Set the story index.

Parameters

index

IN the index.

Implemented in GTTxtEdtSnapshotInterface.

virtual bool16 IGTTxtEdtSnapshotInterface::StoryValid ( )

pure virtual

Is the story valid?

Returns

kTrue if the story is valid.

Implemented in GTTxtEdtSnapshotInterface.