dtCore::GenericKeyboardListener Class Reference

Provides generic callback support for Keyboard events. More...

#include <generickeyboardlistener.h>

Inheritance diagram for dtCore::GenericKeyboardListener:

List of all members.

Public Types
typedef KeyboardListener	BaseClass
typedef dtUtil::Functor< bool, TYPELIST_2(const Keyboard *, int)	CallbackType )
Public Member Functions
	GenericKeyboardListener ()
bool	HandleKeyPressed (const Keyboard *kb, int kc)
	Called when a key is pressed.
bool	HandleKeyReleased (const Keyboard *kb, int kc)
	Called when a key is released.
bool	HandleKeyTyped (const Keyboard *kb, int kc)
	Called when a key is typed.
void	SetPressedCallback (const CallbackType &callback)
const CallbackType &	GetPressedCallback () const
bool	IsPressedCallbackEnabled () const
void	DisablePressedCallback ()
void	SetReleasedCallback (const CallbackType &callback)
const CallbackType &	GetReleasedCallback () const
bool	IsReleasedCallbackEnabled () const
void	DisableReleasedCallback ()
void	SetTypedCallback (const CallbackType &callback)
const CallbackType &	GetTypedCallback () const
bool	IsTypedCallbackEnabled () const
void	DisableTypedCallback ()
Protected Member Functions
	~GenericKeyboardListener ()

---

Detailed Description

Provides generic callback support for Keyboard events.

---

Member Typedef Documentation

typedef KeyboardListener dtCore::GenericKeyboardListener::BaseClass

typedef dtUtil::Functor<bool,TYPELIST_2(const Keyboard*,int) dtCore::GenericKeyboardListener::CallbackType)

---

Constructor & Destructor Documentation

GenericKeyboardListener::GenericKeyboardListener

(

)

GenericKeyboardListener::~GenericKeyboardListener

(

)

[protected]

---

Member Function Documentation

bool GenericKeyboardListener::HandleKeyPressed	(	const Keyboard *	keyboard,
		int	kc
	)			[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.

Implements dtCore::KeyboardListener.

bool GenericKeyboardListener::HandleKeyReleased	(	const Keyboard *	keyboard,
		int	kc
	)			[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.

Implements dtCore::KeyboardListener.

bool GenericKeyboardListener::HandleKeyTyped	(	const Keyboard *	keyboard,
		int	kc
	)			[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.

Implements dtCore::KeyboardListener.

void GenericKeyboardListener::SetPressedCallback

(

const CallbackType &

callback

)

const GenericKeyboardListener::CallbackType & GenericKeyboardListener::GetPressedCallback

(

)

const

bool GenericKeyboardListener::IsPressedCallbackEnabled

(

)

const

void GenericKeyboardListener::DisablePressedCallback

(

)

void GenericKeyboardListener::SetReleasedCallback

(

const CallbackType &

callback

)

const GenericKeyboardListener::CallbackType & GenericKeyboardListener::GetReleasedCallback

(

)

const

bool GenericKeyboardListener::IsReleasedCallbackEnabled

(

)

const

void GenericKeyboardListener::DisableReleasedCallback

(

)

void GenericKeyboardListener::SetTypedCallback

(

const CallbackType &

callback

)

const GenericKeyboardListener::CallbackType & GenericKeyboardListener::GetTypedCallback

(

)

const

bool GenericKeyboardListener::IsTypedCallbackEnabled

(

)

const

void GenericKeyboardListener::DisableTypedCallback

(

)

---