Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_CollapseMotionEvents (3tk)

Name

Tk_CollapseMotionEvents - Add a window event to the Tcl event queue

Synopsis

#include <tk.h>

int
Tk_CollapseMotionEvents(display, collapse)

Tk_QueueWindowEvent(eventPtr, position)

Description

Tk_QueueWindowEvent(3tk)     Tk Library Procedures    Tk_QueueWindowEvent(3tk)



______________________________________________________________________________

NAME
       Tk_CollapseMotionEvents,  Tk_QueueWindowEvent  -  Add a window event to
       the Tcl event queue

SYNOPSIS
       #include <tk.h>

       int
       Tk_CollapseMotionEvents(display, collapse)

       Tk_QueueWindowEvent(eventPtr, position)

ARGUMENTS
       Display *display (in)                    Display for which  to  control
                                                motion event collapsing.

       int collapse (in)                        Indicates    whether    motion
                                                events should be collapsed  or
                                                not.

       XEvent *eventPtr (in)                    An  event  to add to the event
                                                queue. It  is  important  that
                                                all   unused   fields  of  the
                                                structure be set to zero.

       Tcl_QueuePosition position (in)          Where to add the new event  in
                                                the   queue:   TCL_QUEUE_TAIL,
                                                TCL_QUEUE_HEAD,             or
                                                TCL_QUEUE_MARK.
______________________________________________________________________________

DESCRIPTION
       Tk_QueueWindowEvent places a window event on Tcl's internal event queue
       for eventual servicing.  It creates a Tcl_Event structure,  copies  the
       event into that structure, and calls Tcl_QueueEvent to add the event to
       the queue.  When the event is eventually removed from the queue  it  is
       processed just like all window events.

       When  multiple  motion events are received for the same window in rapid
       succession, they are collapsed by default.  This behavior can  be  con-
       trolled  with  Tk_CollapseMotionEvents.  Tk_CollapseMotionEvents always
       returns the previous value for collapse behavior on the display.

       The position argument to Tk_QueueWindowEvent has the same  significance
       as  for  Tcl_QueueEvent;   see the documentation for Tcl_QueueEvent for
       details.

KEYWORDS
       callback, clock, handler, modal timeout, events



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tk-8     |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source        was        downloaded        from         https://source-
       forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tk                                    7.5             Tk_QueueWindowEvent(3tk)