IHyperlinkSuite Class Reference

#include <IHyperlinkSuite.h>

Inheritance diagram for IHyperlinkSuite:

Public Member Functions
virtual bool16	CanCreateHyperlinkSource () const =0
virtual bool16	CanCreateXRefSource () const =0
virtual bool16	CanCreateHyperlinkDestination () const =0
virtual bool16	CanChangeHyperlinkSource (UIDRef source) const =0
virtual bool16	CanChangeHyperlinkDestination (UIDRef dest) const =0
virtual bool16	CanCreateBookmark () const =0
virtual UID	GetHyperlinkSource () const =0
virtual UID	CreateHyperlinkSource (const PMString *name, UID charStyle=kInvalidUID) const =0
virtual UID	CreateXRefSource (const PMString *name, UID format=kInvalidUID) const =0
virtual UID	CreateHyperlinkDestination (const PMString *sourceName) const =0
virtual UID	CreateBookmark (int32 indentLevel, UID parentBookmark) const =0
virtual UID	ChangeHyperlinkSource (UIDRef source, const PMString *name) const =0
virtual UID	ChangeHyperlinkDestination (UIDRef dest, const PMString *sourceName) const =0
virtual void	GenerateHyperlinkSourceName (PMString *sourceName, bool16 bUnique=kTrue) const =0
virtual void	GenerateHyperlinkDestinationName (PMString *destName, bool16 bUnique=kTrue, int32 maxLength=100) const =0
virtual UIDList	GetSelectedHyperlinkSources () 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

Defines the interface for a hyperlink-related suite to be used in the new selection architecture

Member Function Documentation

virtual bool16 IHyperlinkSuite::CanChangeHyperlinkDestination ( UIDRef  dest ) const

pure virtual

Can any of the CSBs change a hyperlink destination from the selection?

Parameters

dest	- UIDRef of the dest client wants to change

Returns

bool16 - kTrue == Yes/kFalse == No

virtual bool16 IHyperlinkSuite::CanChangeHyperlinkSource ( UIDRef  source ) const

pure virtual

Can any of the CSBs create a hyperlink source from the selection?

Parameters

source

- UIDRef of the source we want to change

Returns

bool16 - kTrue == Yes/kFalse == No

virtual bool16 IHyperlinkSuite::CanCreateBookmark ( ) const

pure virtual

Can any of the CSBs create a bookmark from the selection?

Parameters

none

Returns

bool16 - kTrue == Yes/kFalse == No

virtual bool16 IHyperlinkSuite::CanCreateHyperlinkDestination ( ) const

pure virtual

Can any of the CSBs create a hyperlink destination from the selection?

Parameters

none

Returns

bool16 - kTrue == Yes/kFalse == No

virtual bool16 IHyperlinkSuite::CanCreateHyperlinkSource ( ) const

pure virtual

Can any of the CSBs create a hyperlink source from the selection?

Parameters

none

Returns

bool16 - kTrue == Yes/kFalse == No

virtual bool16 IHyperlinkSuite::CanCreateXRefSource ( ) const

pure virtual

Can any of the CSBs create an XRef source from the selection?

Parameters

none

Returns

bool16 - kTrue == Yes/kFalse == No

virtual UID IHyperlinkSuite::ChangeHyperlinkDestination ( UIDRef  dest, const PMString *  sourceName  ) const

pure virtual

Modify a hyperlink destination from the selection

Parameters

dest	- Dest client wants to modify
*sourceName	- Default name

Returns

UID - New UID (kInvalidUID if method fails)

virtual UID IHyperlinkSuite::ChangeHyperlinkSource ( UIDRef  source, const PMString *  name  ) const

pure virtual

Modify a hyperlink source from the selection

Parameters

source	- UIDRef of the source to change
*name	- Name to use

Returns

UID - New UID (kInvalidUID if method fails)

virtual UID IHyperlinkSuite::CreateBookmark ( int32  indentLevel, UID  parentBookmark  ) const

pure virtual

Create a bookmark from the selection

Parameters

indentLevel	- Level to indent at
parentBookmark	- What should be the new bookmarks parent (DocUID will put it at the root level)

Returns

UID - New UID (kInvalidUID if method fails)

virtual UID IHyperlinkSuite::CreateHyperlinkDestination ( const PMString *  sourceName ) const

pure virtual

Create a hyperlink source from the selection

Parameters

*sourceName

- Default name to use

Returns

UID - New UID (kInvalidUID if method fails

virtual UID IHyperlinkSuite::CreateHyperlinkSource ( const PMString *  name, UID  charStyle = kInvalidUID  ) const

pure virtual

Create a hyperlink source from the selection

Parameters

*name	- Default name to use
charStyle	- Character Style for the source.

Returns

UID - New UID (kInvalidUID if method fails

virtual UID IHyperlinkSuite::CreateXRefSource ( const PMString *  name, UID  format = kInvalidUID  ) const

pure virtual

Create a xref source from the selection

Parameters

*name	- Default name to use
format	- UID of the cross reference format to use. kInvalidUID uses the default format.

Returns

UID - New UID (kInvalidUID if method fails

virtual void IHyperlinkSuite::GenerateHyperlinkDestinationName ( PMString *  destName, bool16  bUnique = kTrue, int32  maxLength = 100  ) const

pure virtual

Generate a new name for a hyperlink destination

Parameters

*destName	- Default name to use
bUnique	- Should the name be unique?

virtual void IHyperlinkSuite::GenerateHyperlinkSourceName ( PMString *  sourceName, bool16  bUnique = kTrue  ) const

pure virtual

Generate a new name for a hyperlink source

Parameters

*sourceName	- Default name to use
bUnique	- Should the name be unique?

virtual UID IHyperlinkSuite::GetHyperlinkSource ( ) const

pure virtual

If the selection is a hyperlink source

Parameters

none

Returns

UID - New UID (kInvalidUID if method fails

virtual UIDList IHyperlinkSuite::GetSelectedHyperlinkSources ( ) const

pure virtual

Return a list of UIDs to hyperlinks that are selected

Parameters

none

Returns

UIDList - List of selected hyperlinks