Inheritance diagram for IIndexXRefEntryData:

Public Types
enum	{ kDefaultIID = IID_IINDEXXREFENTRYDATA }

enum	XRefType { kSeeOrAlso = 0, kSee = 1, kSeeAlso = 2, kSeeHerein = 3, kSeeAlsoHerein = 4, kCustom = 5, kCustomBefore = 5, kCustomAfter = 6 }

Public Member Functions
virtual IIndexXRefEntryData::XRefType	GetXRefType (WideString *customString=NULL) const =0

virtual void	SetXRefType (const IIndexXRefEntryData::XRefType xRefType, const WideString *customString=NULL)=0

virtual UID	GetXRefLinkUID () const =0

virtual void	SetXRefLinkUID (const UID xRefLinkUID)=0

virtual void	GetRefedTopicEntry (IndexTopicEntry &topicEntry, UID sectionUID=nil, int32 nodeId=nil) const =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

Data interface that aggregates information about a cross-reference entry.

Member Enumeration Documentation

Type of cross-reference

virtual void IIndexXRefEntryData::GetRefedTopicEntry	(	IndexTopicEntry &	topicEntry,
		UID *	sectionUID = `nil`,
		int32 *	nodeId = `nil`
	)		const

pure virtual

Retrieves the topic entry that this cross-reference refers to.

Parameters

topicEntry	[OUT] - the topic entry refered by this cross-reference.
sectionUID	[OUT] - the UID of the topic section.
nodeId	[OUT] - the topic node id within the section.

virtual UID IIndexXRefEntryData::GetXRefLinkUID ( ) const

pure virtual

Retrieves the UID of the kIndexXRefLinkBoss associated with this cross-reference.

virtual IIndexXRefEntryData::XRefType IIndexXRefEntryData::GetXRefType ( WideString * customString = NULL ) const

pure virtual

Retrieves the type of the cross-reference.

Parameters

customString [OUT] - optional, will contain the value of the custom string on return.

virtual void IIndexXRefEntryData::SetXRefLinkUID ( const UID xRefLinkUID )

pure virtual

Sets the UID of the kIndexXRefLinkBoss associated with this cross-reference.

Parameters

xRefLinkUID [IN] - UID of kIndexXRefLinkBoss.

virtual void IIndexXRefEntryData::SetXRefType	(	const IIndexXRefEntryData::XRefType	xRefType,
		const WideString *	customString = `NULL`
	)

pure virtual

Sets the type of the cross-reference.

Parameters

xRefType	[IN] - the type of the cross-reference.
customString	[IN] - if the type is custom, this parameter specifies the value of the custom string.