Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_HandleEvent (3tk)

Name

Tk_HandleEvent - invoke event handlers for window system events

Synopsis

#include <tk.h>

Tk_HandleEvent(eventPtr)

Description

Tk_HandleEvent(3tk)          Tk Library Procedures         Tk_HandleEvent(3tk)



______________________________________________________________________________

NAME
       Tk_HandleEvent - invoke event handlers for window system events

SYNOPSIS
       #include <tk.h>

       Tk_HandleEvent(eventPtr)

ARGUMENTS
       XEvent *eventPtr (in)          Pointer  to X event to dispatch to rele-
                                      vant handler(s). It  is  important  that
                                      all  unused  fields  of the structure be
                                      set to zero.
______________________________________________________________________________

DESCRIPTION
       Tk_HandleEvent is  a  lower-level  procedure  that  deals  with  window
       events.    It   is   called  by  Tcl_ServiceEvent  (and  indirectly  by
       Tk_DoOneEvent), and in a few other cases within Tk.  It makes callbacks
       to  any  window  event  handlers  (created  by  calls to Tk_CreateEven-
       tHandler) that match eventPtr and then returns.  In some cases  it  may
       be  useful  for  an  application  to bypass the Tk event queue and call
       Tk_HandleEvent directly instead of calling Tcl_QueueEvent  followed  by
       Tcl_ServiceEvent.

       This procedure may be invoked recursively.  For example, it is possible
       to invoke Tk_HandleEvent recursively from a handler called  by  Tk_Han-
       dleEvent.   This  sort of operation is useful in some modal situations,
       such as when a notifier has been popped up and an application wishes to
       wait  for  the user to click a button in the notifier before doing any-
       thing else.

KEYWORDS
       callback, event, handler, window



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                                                         Tk_HandleEvent(3tk)