cohtml::KeyEventData

A keyboard event.

#include <InputEvents.h>

Public Types

	Name
enum	EventType { Unknown, KeyDown, KeyUp, Char}
enum	EventLocation { Standard = 0, Left = 1, Right = 2, Numpad = 3}

Public Functions

	Name
	KeyEventData()

Public Attributes

	Name
int	KeyCode The key code.
EventType	Type The type of the event.
EventModifiersState	Modifiers The current key modifiers.
EventLocation	Location Represents the location of the key on the keyboard or other input device.
bool	IsAutoRepeat Is it an auto-repeat event (the user is holding the key down). This value isn’t crucial and you can set it to false if you don’t have the information, however you might experience incorrect repeat behavior in such case.
bool	IsNumPad Is it a key from the num-pad.
bool	IsSystemKey This identifies whether this event was tagged by the system as being a “system key” event (see http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details). Other platforms don’t have this concept. Generally means the Alt key is held down (but not AltGr, if present).

Public Types Documentation

enum EventType

Enumerator	Value	Description
Unknown
KeyDown
KeyUp
Char

enum EventLocation

Enumerator	Value	Description
Standard	0
Left	1
Right	2
Numpad	3

Public Functions Documentation

function KeyEventData

inline KeyEventData()

Public Attributes Documentation

variable KeyCode

int KeyCode;

The key code.

variable Type

EventType Type;

The type of the event.

variable Modifiers

EventModifiersState Modifiers;

The current key modifiers.

variable Location

EventLocation Location;

Represents the location of the key on the keyboard or other input device.

variable IsAutoRepeat

bool IsAutoRepeat;

Is it an auto-repeat event (the user is holding the key down). This value isn’t crucial and you can set it to false if you don’t have the information, however you might experience incorrect repeat behavior in such case.

variable IsNumPad

bool IsNumPad;

Is it a key from the num-pad.

variable IsSystemKey

bool IsSystemKey;

This identifies whether this event was tagged by the system as being a “system key” event (see http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details). Other platforms don’t have this concept. Generally means the Alt key is held down (but not AltGr, if present).

---