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.


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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
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.


[view 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


[view class]
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
IControlEvent
IEvent

Inherited Public Data

Inherited Protected Functions

ICnrEvent

Inherited Protected Data