### 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:

  - Showing the help cover page window
  - Showing a page within the cover page window
  - Swapping of a page
  - Showing the help Contents window
  - Showing the Viewed Pages window
  - Showing the help Index window
  - Showing the search list window
  - Showing the help Libraries window
  - Selecting of a control added by an application on a help window

  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.

~IHelpNotifyEvent

      public:
      virtual ~IHelpNotifyEvent()

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

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.

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.

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

  -     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(const IEventResult& eventResult)

  -     IEvent& setResult(bool eventResult)

  -     virtual IWindow* window() const

#### Inherited Public Data

  - None

#### Inherited Protected Functions

  - None

#### Inherited Protected Data

  - None