IWritingDocRefData Class Reference

#include <IWritingDocRefData.h>

Inheritance diagram for IWritingDocRefData:

Public Types
enum	{ kDefaultIID = IID_IWRITINGDOCREFDATA }

Public Member Functions
virtual const UIDRef &	GetDocRef () const =0
virtual void	SetDocRef (const UIDRef &docRef, bool16 duringResetView=kFalse)=0
virtual void	ResetDocRef (bool16 duringResetView=kFalse)=0
virtual void	ActivateInvalHandler ()=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 is used by story, galley, notes and text macro views to hold a reference to the document they are viewing. It also is used to track invaling for undo screen redrawing.

Member Function Documentation

virtual void IWritingDocRefData::ActivateInvalHandler ( )

pure virtual

Tell inval handler to start collecting invals if it isn't alread doing so.

Returns

none

virtual const UIDRef& IWritingDocRefData::GetDocRef ( ) const

pure virtual

Get the document uid reference being viewed in the view.

Returns

An uidRef of the document being viewed.

virtual void IWritingDocRefData::ResetDocRef ( bool16  duringResetView = kFalse )

pure virtual

Used by the undo to reset inval handler information. Internal use.

Parameters

duringResetView

is an undo/redo detail external use false (the default)

Returns

none

virtual void IWritingDocRefData::SetDocRef ( const UIDRef &  docRef, bool16  duringResetView = kFalse  )

pure virtual

Set the document uid reference for the view. This shouldn't normally be called by third parties.

Parameters

docRef	reference of document to view
duringResetView	is an undo/redo detail external use false (the default)

Returns

none