KeyEvent Class Reference

Key event information. More...

List of all members.

Public Member Functions

 KeyEvent ()
 Constructor.
 KeyEvent (KeyType keyType, KeyEventType keyEventType, TimeSpan time, TimeSpan downTime)
 Constructor.
 KeyEvent (KeyType keyType, KeyEventType keyEventType, TimeSpan time, TimeSpan downTime, bool enabledEachFrame)
 Constructor.

Properties

KeyEventType KeyEventType [get, set]
 Obtains and sets the type of key event.
KeyType KeyType [get, set]
 Obtains and sets the type of key.
TimeSpan Time [get, set]
 Obtains and sets the time an event occurred.
TimeSpan DownTime [get, set]
 Obtains and sets the time a key was pressed.
bool Forward [get, set]
 Obtains and sets whether to forward the event.
bool Handled [get, set]
 Obtains and sets whether an event has been processed.
bool EnabledEachFrameRepeat [get, set]
 Obtains and sets whether to enable a key repeat event for each frame.

Detailed Description

Key event information.


Constructor & Destructor Documentation

KeyEvent ( KeyType  keyType,
KeyEventType  keyEventType,
TimeSpan  time,
TimeSpan  downTime 
)

Constructor.

Parameters:
keyTypeType of key
keyEventTypeType of key event
timeTime event occurred
downTimeTime key was pressed
KeyEvent ( KeyType  keyType,
KeyEventType  keyEventType,
TimeSpan  time,
TimeSpan  downTime,
bool  enabledEachFrame 
)

Constructor.

Parameters:
keyTypeType of key
keyEventTypeType of key event
timeTime event occurred
downTimeTime key was pressed
enabledEachFrame

Property Documentation

bool EnabledEachFrameRepeat [get, set]

Obtains and sets whether to enable a key repeat event for each frame.

When this value is set to true, KeyEventType is such that, from the next frame, the EachFrameRepeat event is distributed for each frame. This value is enabled only for the current KeyType, and the value is retained while the key is pressed, but it is reset to false when the key is released.

bool Forward [get, set]

Obtains and sets whether to forward the event.

Default value is False.