IHelpNotifyEvent

The IHelpNotifyEvent class events are dispatched when the user initiates a help-related action that your associated application window can control. Your application can then change the behavior or appearance of the appropriate help window.

An IHelpNotifyEvent represents one of the following actions:

The IHelpNotifyEvent object identifies the event type and the associated help window or selected control.


IHelpNotifyEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

Constructs an IHelpNotifyEvent using the specified event. IHelpHandler::dispatchHandlerEvent constructs objects of this class from an object of the class IEvent.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Help Window

An IHelpNotifyEvent object contains information that identifies a help window associated with a particular help-related notification.


[view class]
windowHandle
public:
IWindowHandle windowHandle() const

Returns the window handle of either the help window being shown or swapped or the help window containing the control that the user selected.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Selected Control

An IHelpNotifyEvent object can identify a control when it is added to a help window by the application and selected by the user.


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

Returns the window identifier of the help control that the user selected. For example, this might be the window identifier of a push button you added to a help window. If the event does not represent the selection of a control, this function returns 0.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IHelpNotifyEvent - Inherited Member Functions and Data

Inherited Public Functions

IEvent

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data