DtHelpReturnSelectUNIXdSystem3V (1DtHelpReturnSelectedWidgetId(3)
NAME
DtHelpReturnSelectedWidgetId - select a widget or gadget
SYNOPSIS
#include <Dt/Help.h>
int DtHelpReturnSelectedWidgetId(Widget parent,
String cursor,
Widget *widget);
DESCRIPTION
The DtHelpReturnSelectedWidgetId() function provides an
interface for users to select a component within an
application.
This function grabs the pointer and returns the widget
within which a button press occurs. Pressing the escape key
(ESC) aborts this function.
The parent argument specifies the widget ID to use as the
basis of the interaction, usually a top level shell.
The cursor argument specifies the cursor to be used for the
pointer during the interaction. If a NULL value is used,
DtHelpReturnSelectedWidgetId() uses a default cursor value.
The widget argument is the return value (for example, the
selected widget). A NULL value is returned on error.
The DtHelpReturnSelectedWidgetId() function allows
applications to get the widget ID for any widget in their
user interface that the user has selected via the pointer.
The application can then directly display a help topic based
on the selected widget, or dynamically construct some help
information based on the current context of the selected
item. At any point while the question mark cursor is
displayed, the user can select the escape key to abort the
function call, and a NULL value is returned. If the user
selects any item outside the current applications windows,
an error status is returned along with a NULL value for the
widget argument. Refer to the OSF/Motif 1.2
XmTrackingLocate(3X) for a similar function.
RETURN VALUE
Upon successful completion, the
DtHelpReturnSelectedWidgetId() function returns one of the
following status values:
DtHELP_SELECT_ERROR
An error occurred while attempting to process the
function.
Page 1 (printed 9/3/04)
DtHelpReturnSelectUNIXdSystem3V (1DtHelpReturnSelectedWidgetId(3)
DtHELP_SELECT_INVALID
The user selected an invalid component that is not
contained in the current widget hierarchy.
DtHELP_SELECT_ABORT
The user aborted the function (for example, pressed
the escape key), and a NULL widget value is passed
back.
DtHELP_SELECT_VALID
The user selected a valid component within the
application, and the widget argument is the ID of
the selected component.
SEE ALSO
DtHelp(5), DtCreateHelpQuickDialog(3),
DtCreateHelpDialog(3); XmTrackingLocate(3X),
Page 2 (printed 9/3/04)
