IHyperlinkTextDestinationState Class Reference

Inheritance diagram for IHyperlinkTextDestinationState:

Public Types
enum	{ kDefaultIID = IID_IHYPERLINKTEXTDESTINATIONSTATE }

Public Member Functions
virtual ParcelKey	GetParcelKey () const =0
virtual void	SetParcelKey (ParcelKey key)=0
virtual uint32	GetChangeCount () const =0
virtual void	IncrementChangeCount ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual uint32 IHyperlinkTextDestinationState::GetChangeCount ( ) const

pure virtual

The Change Count provides a simple mechanism to communicate changes in the ParcelKey.

Returns

int32 value incremented whenver the ParcelKey changes.

virtual ParcelKey IHyperlinkTextDestinationState::GetParcelKey ( ) const

pure virtual

Returns the ParcelKey where the Destination was last composed. Will return and invalid ParcelKey if the Destination was composed into overset.

Returns

ParcelKey

virtual void IHyperlinkTextDestinationState::IncrementChangeCount ( )

pure virtual

Increments the Change Count.

virtual void IHyperlinkTextDestinationState::SetParcelKey ( ParcelKey  key )

pure virtual

Sets the ParcelKey where the Destination was last composed. Setting this to a different value than is currently stored will automatically bump the ChangeCount below.

Parameters

key	ParcelKey of the WaxLine containing the Destination.