modules::clEvent::Events Class Reference

Pyjama's event class is the EventHandler class interface. More...

List of all members.

Public Member Functions
def	__init__
def	add_event
	Creates a new event.
def	connect_event
	Connects to an existing event.
def	disconnect_event
	Disconnects a function from an event.
def	raise_event
	Raises an event.
Public Attributes
	dict
	A dictionary with all events created.

---

Detailed Description

Pyjama's event class is the EventHandler class interface.

Definition at line 69 of file clEvent.py.

---

Member Function Documentation

def modules::clEvent::Events::add_event	(		self,
			eventname
	)

Creates a new event.

Parameters:

	self	Object Pointer
	eventname	The new event's name

Returns:

None

Definition at line 81 of file clEvent.py.

def modules::clEvent::Events::connect_event	(		self,
			eventname,
			fkt
	)

Connects to an existing event.

Parameters:

	self	Object Pointer
	eventname	Name of the event to connect to
	fkt	The function to call when this event is raised

Returns:

None

Definition at line 89 of file clEvent.py.

def modules::clEvent::Events::disconnect_event	(		self,
			eventname,
			fkt,
			argv
	)

Disconnects a function from an event.

Parameters:

	self	Object Pointer
	eventname	Name of the event to disconnect from
	fkt	The function to disconnect

Returns:

None

Definition at line 97 of file clEvent.py.

def modules::clEvent::Events::raise_event	(		self,
			eventname,
			argv,
			kargs
	)

Raises an event.

Parameters:

	self	Object Pointer
	eventname	Name of the event to raise
	*argv	Arguments to pass to the connected functions
	*kargs	Keyword arguments to pass to the connected functions

Returns:

None

Definition at line 106 of file clEvent.py.

---

The documentation for this class was generated from the following file:

• modules/clEvent.py