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.
You can construct and destruct objects of this class.
![]() |
public:
virtual ~IHelpHyperlinkEvent()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
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.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
An IHelpHyperlinkEvent object contains information that identifies the inform link selected by the user.
![]() |
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.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
virtual ~IEvent()
IWindowHandle controlHandle() const
virtual IWindow* controlWindow() const
IEvent& decrementOwnerLevels()
virtual IWindow* dispatchingWindow() const
unsigned long eventId() const
IWindowHandle handle() const
IEvent( IWindow* window, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent( const IWindowHandle& handle, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent(const IEvent& event)
IEvent& operator =(const IEvent& event)
IEventParameter1 parameter1() const
IEventParameter2 parameter2() const
bool passToOwner() const
IEventResult result() const
IEvent& setControlHandle(const IWindowHandle& handle)
IEvent& setDispatchingHandle(const IWindowHandle& handle)
IEvent& setDispatchingWindow(IWindow* window)
IEvent& setHandle(const IWindowHandle& handle)
IEvent& setNumberOfLevels(int levels = - 1)
IEvent& setPassToOwner(bool passOn = true)
IEvent& setResult(bool eventResult)
IEvent& setResult(const IEventResult& eventResult)
virtual IWindow* window() const