#include <IXRefInfoData.h>

Inheritance diagram for IXRefInfoData:

Public Types
enum	{ kDefaultIID = IID_IXREFINFODATA }

Public Member Functions
virtual void	SetIsXRef (bool16 isXRef)=0

virtual bool16	IsXRef () const =0

virtual UID	GetXRefFormat () const =0

virtual void	SetXRefFormat (UID formatUID)=0

virtual void	SetSourceStamp (UID storyUID, uint32 version)=0

virtual void	GetSourceStamp (UID &storyUID, uint32 &version) const =0

virtual void	GetSourceStamp (StampInfo &stamp) const =0

virtual void	SetDestinationStamp (UID storyUID, uint32 version)=0

virtual void	GetDestinationStamp (UID &storyUID, uint32 &version) const =0

virtual void	GetDestinationStamp (StampInfo &stamp) const =0

virtual void	SetExternDocStamp (uint32 docStamp)=0

virtual uint32	GetExternDocStamp () const =0

virtual void	SetDoNotUpdate (bool16 doNotUpdate)=0

virtual bool16	DoNotUpdate () const =0

virtual void	SetDestinationStatusChangeCount (uint32 destStatusChgCnt)=0

virtual uint32	GetDestinationStatusChangeCount () const =0

virtual bool16	IsOutOfDate () const =0

virtual bool16	NeedStatusCheck () const =0

virtual bool16	CheckXRefStatus (bool16 &linkChanged)=0

virtual PMString	GetPageNumString () const =0

virtual PMString	GetChapterNumString () const =0

virtual IHyperlinkUtils::XRefDestStatus	GetXRefSourceContent (UIDRef destUIDRef, PMString &newContent, K2Vector< CharStyleRange > &charStyleRanges, K2Vector< uint32 > &pageNumLocations, K2Vector< uint32 > &chapterNumLocations, std::map< TextIndex, WideString > variableLocations, std::map< TextIndex, TextIndex > inlineLocations)=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 for kHyperlinkTextSourceBoss to store all the data related to cross reference text source. Both cross reference text source and hyperlink text source are represented by kHyperlinkTextSourceBoss. We distinguish the two by looking at the data in this interface.

Member Function Documentation

virtual bool16 IXRefInfoData::CheckXRefStatus ( bool16 & linkChanged )

pure virtual

Checks the status of the cross reference if it is marked as need status check.

Parameters

linkChanged - [OUT] kTrue if the corresponding hyperlink object has changed. kFalse otherwise.

Returns: bool16 - kTrue if the cross reference is up to date, kFalse if is out of date.

virtual bool16 IXRefInfoData::DoNotUpdate ( ) const

pure virtual

Returns whether or not this xref source can be updated.

Returns: bool16 - kTrue not to update

virtual uint32 IXRefInfoData::GetDestinationStatusChangeCount ( ) const

pure virtual

Returns current destination status change count.

Returns: uint32 - change count

virtual UID IXRefInfoData::GetXRefFormat ( ) const

pure virtual

Get the UID of the format this cross reference uses

Returns: UID - UID of the format

virtual IHyperlinkUtils::XRefDestStatus IXRefInfoData::GetXRefSourceContent	(	UIDRef	destUIDRef,
		PMString &	newContent,
		K2Vector< CharStyleRange > &	charStyleRanges,
		K2Vector< uint32 > &	pageNumLocations,
		K2Vector< uint32 > &	chapterNumLocations,
		std::map< TextIndex, WideString > *	variableLocations,
		std::map< TextIndex, TextIndex > *	inlineLocations
	)

pure virtual

Generate the cross reference source content from the destination

Parameters

destUIDRef	- destination UIDRef
newContent	- [OUT] generated cross reference source content
charStyleRanges	- [OUT] contains ranges where to apply character styles in the generated new source content
pageNumLocations	- [OUT] contains offset of page number characters in the new source content
variableLocations	- [OUT] list of text variables and index offset in the new source content
inlineLocations	- [OUT] list of inline object locations in the source and destination

Returns: IHyperlinkUtils::XRefDestStatus - status of the destination

virtual bool16 IXRefInfoData::IsOutOfDate ( ) const

pure virtual

Returns kTrue if one of following conditions is true: (1) source should not be updated; (2) destination is missing or in invalid location; (3) source is known to be out of date;

virtual bool16 IXRefInfoData::IsXRef ( ) const

pure virtual

Return whether or not this is a cross reference source

Returns: bool16 - kTrue if it is cross reference source

virtual bool16 IXRefInfoData::NeedStatusCheck ( ) const

pure virtual

Checks whether or not we will need detailed check to determine if the source content if up to date or not. Returns kTrue if one of following conditions is true: (1) source story stamp changed; (2) destination story stamp changed for internal destination or external destination in opened documents; (3) document stamp changed for external destination in closed documents.

virtual void IXRefInfoData::SetDestinationStamp	(	UID	storyUID,
		uint32	version
	)

pure virtual

Set the story stamp of the x-ref destination

Parameters

storyUID	- UID of the owning story
version	- version of the story

virtual void IXRefInfoData::SetDestinationStatusChangeCount ( uint32 destStatusChgCnt )

pure virtual

Set destination status change count.

Parameters

destStatusChgCnt - destination status change count to set to.

virtual void IXRefInfoData::SetDoNotUpdate ( bool16 doNotUpdate )

pure virtual

Set whether or not this xref source can be updated.

Parameters

doNotUpdate - kTrue for not to update

virtual void IXRefInfoData::SetExternDocStamp ( uint32 docStamp )

pure virtual

Set the document stamp of the external x-ref destination

Parameters

docStamp - document stamp of the external document which contains the x-ref destination

virtual void IXRefInfoData::SetIsXRef ( bool16 isXRef )

pure virtual

Set whether or not this is a cross reference source

Parameters

isXRef - kTrue for cross reference source

virtual void IXRefInfoData::SetSourceStamp	(	UID	storyUID,
		uint32	version
	)

pure virtual

Set the story stamp of the x-ref source

Parameters

storyUID	- UID of the owning story
version	- version of the story

virtual void IXRefInfoData::SetXRefFormat ( UID formatUID )

pure virtual

Set the UID of the format this cross reference uses

Parameters

formatUID - UID of the format to set to

Public Types

Public Member Functions

Detailed Description

Member Function Documentation