GTTxtEdtSnapshotInterface Class Reference

Inheritance diagram for GTTxtEdtSnapshotInterface:

Public Member Functions
	GTTxtEdtSnapshotInterface (IPMUnknown *boss)
virtual	~GTTxtEdtSnapshotInterface ()
UIDRef &	GetStory ()
void	SetStory (UIDRef story)
bool16	StoryValid ()
TextIndex	GetStoryIndex ()
void	SetStoryIndex (TextIndex index)
void	SetStoryAndIndex (UIDRef story, TextIndex index)
void	SnapshotReadWrite (IPMStream *s, ImplementationID implID)
Public Member Functions inherited from CPMUnknown< IGTTxtEdtSnapshotInterface >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Public Types inherited from IGTTxtEdtSnapshotInterface
enum	{ kDefaultIID = IID_IGTTXTEDTSNAPSHOTINTERFACE }
Protected Member Functions inherited from CPMUnknown< IGTTxtEdtSnapshotInterface >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IGTTxtEdtSnapshotInterface >
HelperInterface	fHelperInterface

Detailed Description

Implementation of the undoable data interface. Responsible for maintaining the last used story and text index. Using the CREATE_SNAPSHOT_PMINTERFACE macro to bind the implementation into the object model also identifies it as a snapshot interface

Constructor & Destructor Documentation

GTTxtEdtSnapshotInterface::GTTxtEdtSnapshotInterface

(

IPMUnknown *

boss

)

ctor

GTTxtEdtSnapshotInterface::~GTTxtEdtSnapshotInterface ( )

virtual

dtor

Member Function Documentation

UIDRef & GTTxtEdtSnapshotInterface::GetStory ( )

virtual

Provides the last story edited.

Returns

the last story edited.

Implements IGTTxtEdtSnapshotInterface.

TextIndex GTTxtEdtSnapshotInterface::GetStoryIndex ( )

virtual

Returns the last story edit index, the position in the text the story was edited at.

Returns

the story index.

Implements IGTTxtEdtSnapshotInterface.

void GTTxtEdtSnapshotInterface::SetStory ( UIDRef  story )

virtual

Sets the last story edited.

Parameters

story

IN the story that was edited.

Implements IGTTxtEdtSnapshotInterface.

void GTTxtEdtSnapshotInterface::SetStoryAndIndex ( UIDRef  story, TextIndex  index  )

virtual

Sets both the story and the text index relating to the last text edit.

Parameters

story	IN the story that was edited.
index	IN the text index at which the story was edited.

Implements IGTTxtEdtSnapshotInterface.

void GTTxtEdtSnapshotInterface::SetStoryIndex ( TextIndex  index )

virtual

Sets the story index. Used to indicate the story index at which a story edit occurred.

Parameters

index

IN the position the story was edited.

Implements IGTTxtEdtSnapshotInterface.

void GTTxtEdtSnapshotInterface::SnapshotReadWrite	(	IPMStream *	s,
		ImplementationID	implID
	)

Allows the internal state of the implementation to be marshalled out into the snapshot.

Parameters

s	IN the stream the snapshot is being written to
implID	IN implementation ID

bool16 GTTxtEdtSnapshotInterface::StoryValid ( )

virtual

Determines if the story maintained is valid (not kInvalidUID).

Returns

kTrue if the story is valid.

Implements IGTTxtEdtSnapshotInterface.