event.tcl Annotations

A library for registering, managing and executing events and event handlers. An event is associated always with a tag. Therefore a binding is between a Tcl procedure and an tag/event combination. The invocation can be synchronous or asynchronous. This is determined on a binding per binding basis at the moment of registration. Event handlers are only valid until system shutdown. For an event handler to have persistent nature, it must be registered every time on boot.

Procedure Detail

bind

proc bind { tag name handler {param -async} }

Register a handler to be executed when a certain event occurs.

Parameters:

tag - An alphanumeric that uniquely identifies the tag. As a convention it should be all upper-case.

name - An alphanumeric that uniquely identifies the event's name. As a convention it should be all upper-case.

handler - Some code to be executed, typically the full path to a procedure.

Returns:

The binding id that can be used to unbind this binding later. @error

Defined in:

event.tcl, line 53

generate

proc generate { tag name {params {}} }

Emit an event and execute associated handlers

Parameters:

tag - An alphanumeric that uniquely identifies the tag. As a convention it should be all upper-case.

name - An alphanumeric that uniquely identifies the event's name. As a convention it should be all upper-case.

params - Optional list of arguments that accompany the event and provide extra information. @error

Defined in:

event.tcl, line 25

unbind

proc unbind { bindid }

Unregister a previously registered handler.

Parameters:

id - The binding id as returned by 'bind'.

Returns:

Nothing. @error

Defined in:

event.tcl, line 73