This class implements keyboard functionalities. More...

#include <Keyboard.h>

Inheritance diagram for Ocean::Platform::Win::Keyboard:

Static Public Member Functions
static bool	translateVirtualkey (const unsigned int vKey, std::string &key)
	Translates a virtual key code to the corresponsing character key and key description.

static bool	allKeysDown (const Key keys, const bool synchron=true)
	Returns whether all specified keys of the keyboard are currently pushed (down) or not.

static bool	oneKeyDown (const Key keys, const bool synchron=true)
	Returns whether at least one key of the specified keys of the keyboard is currently pushed (down) or not.

static bool	isKeyDown (const Key key, const bool synchron=true)
	Returns wheater exactly one (specified key) is currently pushed (down) or not.

static Key	currentKeyState (const bool synchron=true)
	Returns the current key state for the shift, control and menu keys.

Static Protected Member Functions
static bool	keyState (const int nVirtualKey, const bool synchron)
	Returns wheater exactly one (specified key) is currently pushed (down) or not.

Additional Inherited Members
Private Types inherited from Ocean::Platform::Keyboard
enum	Key { KEY_NONE = 0 , KEY_SHIFT_LEFT = (1 << 0) , KEY_SHIFT_RIGHT = (1 << 1) , KEY_CONTROL_LEFT = (1 << 2) , KEY_CONTROL_RIGHT = (1 << 3) , KEY_MENU_LEFT = (1 << 4) , KEY_MENU_RIGHT = (1 << 5) , KEY_SPACE = (1 << 6) , KEY_LAST_UNIQUE_VALUE = (1 << 6) , KEY_SHIFT = KEY_SHIFT_LEFT \| KEY_SHIFT_RIGHT , KEY_CONTROL = KEY_CONTROL_LEFT \| KEY_CONTROL_RIGHT , KEY_MENU = KEY_MENU_LEFT \| KEY_MENU_RIGHT }
	Definition of individual keyboard keys. More...

Static Private Member Functions inherited from Ocean::Platform::Keyboard
static bool	allKeysDown (const Key keys, const bool synchron=true)
	Returns whether all specified keys of the keyboard are currently pushed (down) or not.

static bool	oneKeyDown (const Key keys, const bool synchron=true)
	Returns whether at least one key of the specified keys of the keyboard is currently pushed (down) or not.

static bool	isKeyDown (const Key key, const bool synchron=true)
	Returns whether exactly one (specified key) is currently pushed (down) or not.

static Key	currentKeyState (const bool synchron=true)
	Returns the current key state for the shift, control and menu keys.

static bool	isKeyDownWindows (const Key key, const bool synchron=true)
	Returns whether exactly one (specified key) is currently pushed (down) or not (specialization for Windows)

static bool	keyStateWindows (const int nVirtualKey, const bool synchron)
	Returns whether exactly one (specified key) is currently pushed (down) or not.

static bool	isKeyDownApple (const Key key, const bool synchron=true)
	Returns whether exactly one (specified key) is currently pushed (down) or not (specialization for Apple platforms)

static bool	keyStateApple (const unsigned short nVirtualKey, const bool synchron)
	Returns whether exactly one (specified key) is currently pushed (down) or not.

Detailed Description

This class implements keyboard functionalities.

Member Function Documentation

◆ allKeysDown()

static bool Ocean::Platform::Win::Keyboard::allKeysDown	(	const Key	keys,
		const bool	synchron = `true`
	)

static

Returns whether all specified keys of the keyboard are currently pushed (down) or not.

Parameters

keys	The keys for that the states are requested (may be a combination of several keys)
synchron	True, to request the state synchronously with the message queue; False, to request the state in the current moment

Returns: True, if so; also True if no key is provided

◆ currentKeyState()

static Key Ocean::Platform::Win::Keyboard::currentKeyState ( const bool synchron = true )

static

Returns the current key state for the shift, control and menu keys.

This function does not distinguish between the left and a right key version.

Returns: Current key state

◆ isKeyDown()

static bool Ocean::Platform::Win::Keyboard::isKeyDown	(	const Key	key,
		const bool	synchron = `true`
	)

static

Returns wheater exactly one (specified key) is currently pushed (down) or not.

Parameters

key	One unique key for that the state is requested, must not be a combination of several keys
synchron	True, to request the state synchronously with the message queue; False, to request the state in the current moment

Returns: True, if so

◆ keyState()

bool Ocean::Platform::Win::Keyboard::keyState	(	const int	nVirtualKey,
		const bool	synchron
	)

inlinestaticprotected

Returns wheater exactly one (specified key) is currently pushed (down) or not.

Parameters

nVirtualKey	The virtual key code for that the state is requested
synchron	True, to request the state synchronously with the message queue; False, to request the state in the current moment

Returns: True, if so

◆ oneKeyDown()

static bool Ocean::Platform::Win::Keyboard::oneKeyDown	(	const Key	keys,
		const bool	synchron = `true`
	)

static

Returns whether at least one key of the specified keys of the keyboard is currently pushed (down) or not.

Parameters

keys	The keys for that the states are requested (may be a combination of several keys)
synchron	True, to request the state synchronously with the message queue; False, to request the state in the current moment

Returns: True, if so; also True if no key is provided

◆ translateVirtualkey()

static bool Ocean::Platform::Win::Keyboard::translateVirtualkey	(	const unsigned int	vKey,
		std::string &	key
	)

static

Translates a virtual key code to the corresponsing character key and key description.

Parameters

vKey	Virtual key code to translate
key	Resulting key character or name

Returns: True, if succeeded

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

win/Keyboard.h

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ allKeysDown()

◆ currentKeyState()

◆ isKeyDown()

◆ keyState()

◆ oneKeyDown()

◆ translateVirtualkey()