### ICnrHelpEvent

  The ICnrHelpEvent class retrieves information about a container help event. Objects of the ICnrHelpEvent class are dispatched when a user requests help in the container.

### ICnrHelpEvent - Member Functions and Data by Group

### Constructors & Destructor

You can construct and destruct objects of this class.

~ICnrHelpEvent

      public:
      virtual ~ICnrHelpEvent()

Supported Platforms

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

ICnrHelpEvent

      public:
      ICnrHelpEvent(const IControlEvent& event)

  Although you can construct objects of this class, typically ICnrHandler::dispatchHandlerEvent creates objects of this class from an object of the class IControlEvent in response to a notification from the container that the user has requested help.

Supported Platforms

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

### Event Information

Use these members to query and set the accessible attributes of this class.

column

      public:
      IContainerColumn* column() const

  If help was requested within a multiline edit field, the column being edited is returned. Otherwise, 0 is returned.

Supported Platforms

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

object

      public:
      IContainerObject* object() const

  Returns the object over which help is requested. Otherwise, it returns 0.

Supported Platforms

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

### ICnrHelpEvent - Inherited Member Functions and Data

#### Inherited Public Functions

  ICnrEvent

  -     virtual ~ICnrEvent()

  -     ICnrEvent(const IControlEvent& event)

  IControlEvent

  -     virtual ~IControlEvent()

  -     virtual unsigned long controlId() const

  -     IControlEvent(const IEvent& event)

  -     IControlEvent(const IControlEvent& event)

  IEvent

  -     virtual ~IEvent()

  -     IWindowHandle controlHandle() const

  -     virtual IWindow* controlWindow() const

  -     IEvent& decrementOwnerLevels()

  -     virtual IWindow* dispatchingWindow() const

  -     unsigned long eventId() const

  -     IWindowHandle handle() const

  -     IEvent(const IEvent& event)

  -     IEvent( const IWindowHandle& handle,
                unsigned long eventId,
                const IEventParameter1& parameter1,
                const IEventParameter2& parameter2 )

  -     IEvent( IWindow* window,
                unsigned long eventId,
                const IEventParameter1& parameter1,
                const IEventParameter2& parameter2 )

  -     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

#### Inherited Public Data

  - None

#### Inherited Protected Functions

  ICnrEvent

  -     unsigned long containerId() const

#### Inherited Protected Data

  - None