GTTxtEdtInvalCookie Class Reference

#include <GTTxtEdtInvalHandler.h>

Inheritance diagram for GTTxtEdtInvalCookie:

Public Member Functions
	GTTxtEdtInvalCookie (const UIDRef &storyUIDRef, bool16 storyCreated)
virtual	~GTTxtEdtInvalCookie ()
void	InvalBeforeUndo ()
void	InvalAfterUndo ()
void	InvalBeforeRedo ()
void	InvalAfterRedo ()
void	Merge (const IInvalCookie *other)
void	AddNewCookieCrumb (const UIDRef &storyUIDRef, bool16 storyCreated)
bool16	IsUndoRequired ()
Public Member Functions inherited from IInvalCookie
virtual	~IInvalCookie ()

Detailed Description

A cookie that allows us to re-attach or re-detach our story edit observer across story create/delete undo/redo events.

Constructor & Destructor Documentation

GTTxtEdtInvalCookie::GTTxtEdtInvalCookie	(	const UIDRef &	storyUIDRef,
		bool16	storyCreated
	)

Constructor

GTTxtEdtInvalCookie::~GTTxtEdtInvalCookie ( )

virtual

Destructor

Member Function Documentation

void GTTxtEdtInvalCookie::AddNewCookieCrumb	(	const UIDRef &	storyUIDRef,
		bool16	storyCreated
	)

Add a new cookie crumb to the invalidation.

Parameters

storyUIDRef	IN the uidref of the story affected.
storyCreated	IN kTrue if the story was created, kFalse if it was deleted.

void GTTxtEdtInvalCookie::InvalAfterRedo ( )

virtual

Invalidation after redo. Called after the redo of a sequence that this cookie has an association with.

Implements IInvalCookie.

void GTTxtEdtInvalCookie::InvalAfterUndo ( )

virtual

Invalidation after undo. Called after the undo of a sequence that this cookie has an association with.

Implements IInvalCookie.

void GTTxtEdtInvalCookie::InvalBeforeRedo ( )

virtual

Invalidation before redo. Called before the redo of a sequence that this cookie has an association with.

Implements IInvalCookie.

void GTTxtEdtInvalCookie::InvalBeforeUndo ( )

virtual

Invalidation before undo. Called before the undo of a sequence that this cookie has an association with.

Implements IInvalCookie.

bool16 GTTxtEdtInvalCookie::IsUndoRequired

(

)

Returns kTrue if the cookie needs to be called on undo / redo, kFalse otherwise.

void GTTxtEdtInvalCookie::Merge ( const IInvalCookie *  other )

virtual

Called to merge the cookies when multiple cookies generated within the same transaction. For example, say there is an abortable command sequence (see IAbortableCmdSeq). For each call to CmdUtils::SetSequenceMark within the sequence the IInvalHandler::EndCollectingInvals method is called, so a separate cookie can be generated per sequence mark. At the end of the sequence these cookies are merged together into one cookie through this method.

Parameters

other

Implements IInvalCookie.