IDeleteIndexPageEntryCmdData Class Reference

#include <IDeleteIndexPageEntryCmdData.h>

Inheritance diagram for IDeleteIndexPageEntryCmdData:

Public Types
enum	{ kDefaultIID = IID_IDELETEINDEXPAGEENTRYCMDDATA }

Public Member Functions
virtual bool16	GetDeleteMarkerFlag () const =0
virtual void	SetDeleteMarkerFlag (bool16 deleteMarker)=0
virtual bool16	GetDoNotifyFlag () const =0
virtual void	SetDoNotifyFlag (bool16 notify)=0
virtual const UIDRef &	GetTopicListUIDRef () const =0
virtual void	SetTopicListUIDRef (const UIDRef &topicListUID)=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
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 deleting an index page entry.

Member Function Documentation

virtual bool16 IDeleteIndexPageEntryCmdData::GetDeleteMarkerFlag ( ) const

pure virtual

Retrieves the "delete marker" flag value.

Returns

the flag's value.

virtual bool16 IDeleteIndexPageEntryCmdData::GetDoNotifyFlag ( ) const

pure virtual

Retrieves the "notify" flag.

Returns

the value of the flag.

virtual const UIDRef& IDeleteIndexPageEntryCmdData::GetTopicListUIDRef ( ) const

pure virtual

Retrieves the topic list property.

Returns

UIDRef of the topic list.

virtual int32 IDeleteIndexPageEntryCmdData::GetTopicNodeId ( ) const

pure virtual

Retrieves the topic node id. (Only used by Indexing and Indexing Panel).

Returns

the topic node id.

virtual const UID IDeleteIndexPageEntryCmdData::GetTopicSectionUID ( ) const

pure virtual

Retrieves the topic section UID property. (Only used by Indexing and Indexing Panel).

Returns

UID of the topic section.

virtual void IDeleteIndexPageEntryCmdData::SetDeleteMarkerFlag ( bool16  deleteMarker )

pure virtual

Sets the "delete marker" flag for the command. If set to kTrue it will delete the index marker from the story.

Parameters

deleteMarker

[IN] - the flag's value.

virtual void IDeleteIndexPageEntryCmdData::SetDoNotifyFlag ( bool16  notify )

pure virtual

Sets the "notify" flag.

Parameters

notify

[IN] - value of the flag.

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

pure virtual

Sets the topic list property. No need to SetTopicListUIDRef outside of Indexing plugin.

Parameters

topicListUID

[IN] - UIDRef of the topic list.

virtual void IDeleteIndexPageEntryCmdData::SetTopicNodeId ( int32  indexTopicNodeId )

pure virtual

Sets the topic node id. (Only used by Indexing and Indexing Panel).

Parameters

indexTopicNodeId

[IN] - the topic node id.

virtual void IDeleteIndexPageEntryCmdData::SetTopicSectionUID ( const UID  topicSectionUID )

pure virtual

Sets the topic section UID property. (Only used by Indexing and Indexing Panel).

Parameters

topicSectionUID

[IN] - UID of the topic section.