tk_handleevent(3tk) [opensolaris man page]

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 relevant handler(s).
_________________________________________________________________

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_HandleEvent.	 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 anything else.

KEYWORDS

       callback, event, handler, window

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +--------------------+-----------------+
       |  ATTRIBUTE TYPE    | ATTRIBUTE VALUE |
       +--------------------+-----------------+
       |Availability	    | SUNWTk	      |
       +--------------------+-----------------+
       |Interface Stability | Uncommitted     |
       +--------------------+-----------------+
NOTES

       Source for Tk is available on http://opensolaris.org.

Tk															       Tk_HandleEvent(3TK)

Tk_CreateEventHandler(3TK)				       Tk Library Procedures					Tk_CreateEventHandler(3TK)

__________________________________________________________________________________________________________________________________________________

NAME

       Tk_CreateEventHandler, Tk_DeleteEventHandler - associate procedure callback with an X event

SYNOPSIS

       #include <tk.h>

       Tk_CreateEventHandler(tkwin, mask, proc, clientData)

       Tk_DeleteEventHandler(tkwin, mask, proc, clientData)

ARGUMENTS

       Tk_Window       tkwin	    (in)      Token for window in which events may occur.

       unsigned long   mask	    (in)      Bit-mask of events (such as ButtonPressMask) for which proc should be called.

       Tk_EventProc    *proc	    (in)      Procedure to invoke whenever an event in mask occurs in the window given by tkwin.

       ClientData      clientData   (in)      Arbitrary one-word value to pass to proc.
_________________________________________________________________

DESCRIPTION

       Tk_CreateEventHandler  arranges for proc to be invoked in the future whenever one of the event types specified by mask occurs in the window
       specified by tkwin.  The callback to proc will be made by Tk_HandleEvent; this mechanism  only  works  in  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 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  which  the  event  occurred.
       EventPtr is a pointer to the X event, which will be one of the ones specified in 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 associated
       with tkwin and matches the mask, proc, and clientData arguments.  If no such handler exists, then Tk_HandleEvent returns without doing any-
       thing.	Although  Tk  supports	it, it's probably a bad idea to have more than one callback with the same mask, proc, and clientData argu-
       ments.  When a window is deleted all of its handlers will be deleted automatically;  in 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 the order they were
       created.

KEYWORDS

       bind, callback, event, handler

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +--------------------+-----------------+
       |  ATTRIBUTE TYPE    | ATTRIBUTE VALUE |
       +--------------------+-----------------+
       |Availability	    | SUNWTk	      |
       +--------------------+-----------------+
       |Interface Stability | Uncommitted     |
       +--------------------+-----------------+
NOTES

       Source for Tk is available on http://opensolaris.org.

Tk															Tk_CreateEventHandler(3TK)