IHelpHyperlinkEvent

Events of class IHelpHyperlinkEvent are dispatched when the user refers to a heading that contains an inform link. This informs the application that the heading is accessed.

You specify an inform link using the reftype=inform attribute on the Information Presentation Facility (IPF) :link tag. For example, the following link informs the application when the heading that contains it is referred to:

   :h1 res=123.Title:elink.
   :link auto reftype=inform res=1000.

The resource value (res=1000) identifies the link to the application and directs some application-specific function.

Do not confuse this link type with common hypertext links such as the following:

   :link reftype=hd res=123.Title:elink.


IHelpHyperlinkEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


[view class]
~IHelpHyperlinkEvent
public:
virtual ~IHelpHyperlinkEvent()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IHelpHyperlinkEvent
public:
IHelpHyperlinkEvent(const IEvent& event)

Constructs an IHelpHyperlinkEvent using the specified event. IHelpHandler::dispatchHandlerEvent constructs objects of this class from an object of the class IEvent and passes the resulting objects to the function IHelpHandler::hyperlinkSelect.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Link Information

An IHelpHyperlinkEvent object contains information that identifies the inform link selected by the user.


[view class]
id
public:
unsigned long id() const

Returns the resource ID of the inform link. Your application uses this identifier to determine application-specific processing for the link.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IHelpHyperlinkEvent - Inherited Member Functions and Data

Inherited Public Functions

IEvent

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data