IHelpSubitemNotFoundEvent

Events of class IHelpSubitemNotFoundEvent are dispatched when the user requests help on a control for which Information Presentation Facility (IPF) cannot find an entry in the help subtable (and thus, a control for which IPF cannot display a contextual help panel).


IHelpSubitemNotFoundEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

Constructs an IHelpSubitemNotFoundEvent using the specified event. IHelpHandler::dispatchHandlerEvent constructs objects of this class from an object of the class IEvent and passes the resulting objects to the function IHelpHandler::subitemNotFound.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Help Item

An IHelpSubitemNotFoundEvent object contains information that identifies the window for which the user requested help.


[view class]
isFrame
public:
bool isFrame() const

Queries whether help was requested on a frame window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isMenu
public:
bool isMenu() const

Queries whether help was requested on a menu window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isWindow
public:
bool isWindow() const

Queries whether help was requested on an application window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

If help was requested on an application or frame window, this function returns the resource identifier of the control with the input focus. If help was requested for a menu item, its resource identifier is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

Returns the resource identifier of the window or menu that contains the control or menu item that had the input focus when help was requested.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IHelpSubitemNotFoundEvent - Inherited Member Functions and Data

Inherited Public Functions

IEvent

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data