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.
You can construct and destruct objects of this class.
![]() |
public:
virtual ~ICnrHelpEvent()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
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.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to query and set the accessible attributes of this class.
![]() |
public:
IContainerColumn* column() const
If help was requested within a multiline edit field, the column being edited is returned. Otherwise, 0 is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IContainerObject* object() const
Returns the object over which help is requested. Otherwise, it returns 0.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
virtual ~ICnrEvent()
ICnrEvent(const IControlEvent& event)
virtual ~IControlEvent()
virtual unsigned long controlId() const
IControlEvent(const IEvent& event)
IControlEvent(const IControlEvent& event)
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
unsigned long containerId() const