IKeyboardEvent Class Reference

The keyboard event callbacks. More...

#include <ceKeyboard.h>

Inheritance diagram for IKeyboardEvent:

List of all members.

Public Member Functions
virtual void	OnKeyPressed (const IKeyboardDevice *Owner, const int key, const int buffer[256])=0x0
	This callback is called when a key is pressed.
virtual void	OnKeyReleased (const IKeyboardDevice *Owner, const int key, const int buffer[256])=0x0
	This callback is called when a key is released.
virtual void	OnKeyEvent (const IKeyboardDevice *Owner, const int buffer[256])=0x0
	This callback is always called while is keep pressed any key.

---

Detailed Description

The keyboard event callbacks.

Note:

To recieve buffered keyboard input, derive a class from this, and implement the methods here. Then set the callback to your keyboard instance with IKeyboardDevice::SetKeyboardEvent().

See also:

IKeyboardDevice

---

Member Function Documentation

virtual void OnKeyPressed	(	const IKeyboardDevice *	Owner,
		const int	key,
		const int	buffer[256]
	)			[pure virtual]

This callback is called when a key is pressed.

Parameters:

	Owner	The keyboard manager owner.
	key	The virtual key was pressed. If the desired virtual key is a letter or digit (A through Z, a through z, or 0 through 9), key must be set to the ASCII value of that character. For other keys, it must be a virtual-key code.
	buffer	Pointer to a 256-byte array that contains keyboard key states.

See also:

OnKeyReleased, OnKeyEvent

virtual void OnKeyReleased	(	const IKeyboardDevice *	Owner,
		const int	key,
		const int	buffer[256]
	)			[pure virtual]

This callback is called when a key is released.

Parameters:

	Owner	The keyboard manager owner.
	key	The virtual key was pressed. If the desired virtual key is a letter or digit (A through Z, a through z, or 0 through 9), key must be set to the ASCII value of that character. For other keys, it must be a virtual-key code.
	buffer	Pointer to a 256-byte array that contains keyboard key states.

See also:

OnKeyPressed, OnKeyEvent

virtual void OnKeyEvent	(	const IKeyboardDevice *	Owner,
		const int	buffer[256]
	)			[pure virtual]

This callback is always called while is keep pressed any key.

Parameters:

	Owner	The keyboard manager owner.
	buffer	Pointer to a 256-byte array that contains keyboard key states.

See also:

OnKeyPressed, OnKeyReleased

---

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

• ceKeyboard.h