INewHyperlinkTextDestCmdData Class Reference

#include <INewHyperlinkTextDestCmdData.h>

Inheritance diagram for INewHyperlinkTextDestCmdData:

Public Types
enum	{ kDefaultIID = IID_INEWHYPERLINKTEXTDESTCMDDATA }

Public Member Functions
virtual bool16	GetShouldUseExistingCharacter () const =0
virtual void	SetShouldUseExistingCharacter (const bool16 shouldUse)=0
virtual bool16	IsParagraphDestination () const =0
virtual void	SetIsParagraphDestination (bool16 isParagraph)=0
virtual bool16	NewDestCreated () const =0
virtual void	SetNewDestCreated (bool16 created)=0
virtual int32	GetUniqueKey () const =0
virtual void	SetUniqueKey (int32 uniqueKey)=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, set/get the text destination data for the command kNewHyperlinkTextDestCmdBoss

Member Function Documentation

virtual bool16 INewHyperlinkTextDestCmdData::GetShouldUseExistingCharacter ( ) const

pure virtual

Get method to get whether or not to add the text destination marker character to the model or use the existing character

Parameters

none

Returns

bool16 kTrue = the create command should use the existing character (caller guarantees it is a valid character)

virtual int32 INewHyperlinkTextDestCmdData::GetUniqueKey ( ) const

pure virtual

Get destination unique key

Returns

int32 unique key

virtual bool16 INewHyperlinkTextDestCmdData::IsParagraphDestination ( ) const

pure virtual

Get whether or not the text destination is a paragraph destination

Returns

bool16 kTrue = paragraph destination

virtual bool16 INewHyperlinkTextDestCmdData::NewDestCreated ( ) const

pure virtual

Get whether or not a new destination is created by the command

Returns

bool16 kTrue = new destination created

virtual void INewHyperlinkTextDestCmdData::SetIsParagraphDestination ( bool16  isParagraph )

pure virtual

Set whether or not the text destination is a paragraph destination

Parameters

isParagraph

- kTrue if the destination is a paragraph destination.

virtual void INewHyperlinkTextDestCmdData::SetNewDestCreated ( bool16  created )

pure virtual

Set whether or not a new destination is created.

Parameters

created

- kTrue if a new destination is created.

virtual void INewHyperlinkTextDestCmdData::SetShouldUseExistingCharacter ( const bool16  shouldUse )

pure virtual

Set method to set whether or not to add the text destination marker character to the model or use the existing character. The caller who sets this to kTrue guarantees that the correct character is in the text model at the location where the text destination marker should exist.

Parameters

shouldUse

virtual void INewHyperlinkTextDestCmdData::SetUniqueKey ( int32  uniqueKey )

pure virtual

Set unique key value

Parameters

uniqueKey

unique key