Facade::IHyperlinkUIFacade Class Reference

#include <IHyperlinkUIFacade.h>

Inheritance diagram for Facade::IHyperlinkUIFacade:

Public Types
enum	{ kDefaultIID = IID_IHYPERLINKUIFACADE }

Public Member Functions
virtual ErrorCode	MoveHyperlinks (UIDList hyperlinks, UIDRef before)=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

A high level API for dealing with hyprelink UI actions. To use this Facade, include this header file and use the following example syntax: result = Utils<Facade::IHyperlinkUIFacade>()->MoveHyperlink( ... );

Author

Jianlan Song

Member Function Documentation

virtual ErrorCode Facade::IHyperlinkUIFacade::MoveHyperlinks ( UIDList  hyperlinks, UIDRef  before  )

pure virtual

Moves list of hyperlinks before a specified hyperlink. After the move, the list of hyperlinks will be right before the specified hyperlink in the order specified in the list.

Parameters

hyperlinks	- Hyperlinks to be moved.
before	- The hyperlink which the above hyperlinks will be moved in front of. if kInvalidUIDRef is passed, the specified hyperlink list will be moved to the end of the hyperlink list.

Returns

ErrorCode - result of the operation.