IIndexTopicListList Class Reference

#include <IIndexTopicListList.h>

Inheritance diagram for IIndexTopicListList:

Public Types
enum	{ kDefaultIID = IID_IINDEXTOPICLISTLIST }

Public Member Functions
virtual const int32	GetNumTopicLists () const =0
virtual const UID	GetDefaultTopicListUID () const =0
virtual void	SetDefaultTopicListUID (UID uid)=0
virtual void	AddTopicList (UID indexUID)=0
virtual void	RemoveTopicList (UID indexUID)=0
virtual const UID	GetNthTopicList (int32 id) 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 keeps track of index topic lists on the session/document workspace. Currently there is only one topic list. This interface was added in case we want to support multiple topic lists.

See Also

IIndexTopicList

Member Function Documentation

virtual void IIndexTopicListList::AddTopicList ( UID  indexUID )

pure virtual

Adds a topic list to the list.

Parameters

indexUID

[IN] - the UID of the topic list to be added to the list.

virtual const UID IIndexTopicListList::GetDefaultTopicListUID ( ) const

pure virtual

Gets the default topic list. In the initial design this was intented to manage multiple topic lists. Since we have only one topic list now, this will always return the first topic list.

Returns

the UID of the default topic list.

virtual const UID IIndexTopicListList::GetNthTopicList ( int32  id ) const

pure virtual

Retrieves the UID of the topic list at the specified index.

Parameters

id	[IN] - index of the desired topic list.

Returns

the UID of the specified topic list.

virtual const int32 IIndexTopicListList::GetNumTopicLists ( ) const

pure virtual

Retrieves the number of topic lists.

Returns

number of topic lists.

virtual void IIndexTopicListList::RemoveTopicList ( UID  indexUID )

pure virtual

Removes a topic list from the list.

Parameters

indexUID

[IN] - the UID of the topic list to be removed.

virtual void IIndexTopicListList::SetDefaultTopicListUID ( UID  uid )

pure virtual

Sets the default topic list. In the initial design this was intented to manage multiple topic lists. Since we currently support only one topic list this method is not used.

Parameters

uid	[IN] - the UID of the default topic list.