Inheritance diagram for IHyperlinkTextSourceCmdData:

Public Types
enum	{ kDefaultIID = IID_IHYPERLINKTEXTSOURCECMDDATA }

Public Member Functions
virtual void	Set (const PMString &name, const UIDRef &storyUIDRef, TextIndex start, TextIndex end, bool16 isVisible, const UIDRef &bookmarkUIDRef, bool16 isXref=kFalse, UID xRefFormat=kInvalidUID)=0

virtual PMString	GetName () const =0

virtual void	SetName (const PMString &name)=0

virtual bool16	ChangingName () const =0

virtual UIDRef	GetStoryUIDRef () const =0

virtual void	SetStoryUIDRef (const UIDRef &storyUIDRef)=0

virtual bool16	ChangingTextModel () const =0

virtual TextIndex	GetStartIndex () const =0

virtual int32	GetRangeLength () const =0

virtual void	SetRangeData (TextIndex start, TextIndex end)=0

virtual bool16	ChangingRangeData () const =0

virtual UID	GetCharStyle () const =0

virtual void	SetCharStyle (UID charStyle)=0

virtual bool16	ChangingCharStyle () const =0

virtual bool16	IsVisible () const =0

virtual void	SetIsVisible (bool16 isVisible)=0

virtual bool16	ChangingVisibility () const =0

virtual UIDRef	GetBookmarkData () const =0

virtual void	SetBookmarkData (const UIDRef &bookmarkUIDRef)=0

virtual bool16	ChangingBookmarkData () const =0

virtual void	SetIsXRef (bool16 isXRef)=0

virtual bool16	IsXRef () const =0

virtual void	SetXRefFormat (UID xRefFormat)=0

virtual UID	GetXRefFormat () const =0

virtual bool16	ChangingXRefInfo () 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

This class stores information needed for text source commands. (used in conjunction with the NewHyperlinkTextSourceCmd.)

Member Function Documentation

virtual UIDRef IHyperlinkTextSourceCmdData::GetBookmarkData ( ) const

pure virtual

Get the book mark data

virtual UID IHyperlinkTextSourceCmdData::GetCharStyle ( ) const

pure virtual

Get the character style for the hyperlink source

virtual PMString IHyperlinkTextSourceCmdData::GetName ( ) const

pure virtual

Get the name of the source

virtual int32 IHyperlinkTextSourceCmdData::GetRangeLength ( ) const

pure virtual

Get the length of the range to create source at

virtual TextIndex IHyperlinkTextSourceCmdData::GetStartIndex ( ) const

pure virtual

Get the start index of the range to create source at

virtual UIDRef IHyperlinkTextSourceCmdData::GetStoryUIDRef ( ) const

pure virtual

Get the text model UIDRef

virtual bool16 IHyperlinkTextSourceCmdData::IsVisible ( ) const

pure virtual

Return kTrue if the source is visible in UI.

virtual void IHyperlinkTextSourceCmdData::Set	(	const PMString &	name,
		const UIDRef &	storyUIDRef,
		TextIndex	start,
		TextIndex	end,
		bool16	isVisible,
		const UIDRef &	bookmarkUIDRef,
		bool16	isXref = `kFalse`,
		UID	xRefFormat = `kInvalidUID`
	)

pure virtual

Use this method to setup of the data

Parameters

name	- the name of the new text source
storyUIDRef	- text model UIDRef
start	- The start text index to create source at.
end	- The end text index for the source. The end index is really 1 past the last character in the range.
isVisible	- kFalse = not visible in the UI; kTrue = visible in the UI.
bookmarkUID	- linked bookmark data.
isXref	- kTrue if it is a cross reference text source.
xRefFormat	- UID of the format used by the cross reference.