IEditTopicEntryCmdData Class Reference

#include <IEditTopicEntryCmdData.h>

Inheritance diagram for IEditTopicEntryCmdData:

Public Types
enum	{ kDefaultIID = IID_IEDITTOPICENTRYCMDDATA }

Public Member Functions
virtual const UIDRef &	GetTopicListUIDRef () const =0
virtual void	SetTopicListUIDRef (const UIDRef &topicListUIDRef)=0
virtual const IndexTopicEntry &	GetFromTopicEntry () const =0
virtual void	SetFromTopicEntry (const IndexTopicEntry &fromTopicEntry)=0
virtual const IndexTopicEntry &	GetToTopicEntry () const =0
virtual void	SetToTopicEntry (const IndexTopicEntry &toTopicEntry)=0
virtual const UIDRef &	GetEditedPRef () const =0
virtual void	SetEditedPRef (const UIDRef &editedPRef)=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 editing a topic entry.

Member Function Documentation

virtual const UIDRef& IEditTopicEntryCmdData::GetEditedPRef ( ) const

pure virtual

Retrieves the UIDRef of the altered page reference during edit (if any).

Returns

UIDRef of the attached page reference (if any).

virtual const IndexTopicEntry& IEditTopicEntryCmdData::GetFromTopicEntry ( ) const

pure virtual

Retrieves the initial topic property.

Returns

the initial topic.

virtual const UIDRef& IEditTopicEntryCmdData::GetTopicListUIDRef ( ) const

pure virtual

Retrieves the topic list property.

Returns

UIDRef of the topic list.

virtual const IndexTopicEntry& IEditTopicEntryCmdData::GetToTopicEntry ( ) const

pure virtual

Retrieves the final topic property.

Returns

the final topic.

virtual void IEditTopicEntryCmdData::SetEditedPRef ( const UIDRef &  editedPRef )

pure virtual

Sets the UIDRef of the altered page reference during edit (if any). Called by the command to signal callers that the page reference associated with the topic changed.

Parameters

editedPRef

[IN] - UIDRef of the page reference.

virtual void IEditTopicEntryCmdData::SetFromTopicEntry ( const IndexTopicEntry &  fromTopicEntry )

pure virtual

Sets the initial topic property.

Parameters

fromTopicEntry

[IN] - the initial topic property.

virtual void IEditTopicEntryCmdData::SetTopicListUIDRef ( const UIDRef &  topicListUIDRef )

pure virtual

Sets the topic list property.

Parameters

topicListUIDRef

[IN] - UIDRef of the topic list.

virtual void IEditTopicEntryCmdData::SetToTopicEntry ( const IndexTopicEntry &  toTopicEntry )

pure virtual

Sets the final topic property.

Parameters

toTopicEntry

[IN] - the final topic entry.