IKeyboard Class Reference

Defines the interface that a Keyboard implementation must implement. More...

#include <Input/Keyboard.h>

Inherited by SDLKeyboard.

List of all members.

Public Member Functions
virtual bool	KeyDown (Key k) const =0
	Determines if the given Key is down.
virtual bool	KeyPressed (Key k) const =0
	Determines if the given Key was just pressed.
virtual bool	KeyPressedRepeat (Key k) const =0
	Determines if the given Key was just pressed or is being repeated.
virtual bool	KeyRepeat (Key k) const =0
	Determines if the given Key is being repeated.
virtual uint	InputQueueSize () const =0
	Returns the size of the input queue.
virtual const KeyData &	InputQueuePeek () const =0
	Returns the key at the top of the input queue.
virtual const KeyData &	InputQueueGet (uint i) const =0
	Returns the ith key in the input queue.

---

Detailed Description

Defines the interface that a Keyboard implementation must implement.

---

Member Function Documentation

virtual bool IKeyboard::KeyDown

(

Key

k

)

const [pure virtual]

Determines if the given Key is down.

Parameters:

[in]

k

the Key to check.

Returns:

True if the Key k is down, false otherwise.

Implemented in SDLKeyboard.

virtual bool IKeyboard::KeyPressed

(

Key

k

)

const [pure virtual]

Determines if the given Key was just pressed.

Parameters:

[in]

k

the Key to check.

Returns:

True if the Key k was just pressed, false otherwise.

Implemented in SDLKeyboard.

virtual bool IKeyboard::KeyPressedRepeat

(

Key

k

)

const [pure virtual]

Determines if the given Key was just pressed or is being repeated.

Parameters:

[in]

k

the Key to check.

Returns:

True if the Key k was just pressed or is being repeated, false otherwise.

Implemented in SDLKeyboard.

virtual bool IKeyboard::KeyRepeat

(

Key

k

)

const [pure virtual]

Determines if the given Key is being repeated.

Parameters:

[in]

k

the Key to check.

Returns:

True if the Key k is being repeated, false otherwise.

Implemented in SDLKeyboard.

---

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

• Keyboard.h