ICreateTopicListCmdData Class Reference

#include <ICreateTopicListCmdData.h>

Inheritance diagram for ICreateTopicListCmdData:

Public Types
enum	{ kDefaultIID = IID_ICREATETOPICLISTCMDDATA }

Public Member Functions
virtual const UIDRef &	GetTargetItem () const =0
virtual void	SetTargetItem (const UIDRef &targetItem)=0
virtual bool16	GetUseTopicListListFlag () const =0
virtual void	SetUseTopicListListFlag (bool16 useIt)=0
virtual bool16	GetDoNotifyFlag () const =0
virtual void	SetDoNotifyFlag (bool16 notify)=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 a topic list.

Member Function Documentation

virtual bool16 ICreateTopicListCmdData::GetDoNotifyFlag ( ) const

pure virtual

Retrieves the "notify" flag.

Returns

the value of the flag.

virtual const UIDRef& ICreateTopicListCmdData::GetTargetItem ( ) const

pure virtual

Retrieves the target item for the command. The target is the document workspace that will own the topic list.

Returns

the UID of the target

virtual bool16 ICreateTopicListCmdData::GetUseTopicListListFlag ( ) const

pure virtual

Retrieves the flag that specifies if the command should use the topiclist list.

Returns

the flag's value.

virtual void ICreateTopicListCmdData::SetDoNotifyFlag ( bool16  notify )

pure virtual

Sets the "notify" flag.

Parameters

notify

[IN] - value of the flag.

virtual void ICreateTopicListCmdData::SetTargetItem ( const UIDRef &  targetItem )

pure virtual

Sets the target item for the command. The target is the document workspace that will own the topic list.

Parameters

targetItem

[IN] - UIDRef of the target item.

virtual void ICreateTopicListCmdData::SetUseTopicListListFlag ( bool16  useIt )

pure virtual

Sets the flag that specifies if the command should use the topiclist list. Currently this flag is always set to kFalse (we don't use topiclist lists).

Parameters

useIt

[IN] - the value of the flag.