sdl::devices::Keyboard Struct Reference

Represents a keyboard. More...

#include <Keyboard.h>

List of all members.

Static Public Member Functions
static string	getKeyName (SDLKey key)
static pair< unsigned char *, int >	keyState ()
static SDLMod	getModState ()
static void	setModState (SDLMod state)
static bool	enableKeyRepeat (int delay, int interval)
static bool	disableKeyRepeat ()
static void	enableUnicode ()
static void	disableUnicode ()
static bool	unicodeEnabled ()

---

Detailed Description

Represents a keyboard.

Definition at line 34 of file Keyboard.h.

---

Member Function Documentation

static bool sdl::devices::Keyboard::disableKeyRepeat

(

)

[inline, static]

Disables key repeating.

Returns:

True if successful, false otherwise.

Definition at line 84 of file Keyboard.h.

static void sdl::devices::Keyboard::disableUnicode

(

)

[inline, static]

Disables UNICODE translation.

Definition at line 94 of file Keyboard.h.

static bool sdl::devices::Keyboard::enableKeyRepeat	(	int	delay,
		int	interval
	)		[inline, static]

Enables key repeating.

Parameters:

dela,The	number of milliseconds the key must be pressed before it starts repeating.
interval	The interval in milliseconds at which to reapeat the keys.

Returns:

True if successful, false otherwise.

Definition at line 77 of file Keyboard.h.

static void sdl::devices::Keyboard::enableUnicode

(

)

[inline, static]

Enables UNICODE translation.

Definition at line 89 of file Keyboard.h.

static string sdl::devices::Keyboard::getKeyName

(

SDLKey

key

)

[inline, static]

Gets the name of the SDL virtual keysym.

Parameters:

key	The key for which to get the name of the keysym.

Returns:

The name of the keysym.

Definition at line 42 of file Keyboard.h.

static SDLMod sdl::devices::Keyboard::getModState

(

)

[inline, static]

Gets the state of the modifier keys.

Returns:

The state of the modifier keys.

Definition at line 60 of file Keyboard.h.

static pair<unsigned char*, int> sdl::devices::Keyboard::keyState

(

)

[inline, static]

Gets the current keyboard state.

Returns:

A pair containing an array of the current keyboard state and its length.

Definition at line 49 of file Keyboard.h.

static void sdl::devices::Keyboard::setModState

(

SDLMod

state

)

[inline, static]

Sets the state of the modifier keys.

Parameters:

The	state to which to set the modifier keys.

Definition at line 67 of file Keyboard.h.

static bool sdl::devices::Keyboard::unicodeEnabled

(

)

[inline, static]

Determines if UNICODE translation is enabled.

Returns:

True if enabled, false otherwise.

Definition at line 101 of file Keyboard.h.

---

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

• devices/Keyboard.h