ONE::util::KeyDispatcher Class Reference

Inheritance diagram for ONE::util::KeyDispatcher:

[legend]List of all members.

Public Types
typedef KeyListener *	LPtr
Public Member Functions
void	addKeyListener (const LPtr &l)
	EventDispatcher ()
void	fireEvent (KeyEvent &e) const
	notifies all registered listeners
bool	isMuted () const
	reflects this dispatcher's muted state.
void	removeKeyListener (const LPtr &l)
void	setMuted (bool mute)
	mutes or un-mutes the dispatcher
Protected Member Functions
void	add (const LPtr &l)
	registers a listener
void	remove (const LPtr &l)
	de-registers a listener.

---

Member Typedef Documentation

typedef KeyListener * ONE::util::EventDispatcher< KeyEvent , KeyListener , struct KeyRelay >::LPtr [inherited]

---

Member Function Documentation

void ONE::util::EventDispatcher< KeyEvent , KeyListener , struct KeyRelay >::add (  const LPtr &  l  )  [protected, inherited]

registers a listener Parameters: l  a listener

void ONE::util::KeyDispatcher::addKeyListener (  const LPtr &  l  )  [inline]

ONE::util::EventDispatcher< KeyEvent , KeyListener , struct KeyRelay >::EventDispatcher (   )  [inherited]

void ONE::util::EventDispatcher< KeyEvent , KeyListener , struct KeyRelay >::fireEvent (  KeyEvent &  e  )  const [inherited]

notifies all registered listeners The listeners are called in the order in which they were added. This function is provided primarily for use by subclasses. However, it may also be called from the outside in order to inject events into the system. Note that great care should be taken when doing so. For example, listeners generally rely on the event's source being identical to the instance that passes them around, i.e. this event dispatcher. Parameters: e  the event to forward to each listener

bool ONE::util::EventDispatcher< KeyEvent , KeyListener , struct KeyRelay >::isMuted (   )  const [inherited]

reflects this dispatcher's muted state. Returns: true if the dispatcher is muted, false otherwise

void ONE::util::EventDispatcher< KeyEvent , KeyListener , struct KeyRelay >::remove (  const LPtr &  l  )  [protected, inherited]

de-registers a listener. This listener will no longer notify l of events, unless l is registered more than once. If so, a call to this function will only remove the first occurence of l. Parameters: l  a listener

void ONE::util::KeyDispatcher::removeKeyListener (  const LPtr &  l  )  [inline]

void ONE::util::EventDispatcher< KeyEvent , KeyListener , struct KeyRelay >::setMuted (  bool  mute  )  [inherited]

mutes or un-mutes the dispatcher Muted dispatchers no longer notify their listeners.

---