driver.event.HookEvent

Package driver :: Module event :: Class HookEvent

[show private | hide private]

Class HookEvent

Event --+
        |
       HookEvent

When information needs to be passed to registered functions of a hook, this allows us to defer execution of that spam event into its own event horizon.

Method Summary
	`__init__(self, hookname, args)` Initializes the HookEvent.
	`__str__(self)` String representing the event.
	`execute(self, my_engine)` Execute.
Inherited from Event
	`__repr__(self)`
	`enqueue(self)` Enqueues the current Event in the engine's event queue for later execution.

Method Details

init(self, hookname, args)
(Constructor)

Initializes the HookEvent.

Parameters:: hookname - the name of the hook to spam
(type=string); args - the arguments to send to the functions registered with the hook in question
(type=tuple)

Overrides:: driver.event.Event.__init__

str(self)
(Informal representation operator)

String representing the event. This is useful for verbose mode where we log all the events we've handled.

Overrides:: driver.event.Event.__str__ (inherited documentation)

execute(self, my_engine)

Execute.

Overrides:: driver.event.Event.execute

Generated by Epydoc 2.0 on Wed Jan 21 21:00:06 2004

http://epydoc.sf.net

Class HookEvent

__init__(self, hookname, args) (Constructor)

__str__(self) (Informal representation operator)

execute(self, my_engine)

init(self, hookname, args)
(Constructor)

str(self)
(Informal representation operator)