ICreateIndexXRefEntryCmdData Class Reference

#include <ICreateIndexXRefEntryCmdData.h>

Inheritance diagram for ICreateIndexXRefEntryCmdData:

Public Types
enum	{ kDefaultIID = IID_ICREATEINDEXXREFENTRYCMDDATA }

Public Member Functions
virtual const UIDRef &	GetTopicListUIDRef () const =0
virtual void	SetTopicListUIDRef (const UIDRef &topicListUID)=0
virtual const IndexTopicEntry &	GetTopicEntry () const =0
virtual void	SetTopicEntry (const IndexTopicEntry &topicEntry)=0
virtual const UID	GetTopicSectionUID () const =0
virtual void	SetTopicSectionUID (const UID topicSectionUID)=0
virtual int32	GetTopicNodeId () const =0
virtual void	SetTopicNodeId (int32 indexTopicNodeId)=0
virtual bool16	GetDoNotifyFlag () const =0
virtual void	SetDoNotifyFlag (bool16 notify)=0
virtual bool16	GetAllowRecursiveXRef () const =0
virtual void	SetAllowRecursiveXRef (bool16 allow)=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

Command data interface used for creating an index cross-reference entry.

Member Function Documentation

virtual bool16 ICreateIndexXRefEntryCmdData::GetAllowRecursiveXRef ( ) const

pure virtual

Retrieves the "allow recursive cross-reference" flag. If a topic AAA references another topic BBB (see "BBB") and BBB references AAA (see "AAA") it is called a recursive cross-reference.

Returns

kTrue if recursive cross-references are allowed, kFalse if not.

virtual bool16 ICreateIndexXRefEntryCmdData::GetDoNotifyFlag ( ) const

pure virtual

Retrieves the "notify" flag.

Returns

the value of the flag.

virtual const IndexTopicEntry& ICreateIndexXRefEntryCmdData::GetTopicEntry ( ) const

pure virtual

Retrieves the topic entry where the cross-reference will be inserted.

See Also

IndexTopicEntry.

Returns

the topic entry property.

virtual const UIDRef& ICreateIndexXRefEntryCmdData::GetTopicListUIDRef ( ) const

pure virtual

Retrieves the topic list property.

Returns

UIDRef of the topic list.

virtual int32 ICreateIndexXRefEntryCmdData::GetTopicNodeId ( ) const

pure virtual

Retrieves the topic node id where the cross-reference will be inserted.

Returns

the topic node id.

virtual const UID ICreateIndexXRefEntryCmdData::GetTopicSectionUID ( ) const

pure virtual

Retrieves the topic section where the cross-reference will be inserted.

Returns

UID of the topic section.

virtual void ICreateIndexXRefEntryCmdData::SetAllowRecursiveXRef ( bool16  allow )

pure virtual

Sets the "allow recursive cross-reference" flag. This flag is default set to kFalse. If a topic AAA references another topic BBB (see "BBB") and BBB references AAA (see "AAA") it is called a recursive cross-reference.

Parameters

allow

[IN] - value of the flag.

virtual void ICreateIndexXRefEntryCmdData::SetDoNotifyFlag ( bool16  notify )

pure virtual

Sets the "notify" flag. This flag is default set to kTrue.

Parameters

notify

[IN] - value of the flag.

virtual void ICreateIndexXRefEntryCmdData::SetTopicEntry ( const IndexTopicEntry &  topicEntry )

pure virtual

Sets the topic entry where the cross-reference will be inserted. The clients of the command should either call this method or SetTopicSectionUID() AND SetTopicNodeId().

Parameters

topicEntry

[IN] - the topic entry.

virtual void ICreateIndexXRefEntryCmdData::SetTopicListUIDRef ( const UIDRef &  topicListUID )

pure virtual

Sets the topic list property.

Parameters

topicListUIDRef

[IN] - UIDRef of the topic list.

virtual void ICreateIndexXRefEntryCmdData::SetTopicNodeId ( int32  indexTopicNodeId )

pure virtual

Sets the topic node id where the cross-reference will be inserted.

Parameters

indexTopicNodeId

virtual void ICreateIndexXRefEntryCmdData::SetTopicSectionUID ( const UID  topicSectionUID )

pure virtual

Sets the topic section where the cross-reference will be inserted.

Parameters

topicSectionUID

[IN] - the UID of the topic section.