dtCore::KeyboardListener Class Reference

An interface for objects interested in receiving keyboard events. More...

#include <keyboard.h>

Inheritance diagram for dtCore::KeyboardListener:

List of all members.

Public Member Functions
virtual bool	HandleKeyPressed (const Keyboard *keyboard, int kc)=0
	Called when a key is pressed.
virtual bool	HandleKeyReleased (const Keyboard *keyboard, int kc)=0
	Called when a key is released.
virtual bool	HandleKeyTyped (const Keyboard *keyboard, int kc)=0
	Called when a key is typed.
Protected Member Functions
virtual	~KeyboardListener ()

---

Detailed Description

An interface for objects interested in receiving keyboard events.

---

Constructor & Destructor Documentation

virtual dtCore::KeyboardListener::~KeyboardListener

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual bool dtCore::KeyboardListener::HandleKeyPressed	(	const Keyboard *	keyboard,
		int	kc
	)			[pure virtual]

Called when a key is pressed.

Parameters:

	keyboard	the source of the event
	key	the key pressed
	character	the corresponding character

Returns:

true if this KeyboardListener handled the event. The Keyboard calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericKeyboardListener, dtGame::InputComponentKeyboardListener, and dtGUI::CEGUIKeyboardListener.

virtual bool dtCore::KeyboardListener::HandleKeyReleased	(	const Keyboard *	keyboard,
		int	kc
	)			[pure virtual]

Called when a key is released.

Parameters:

	keyboard	the source of the event
	key	the key released

Returns:

true if this KeyboardListener handled the event. The Keyboard calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericKeyboardListener, dtGame::InputComponentKeyboardListener, and dtGUI::CEGUIKeyboardListener.

virtual bool dtCore::KeyboardListener::HandleKeyTyped	(	const Keyboard *	keyboard,
		int	kc
	)			[pure virtual]

Called when a key is typed.

Parameters:

	keyboard	the source of the event
	key	the key typed

Returns:

true if this KeyboardListener handled the event. The Keyboard calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericKeyboardListener, dtGame::InputComponentKeyboardListener, and dtGUI::CEGUIKeyboardListener.

---