< Home

< Table of Contents

REFERENCE MANUAL

HPS.KeyboardEvent Class Reference

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

Inheritance diagram for HPS.KeyboardEvent:
HPS.InputEvent HPS.Event

Public Types

enum  Action { Action.None = 0, Action.KeyDown = 1, Action.KeyUp = 2 }
 Enumeration of various states keyboard codes can have for a KeyboardEvent. More...
 
- Public Types inherited from HPS.Event
enum  Status { Status.InProgress = 0, Status.Completed = 1, Status.Failed = 2 }
 Event Status - returned from a notifier to give the status of the event. More...
 

Public Member Functions

override HPS.Event Clone ()
 Allocates and returns a copy of this KeyboardEvent. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.KeyboardEvent in_that)
 Check if the source object is equivalent to this object. More...
 
override int GetHashCode ()
 
 KeyboardEvent ()
 The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes. More...
 
 KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.ModifierKeys in_modifiers)
 This constructor creates a KeyboardEvent object for a given action without any keyboard codes. More...
 
 KeyboardEvent (HPS.KeyboardEvent.Action in_action)
 This constructor creates a KeyboardEvent object for a given action without any keyboard codes. More...
 
 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. More...
 
 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. More...
 
 KeyboardEvent (HPS.Event in_event)
 This constructor converts an EventObject to a MouseEvent object. More...
 
 KeyboardEvent (HPS.KeyboardEvent in_that)
 
void SetKeyboardCodes (HPS.KeyboardCode[] in_keyboardcodes)
 Sets the keyboard codes for this KeyboardEvent. More...
 
- Public Member Functions inherited from HPS.InputEvent
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.InputEvent in_that)
 Check if the source object is equivalent to this object. More...
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierKeys ()
 Query whether a particular modifier key is active for this InputEvent. More...
 
 InputEvent ()
 This constructor creates a default InputEvent object. More...
 
 InputEvent (HPS.ModifierKeys in_modifiers)
 This constructor creates a new InputEvent with the specified modifier keys initialized. More...
 
 InputEvent (HPS.InputEvent in_that)
 
- Public Member Functions inherited from HPS.Event
virtual bool Drop (HPS.Event in_that_event)
 This optional function is used to determine if the current event can be dropped based on the following event in the queue. More...
 
delegate void DtorDelegate (IntPtr cPtr)
 
 Event (IntPtr in_channel)
 A constructor for generating events from built-in or custom event ID's. More...
 
 Event ()
 A constructor for generating events from built-in or custom event ID's. More...
 
 Event (HPS.Event in_that)
 
delegate IntPtr EventDelegate_0 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
virtual IntPtr Freshen ()
 This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available. More...
 
IntPtr GetChannel ()
 Returns the channel ID assigned to an event. More...
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 Returns the time an event was injected into the event queue. More...
 
bool IsConsumable ()
 Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More...
 

Static Public Member Functions

static bool operator!= (HPS.KeyboardEvent a, HPS.KeyboardEvent b)
 
static bool operator== (HPS.KeyboardEvent a, HPS.KeyboardEvent b)
 
- Static Public Member Functions inherited from HPS.InputEvent
static bool operator!= (HPS.InputEvent a, HPS.InputEvent b)
 
static bool operator== (HPS.InputEvent a, HPS.InputEvent b)
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Event
void DtorCallback (IntPtr p)
 
virtual IntPtr GetNonDirectorClassID ()
 

Properties

HPS.KeyboardEvent.Action CurrentAction [get, set]
 
HPS.KeyboardCode[] KeyboardCodes [get, set]
 
- Properties inherited from HPS.InputEvent
HPS.ModifierKeys ModifierKeyState [get, set]
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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

Member Enumeration Documentation

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

Enumerator
None 

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

KeyDown 

Key was pressed.

KeyUp 

Key was released.

Constructor & Destructor Documentation

HPS.KeyboardEvent.KeyboardEvent ( )

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

HPS.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.

Parameters
in_actionAction of the keys for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>.
HPS.KeyboardEvent.KeyboardEvent ( HPS.KeyboardEvent.Action  in_action)

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

Parameters
in_actionAction of the keys for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>.
HPS.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.

Parameters
in_actionAction of the keys for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>.
in_keyboardcode_countSize of the following array.
in_keyboardcodesArray of the keyboard codes for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>.
HPS.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.

Parameters
in_actionAction of the keys for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>.
in_keyboardcode_countSize of the following array.
in_keyboardcodesArray of the keyboard codes for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>.
HPS.KeyboardEvent.KeyboardEvent ( HPS.Event  in_event)

This constructor converts an EventObject to a MouseEvent object.

Parameters
in_eventThe <ref refid="class_h_p_s_1_1_event" kindref="compound">Event</ref><ref refid="class_h_p_s_1_1_object" kindref="compound">Object</ref> to be converted.

Member Function Documentation

override HPS.Event HPS.KeyboardEvent.Clone ( )
virtual

Allocates and returns a copy of this KeyboardEvent.

Returns
A copy of this KeyboardEvent.

Reimplemented from HPS.InputEvent.

virtual bool HPS.KeyboardEvent.Equals ( HPS.KeyboardEvent  in_that)
virtual

Check if the source object is equivalent to this object.

Returns
true if the objects are equivalent, false otherwise.
void HPS.KeyboardEvent.SetKeyboardCodes ( HPS.KeyboardCode[]  in_keyboardcodes)

Sets the keyboard codes for this KeyboardEvent.

Parameters
in_keyboardcode_countSize of the following array.
in_keyboardcodesArray of the keyboard codes for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>.

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