#include <ILinkSourceAltDestination.h>

Inheritance diagram for ILinkSourceAltDestination:

Public Types
enum	{ kDefaultIID = IID_ILINKSOURCEALTDESTINATION }

enum	AltDestType { kNone = 0, kIndexMarker, kTOCTextAnchor }

Public Member Functions
virtual AltDestType	GetDestType () const =0

virtual void	SetDestType (AltDestType type)=0

virtual uint32	GetIndexMarkerID () const =0

virtual void	SetIndexMarkerID (uint32 id)=0

virtual PMString	GetTextAnchorName () const =0

virtual void	SetTextAnchorName (const PMString &name)=0

virtual WideString	GetTOCPageNumberString () const =0

virtual void	SetTOCPageNumberString (const WideString &pageNumberStr)=0

virtual int32	GetTOCEntryLevel () const =0

virtual void	SetTOCEntryLevel (int32 level)=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 interface adds extra information to hyperlink. It is mainly used to provide extra information to page destination. Currently used by HTML export since there is no page concept in HTML.

Member Function Documentation

virtual AltDestType ILinkSourceAltDestination::GetDestType ( ) const

pure virtual

Get this destination type

virtual uint32 ILinkSourceAltDestination::GetIndexMarkerID ( ) const

pure virtual

Get unique id of index marker. Id is unqiue within document.

Returns: uint32 index marker id

virtual PMString ILinkSourceAltDestination::GetTextAnchorName ( ) const

pure virtual

Get TOC text anchor name.

Returns: PMString text anchor name

virtual int32 ILinkSourceAltDestination::GetTOCEntryLevel ( ) const

pure virtual

Get TOC entry level.

Returns: int32 TOC entry level.

virtual WideString ILinkSourceAltDestination::GetTOCPageNumberString ( ) const

pure virtual

Get TOC page number string.

Returns: PMString TOC page number string

virtual void ILinkSourceAltDestination::SetDestType ( AltDestType type )

pure virtual

Set destination type

virtual void ILinkSourceAltDestination::SetIndexMarkerID ( uint32 id )

pure virtual

SetGet unique id of index marker.

Parameters

id	index marker id

virtual void ILinkSourceAltDestination::SetTextAnchorName ( const PMString & name )

pure virtual

Set TOC text anchor name.

Parameters

name	TOC text anchor name

virtual void ILinkSourceAltDestination::SetTOCEntryLevel ( int32 level )

pure virtual

Set TOC entry level.

Parameters

level TOC entry level

virtual void ILinkSourceAltDestination::SetTOCPageNumberString ( const WideString & pageNumberStr )

pure virtual

Set TOC page number string.

Parameters

pageNumberStr TOC page number string

Public Types

Public Member Functions

Detailed Description

Member Function Documentation