OpenGUI::EventReceiver Class Reference

#include <OpenGUI_Event.h>

Detailed Description

Provides a unified event definition, binding, and relaying service.

Public Member Functions

void createEvent (const std::string &name)

Adds the given name to the list of valid (and bindable) events.

void sendEvent (const std::string &name, EventArgs &args)

Sends an event of the given name to all such bound EventHandler instances.

EventHandlerList * getEventHandlers (const std::string &name)

Returns the list of EventHandler objects for the event of given name.

EventHandlerList & operator[] (const std::string &name)

Returns reference to the list of EventHandler objects for the event of given name, throws exception if event does not exist.

Member Function Documentation

void OpenGUI::EventReceiver::createEvent ( const std::string & name )

Adds the given name to the list of valid (and bindable) events.

EventHandlerList * OpenGUI::EventReceiver::getEventHandlers ( const std::string & name )

Returns the list of EventHandler objects for the event of given name.

Returns 0 (NULL) if the event requested does not exist.

See also:: Too create new events see createEvent()

EventHandlerList & OpenGUI::EventReceiver::operator[] ( const std::string & name )

Returns reference to the list of EventHandler objects for the event of given name, throws exception if event does not exist.

void OpenGUI::EventReceiver::sendEvent	(	const std::string &	name,
		EventArgs &	args
	)

Sends an event of the given name to all such bound EventHandler instances.

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

OpenGUI_Event.h
OpenGUI_Event.cpp


Public Member Functions
void	createEvent (const std::string &name)
	Adds the given `name` to the list of valid (and bindable) events.
void	sendEvent (const std::string &name, EventArgs &args)
	Sends an event of the given `name` to all such bound EventHandler instances.
EventHandlerList *	getEventHandlers (const std::string &name)
	Returns the list of EventHandler objects for the event of given `name`.
EventHandlerList &	operator[] (const std::string &name)
	Returns reference to the list of EventHandler objects for the event of given `name`, throws exception if event does not exist.