IIndexEntryData Class Reference

#include <IIndexEntryData.h>

Inheritance diagram for IIndexEntryData:

Public Types
enum	{ kDefaultIID = IID_IINDEXENTRYDATA }
enum	IndexEntryType { kNoEntryType, kPageRefType, kXRefType }

Public Member Functions
virtual const IndexEntryType	GetEntryType () const =0
virtual void	SetEntryType (const IndexEntryType entryType)=0
virtual const UID	GetTopicSectionUID () const =0
virtual void	SetTopicSectionUID (const UID topicSectionUID)=0
virtual void	GetTopicEntry (IndexTopicEntry &topicEntry, UID *sectionUID=nil, int32 *nodeId=nil) const =0
virtual void	GetTopicListUIDRef (UIDRef &topicListUIDRef) const =0
virtual const UID	GetBookContentUID () const =0
virtual void	SetBookContentUID (const UID &bookContentUID)=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 an index entry.

Member Enumeration Documentation

enum IIndexEntryData::IndexEntryType

Specifies the type of the index entry

Member Function Documentation

virtual const UID IIndexEntryData::GetBookContentUID ( ) const

pure virtual

Retrieves the book content UID referenced by this index entry.

Returns

UID of the book content.

virtual const IndexEntryType IIndexEntryData::GetEntryType ( ) const

pure virtual

Retrieves the type of the index entry.

See Also

IndexEntryType.

Returns

the entry type.

virtual void IIndexEntryData::GetTopicEntry ( IndexTopicEntry &  topicEntry, UID *  sectionUID = nil, int32 *  nodeId = nil  ) const

pure virtual

Retrieves the topic entry referenced by this index entry.

Parameters

topicEntry	[OUT] - the topic entry associated with this index entry.
sectionUID	[OUT] - optional, UID of the topic section.
nodeId	[OUT] - optional, the topic node id.

virtual void IIndexEntryData::GetTopicListUIDRef ( UIDRef &  topicListUIDRef ) const

pure virtual

Retrieves the UIDRef of the topic list that contains the topic referenced by this index entry.

Parameters

topicListUIDRef

[OUT] - UIDRef of the topic list.

virtual const UID IIndexEntryData::GetTopicSectionUID ( ) const

pure virtual

Retrieves the section UID of the topic entry referenced by this index entry.

Returns

UID of the topic section.

virtual void IIndexEntryData::SetBookContentUID ( const UID &  bookContentUID )

pure virtual

Sets the book content UID referenced by this index entry.

Parameters

bookContentUID

[IN] - the book content UID associated with this index entry.

virtual void IIndexEntryData::SetEntryType ( const IndexEntryType  entryType )

pure virtual

Sets the type of an index entry.

Parameters

entryType

[IN] - the type of the entry.

virtual void IIndexEntryData::SetTopicSectionUID ( const UID  topicSectionUID )

pure virtual

Sets the topic section UID for this index entry.

Parameters

topicSectionUID

[IN] - the section UID for this index entry.