KeyBoard Class Reference

Simple interface to a keyboard. More...

#include <Devices/KeyBoard.H>

List of all members.

Public Member Functions
	KeyBoard ()
	Constructor.
	~KeyBoard ()
	Destructor.
KeyBoardKey	getKey (const bool block)
	Get a key from the keyboard.
int	getKeyAsChar (const bool block)
	get the key from the keybard and return as an int

---

Detailed Description

Simple interface to a keyboard.

This class provides basic methods to check whether a key was pressed on the keyboard. It is used by the Beobot, which has a small keypad with just 5 keys.

Definition at line 53 of file KeyBoard.H.

---

Constructor & Destructor Documentation

KeyBoard::KeyBoard

(

)

Constructor.

Definition at line 47 of file KeyBoard.C.

References blocking.

KeyBoard::~KeyBoard

(

)

Destructor.

Definition at line 65 of file KeyBoard.C.

---

Member Function Documentation

KeyBoardKey KeyBoard::getKey

(

const bool

block

)

Get a key from the keyboard.

Parameters:

block

if true, this function will block until a key is pressed. Otherwise, it will return the key pressed if any, or KBD_NONE if no key was pressed.

Definition at line 86 of file KeyBoard.C.

References blocking.

Referenced by main().

int KeyBoard::getKeyAsChar

(

const bool

block

)

get the key from the keybard and return as an int

Parameters:

block

if true, this function will block until a key is pressed.

Definition at line 98 of file KeyBoard.C.

References blocking.

---

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

• src/Devices/KeyBoard.H
• src/Devices/KeyBoard.C