NAME

XvHelpOnItem — provides context-sensitive help. 

SYNOPSIS

#include <Xv/Help.h> void XvHelpOnItem (widget)
Widgetwidget;

ARGUMENTS

widgetSpecifies the applications’s top level widget. 

DESCRIPTION

The XvHelpOnItem function provides context-sensitive help on various physical areas of an application.  Via this function, the application’s cursor is changed to a question mark (?).  The user then selects an item in the application and a request to the Help Manager is initiated.  If the item does not have context-sensitive help associated with it, an error dialog will be posted for the application, otherwise the Help Manager will display a message dealing with the item selected. 
 
The XvHelpOnItem function notifies the help server of an application’s request to enter item help mode.  In item help mode, the user picks a particular item on the screen using the mouse.  The item (actually a widget name) is passed to the HP VUE help manager so it can search for an item topic to display. 

For item help to work properly, the widgets that you use in your application should be given names that distinguish each "item" that the user may request help on.  Topics within the help files must also have correct widget paths that identify the corresponding items. 

RETURN VALUE

none

ORIGIN

Hewlett-Packard Company

RELATED INFORMATION

HP Visual Interface Environment Programmer’s Guide