manpagez: man pages & more
man XmTrackingEvent(3)
Home | html | info | man
XmTrackingEvent(library call)                    XmTrackingEvent(library call)




NAME

       XmTrackingEvent -- A Toolkit function that provides a modal interaction


SYNOPSIS

       #include <Xm/Xm.h>
       Widget XmTrackingEvent(
       Widget widget,
       Cursor cursor,
       Boolean confine_to,
       XEvent *event_return);


DESCRIPTION

       XmTrackingEvent provides a modal interface for selection  of  a  compo-
       nent.   It is intended to support context help.  The function calls the
       XmUpdateDisplay function.  XmTrackingEvent then grabs the  pointer  and
       discards  succeeding  events  until  BSelect  is  released  or a key is
       pressed and then released.  The function then  returns  the  widget  or
       gadget  that  contains the pointer when BSelect is released or a key is
       released, and ungrabs the pointer.

       widget    Specifies the widget ID of a widget to use as  the  basis  of
                 the  modal  interaction. That is, the widget within which the
                 interaction must occur, usually a top-level shell.

       cursor    Specifies the cursor to be used for the  pointer  during  the
                 interaction.  This is a standard X cursor name.

       confine_to
                 Specifies  whether  or  not  the cursor should be confined to
                 widget.

       event_return
                 Returns the ButtonRelease or KeyRelease event that causes the
                 function to return.


RETURN

       Returns  the widget or gadget that contains the pointer when BSelect is
       released or a key is released. If no  widget  or  gadget  contains  the
       pointer, the function returns NULL.


RELATED

       XmTrackingLocate(3).



                                                 XmTrackingEvent(library call)

openMotif 2.3.1 - Generated Thu Dec 4 11:47:40 CST 2008
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.