KeyboardEvent

class HPS.KeyboardEvent : public HPS.InputEvent

The KeyboardEvent class is the event generated for each key press and release.

Public Types

enum Action

Enumeration of various states keyboard codes can have for a KeyboardEvent.

Values:

None

Key is not currently pressed, nor was it just released.

KeyDown

Key was pressed.

KeyUp

Key was released.

Public Functions

override HPS.Event Clone ()

Allocates and returns a copy of this KeyboardEvent.

Return

A copy of this KeyboardEvent.

override void Dispose ()

override bool Equals (HPS.InputEvent in_that)

Check if the source object is equivalent to this object.

Param in_that

The source object to compare to this object.

Return

true if the objects are equivalent, false otherwise.

bool Equals (HPS.KeyboardEvent in_that)

Check if the source object is equivalent to this object.

Param in_that

The source object to compare to this object.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

KeyboardEvent ()

The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes.

KeyboardEvent (HPS.Event in_event)

This constructor converts an EventObject to a MouseEvent object.

Param in_event

The EventObject to be converted.

KeyboardEvent (HPS.KeyboardEvent in_that)

KeyboardEvent (HPS.KeyboardEvent.Action in_action)

This constructor creates a KeyboardEvent object for a given action without any keyboard codes.

Param in_action

Action of the keys for this KeyboardEvent.

KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.KeyboardCode[] in_keyboardcodes)

This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.

Param in_action

Action of the keys for this KeyboardEvent.

Param in_keyboardcodes

Array of the keyboard codes for this KeyboardEvent.

KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.KeyboardCode[] in_keyboardcodes, HPS.ModifierKeys in_modifiers)

This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.

Param in_action

Action of the keys for this KeyboardEvent.

Param in_keyboardcodes

Array of the keyboard codes for this KeyboardEvent.

Param in_modifiers

The modifier keys for this KeyboardEvent.

KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.ModifierKeys in_modifiers)

This constructor creates a KeyboardEvent object for a given action without any keyboard codes.

Param in_action

Action of the keys for this KeyboardEvent.

Param in_modifiers

The modifier keys for this KeyboardEvent.

void SetKeyboardCodes (HPS.KeyboardCode[] in_keyboardcodes)

Sets the keyboard codes for this KeyboardEvent.

Param in_keyboardcodes

Array of the keyboard codes for this KeyboardEvent.

Properties

HPS.KeyboardEvent.Action CurrentAction { get; set; }

HPS.KeyboardCode[] KeyboardCodes { get; set; }

Public Static Functions

bool operator!= (HPS.KeyboardEvent a, HPS.KeyboardEvent b)

bool operator== (HPS.KeyboardEvent a, HPS.KeyboardEvent b)