IIndexXRefEntryCmdData Class Reference

#include <IIndexXRefEntryCmdData.h>

Inheritance diagram for IIndexXRefEntryCmdData:

Public Types
enum	{ kDefaultIID = IID_IINDEXXREFENTRYCMDDATA }

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 const IndexTopicEntry &	GetRefedTopicEntry () const =0
virtual void	SetRefedTopicEntry (const IndexTopicEntry &refedTopicEntry)=0
virtual const UID	GetRefedTopicSectionUID () const =0
virtual void	SetRefedTopicSectionUID (const UID refedTopicSectionUID)=0
virtual int32	GetRefedTopicNodeId () const =0
virtual void	SetRefedTopicNodeId (int32 refedTopicNodeId)=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

Interface data used by kCreateIndexXRefEntryCmdBoss and kEditIndexXRefEntryCmdBoss that contains information regarding the referenced topic entry.

See Also

kCreateIndexXRefEntryCmdBoss, kEditIndexXRefEntryCmdBoss

Member Function Documentation

virtual const IndexTopicEntry& IIndexXRefEntryCmdData::GetRefedTopicEntry ( ) const

pure virtual

Retrieves the referenced topic entry.

Returns

the referenced index topic entry.

virtual int32 IIndexXRefEntryCmdData::GetRefedTopicNodeId ( ) const

pure virtual

Retrieves the node ID of the referenced topic entry.

Returns

the node ID of the referenced index topic entry.

virtual const UID IIndexXRefEntryCmdData::GetRefedTopicSectionUID ( ) const

pure virtual

Retrieves the UID of the section which contains the referenced topic entry.

Returns

the UID of the topic section that contains the referenced index topic entry.

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

pure virtual

Gets the cross-reference type.

Parameters

customString

[OUT] - if this pointer is not nil, it will to be set to the custom string used for custom cross-references.

Returns

the type of the cross-reference.

virtual void IIndexXRefEntryCmdData::SetRefedTopicEntry ( const IndexTopicEntry &  refedTopicEntry )

pure virtual

Sets the referenced topic entry. The client of the command should either use this method or use SetRefedTopicSectionUID together with SetRefedTopicNodeId.

Parameters

refedTopicEntry

[IN] - the referenced topic entry.

virtual void IIndexXRefEntryCmdData::SetRefedTopicNodeId ( int32  refedTopicNodeId )

pure virtual

Sets the node ID of the referenced topic. The caller should also call SetRefedTopicSectionUID if it calls this method.

Parameters

refedTopicNodeId

[IN] - the node id of the referenced topic entry.

virtual void IIndexXRefEntryCmdData::SetRefedTopicSectionUID ( const UID  refedTopicSectionUID )

pure virtual

Sets the section ID of the referenced topic. The caller should also call SetRefedTopicNodeId if it calls this method.

Parameters

refedTopicSectionUID

[IN] - the UID of the section ID that contains the referenced topic entry.

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

pure virtual

Sets the type of the cross-reference and the custom string.

Parameters

xRefType	[IN] - the type of the cross-reference.
customString	[IN] - tthe custom string used for cross-reference. This parameter is mandatory if the xRefType is IIndexXRefEntryData::kCustomBefore or IIndexXRefEntryData::kCustomAfter.