Seth Woolley's Man Viewer

Tk_CreateEventHandler(3) - Tk_CreateEventHandler, Tk_DeleteEventHandler - associate procedure callback with an X event - man 3 Tk_CreateEventHandler

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

Tk_CreateEventHandler(3)     Tk Library Procedures    Tk_CreateEventHandler(3)



______________________________________________________________________________

NAME
       Tk_CreateEventHandler,   Tk_DeleteEventHandler  -  associate  procedure
       callback with an X event

SYNOPSIS
       #include <tk.h>

       Tk_CreateEventHandler(tkwin, mask, proc(5,n), clientData)

       Tk_DeleteEventHandler(tkwin, mask, proc(5,n), clientData)

ARGUMENTS
       Tk_Window       tkwin        (in(1,8))      Token for window in(1,8) which events
                                              may occur.

       unsigned long   mask         (in(1,8))      Bit-mask of events (such as But-
                                              tonPressMask)  for  which   proc(5,n)
                                              should be called.

       Tk_EventProc    *proc(5,n)        (in(1,8))      Procedure  to invoke whenever an
                                              event in(1,8) mask occurs in(1,8) the win-
                                              dow given by tkwin.

       ClientData      clientData   (in(1,8))      Arbitrary one-word value to pass
                                              to proc(5,n).
_________________________________________________________________


DESCRIPTION
       Tk_CreateEventHandler arranges for proc(5,n) to be  invoked  in(1,8)  the  future
       whenever  one of the event types specified by mask occurs in(1,8) the window
       specified by tkwin.  The callback to  proc(5,n)  will  be  made  by  Tk_Han-
       dleEvent;  this  mechanism  only works in(1,8) programs that dispatch events
       through Tk_HandleEvent  (or  through  other  Tk  procedures  that  call
       Tk_HandleEvent, such as Tk_DoOneEvent or Tk_MainLoop).

       Proc should have arguments and result that match the type Tk_EventProc:
              typedef void Tk_EventProc(
                ClientData clientData,
                XEvent *eventPtr);
       The clientData parameter to proc(5,n) is a copy of the  clientData  argument
       given  to  Tk_CreateEventHandler  when the callback was created.  Typi-
       cally, clientData points to a data  structure  containing  application-
       specific  information  about  the  window  in(1,8) which the event occurred.
       EventPtr is a pointer to the X event, which will be  one  of  the  ones
       specified in(1,8) the mask argument to Tk_CreateEventHandler.

       Tk_DeleteEventHandler  may  be  called  to  delete a previously-created
       event handler:  it deletes the first handler it finds that  is  associ-
       ated  with  tkwin and matches the mask, proc(5,n), and clientData arguments.
       If no such handler exists, then Tk_HandleEvent  returns  without  doing
       anything.   Although  Tk  supports it, it's probably a bad idea to have
       more than one callback with the same mask, proc(5,n), and  clientData  argu-
       ments.   When  a  window is deleted all of its handlers will be deleted
       automatically;  in(1,8) this case there is no need  to  call  Tk_DeleteEven-
       tHandler.

       If  multiple  handlers are declared for the same type of X event on the
       same window, then the handlers will be invoked in(1,8) the order  they  were
       created.


KEYWORDS
       bind(2,n,1 builtins), callback, event, handler



Tk                                                    Tk_CreateEventHandler(3)

References for this manual (incoming links)