Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
XmtHelpIns...ContextHelp(3) Library Functions Manual XmtHelpIns...ContextHelp(3)

NAME
     XmtHelpInstallContextHelp(),  XmtHelpContextHelpCallback() - keyboard bind-
     ings for context help.

SYNOPSIS
     #include <Xmt/Help.h>

     void XmtHelpInstallContextHelp(Widget root, XtCallbackProc proc, XtPointer
		    data)

     void XmtHelpContextHelpCallback(Widget w, XtPointer unused1, XtPointer
		    unused2)

ARGUMENTS
     INPUTS

     root   The root of the widget tree for which  the	specified  context  help
	    callback is to be registered.

     proc   The callback procedure to register.

     data   The data to register with the callback procedure.

     w	    For  XmtHelpContextHelpCallback(), the widget for which context help
	    is to be displayed.

     unused1, unused2
	    These arguments to XmtHelpContextHelpCallback() are unused.

DESCRIPTION
     XmtHelpInstallContextHelp() recursively traverses the widget tree rooted at
     root and registers the callback procedure proc with client data data on the
     XmNhelpCallback callback list of every widget that is a Motif widget  or  a
     subclass  and that has its XmNtraversalOn resource set to True. That is, it
     calls XtAddCallback() for the XmNhelpCallback for every wid  get  that  can
     have the keyboard focus. All Motif widgets and their Xmt subclasses have an
     XmNhelpCallback callback list, and invoke the procedures registered on that
     list  whenever  they  have the keyboard focus and the user strikes the Help
     key (usually bound to F1).

     XmtHelpContextHelpCallback()  is  a   convenience	 function   that   calls
     XmtHelpDisplayContextHelp()  to  display context help on the widget w. This
     function is of type XtCallbackProc, so it can be directly registered on the
     XmNhelpCallback callback list supported by all Motif and  Xmt  widgets.  It
     can  also	be  passed to XmtHelpInstallContextHelp() to register it on many
     widgets at once.

SEE ALSO
     Chapter 30, Context Help,
     XmtHelpDisplayContextHelp(), XmtHelpDoContextHelp(),
     XmtHelpGetContextHelp().

Xmt				   Motif Tools	     XmtHelpIns...ContextHelp(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmtHelpInstallContextHelp&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help