1.7.2.9
Gameface
cohtml::KeyEventData Struct Reference

A keyboard event. More...

Public Types

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

Public Member Functions

 KeyEventData ()
 

Public Attributes

int KeyCode
 The key code. More...
 
EventType Type
 The type of the event. More...
 
EventModifiersState Modifiers
 The current key modifiers. More...
 
EventLocation Location
 Represents the location of the key on the keyboard or other input device. More...
 
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. More...
 
bool IsNumPad
 Is it a key from the num-pad. More...
 
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). More...
 

Detailed Description

A keyboard event.

Member Enumeration Documentation

◆ EventLocation

Enumerator
Standard 
Left 
Right 
Numpad 

◆ EventType

Enumerator
Unknown 
KeyDown 
KeyUp 
Char 

Constructor & Destructor Documentation

◆ KeyEventData()

cohtml::KeyEventData::KeyEventData ( )
inline

Member Data Documentation

◆ IsAutoRepeat

bool cohtml::KeyEventData::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.

◆ IsNumPad

bool cohtml::KeyEventData::IsNumPad

Is it a key from the num-pad.

◆ IsSystemKey

bool cohtml::KeyEventData::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).

◆ KeyCode

int cohtml::KeyEventData::KeyCode

The key code.

◆ Location

EventLocation cohtml::KeyEventData::Location

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

◆ Modifiers

EventModifiersState cohtml::KeyEventData::Modifiers

The current key modifiers.

◆ Type

EventType cohtml::KeyEventData::Type

The type of the event.