ModifierKeys

struct HPS.ModifierKeys

Public Functions

bool Alt ()

Indicates whether any alt key (right or left) is active.

Return:

true if any alt key is active, false otherwise.

void Alt (bool in_state)

Sets the state of the alt key modifier

Param in_state:

true if at least one alt key (right or left) is active, false otherwise.

bool CapsLock ()

Indicates whether the caps lock button is active

Return:

true if the caps lock key is active, false otherwise.

void CapsLock (bool in_state)

Sets the state of the caps lock key modifier

Param in_state:

true if the caps lock key is active, false otherwise.

bool Control ()

Indicates whether any control key (right or left) is active.

Return:

true if any control key is active, false otherwise.

void Control (bool in_state)

Sets the state of the control key modifier

Param in_state:

true if at least one control key (right or left) is active, false otherwise.

bool Equals (ModifierKeys 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)

Check if the source object is equivalent to this object.

Param obj:

The source object to compare to this object.

Return:

true if the objects are equivalent, false otherwise.

override int GetHashCode ()

bool LeftAlt ()

Indicates whether the left alt button is active

Return:

true if the left alt key is active, false otherwise.

void LeftAlt (bool in_state)

Sets the state of the left alt key modifier

Param in_state:

true if the left alt key is active, false otherwise.

bool LeftControl ()

Indicates whether the left control button is active

Return:

true if the left control key is active, false otherwise.

void LeftControl (bool in_state)

Sets the state of the left control key modifier

Param in_state:

true if the left control key is active, false otherwise.

bool LeftMeta ()

Indicates whether the left meta button is active

Return:

true if the left meta key is active, false< /span> otherwise.

void LeftMeta (bool in_state)

Sets the state of the left meta key modifier

Param in_state:

true if the left meta key is active, false otherwise.

bool LeftShift ()

Indicates whether the left shift button is active

Return:

true if the left shift key is active, false otherwise.

void LeftShift (bool in_state)

Sets the state of the left shift key modifier

Param in_state:

true if the left shift key is active, false otherwise.

bool Meta ()

Indicates whether any meta key (right or left) is active.

Return:

true if any meta key is active, false otherwise.

void Meta (bool in_state)

Sets the state of the meta key modifier

Param in_state:

true if at least one meta key (right or left) is active, false otherwise.

ModifierKeys (ModifierKeys other)

The default constructor creates a ModifierKeys object with no modifiers active.

bool None ()

Indicates whether no modifiers are active.

Return:

true if no modifier keys are active, false otherwise.

bool NumLock ()

Indicates whether the num lock button is active

Return:

true if the num lock key is active, false otherwise.

void NumLock (bool in_state)

Sets the state of the num lock key modifier

Param in_state:

true if the num lock key is active, false otherwise.

bool RightAlt ()

Indicates whether the right alt button is active

Return:

true if the right alt key is active, false otherwise.

void RightAlt (bool in_state)

Sets the state of the right alt key modifier

Param in_state:

true if the right alt key is active, false otherwise.

bool RightControl ()

Indicates whether the right control button is active

Return:

true if the right control key is active, false otherwise.

void RightControl (bool in_state)

Sets the state of the right control key modifier

Param in_state:

true if the right control key is active, false otherwise.

bool RightMeta ()

Indicates whether the right meta button is active

Return:

true if the right meta key is active, false< /span> otherwise.

void RightMeta (bool in_state)

Sets the state of the right meta key modifier

Param in_state:

true if the right meta key is active, false otherwise.

bool RightShift ()

Indicates whether the right shift button is active

Return:

true if the right shift key is active, false otherwise.

void RightShift (bool in_state)

Sets the state of the right shift key modifier

Param in_state:

true if the right shift key is active, false otherwise.

bool ScrollLock ()

Indicates whether the scroll lock button is active

Return:

true if the scroll lock key is active, false otherwise.

void ScrollLock (bool in_state)

Sets the state of the scroll lock key modifier

Param in_state:

true if the scroll lock key is active, false otherwise.

bool Shift ()

Indicates whether any shift key (right or left) is active.

Return:

true if any shift key is active, false otherwise.

void Shift (bool in_state)

Sets the state of the shift key modifier

Param in_state:

true if at least one shift key (right or left) is active, false otherwise.

Public Static Functions

ModifierKeys KeyAlt ()

Creates a new ModifierKeys object with the alt key active. Use this function if your application does not need to differentiate between left and right alt buttons

Return:

A new ModifierKeys object with the alt key active.

ModifierKeys KeyCapsLock ()

Creates a new ModifierKeys object with the caps lock key active.

Return:

A new ModifierKeys object with the caps lock key active.

ModifierKeys KeyControl ()

Creates a new ModifierKeys object with the control key active. Use this function if your application does not need to differentiate between left and right control buttons

Return:

A new ModifierKeys object with the control key active.

ModifierKeys KeyLeftAlt ()

Creates a new ModifierKeys object with the left alt key active.

Return:

A new ModifierKeys object with the left alt key active.

ModifierKeys KeyLeftControl ()

Creates a new ModifierKeys object with the left control key active.

Return:

A new ModifierKeys object with the left control key active.

ModifierKeys KeyLeftMeta ()

Creates a new ModifierKeys object with the left meta key active.

Return:

A new ModifierKeys object with the left meta key active.

ModifierKeys KeyLeftShift ()

Creates a new ModifierKeys object with the left shift key active.

Return:

A new ModifierKeys object with the left shift key active.

ModifierKeys KeyMeta ()

Creates a new ModifierKeys object with the meta key active. Use this function if your application does not need to differentiate between left and right meta buttons

Return:

A new ModifierKeys object with the meta key active.

ModifierKeys KeyNumLock ()

Creates a new ModifierKeys object with the num lock key active.

Return:

A new ModifierKeys object with the num lock key active.

ModifierKeys KeyRightAlt ()

Creates a new ModifierKeys object with the right alt key active.

Return:

A new ModifierKeys object with the right alt key active.

ModifierKeys KeyRightControl ()

Creates a new ModifierKeys object with the right control key active.

Return:

A new ModifierKeys object with the right control key active.

ModifierKeys KeyRightMeta ()

Creates a new ModifierKeys object with the right meta key active.

Return:

A new ModifierKeys object with the right meta key active.

ModifierKeys KeyRightShift ()

Creates a new ModifierKeys object with the right shift key active.

Return:

A new ModifierKeys object with the right shift key active.

ModifierKeys KeyScrollLock ()

Creates a new ModifierKeys object with the scroll lock key active.

Return:

A new ModifierKeys object with the scroll lock key active.

ModifierKeys KeyShift ()

Creates a new ModifierKeys object with the shift key active. Use this function if your application does not need to differentiate between left and right shift buttons

Return:

A new ModifierKeys object with the shift key active.

bool operator!= (ModifierKeys b1, ModifierKeys b2)

Check if the source object is not equivalent to this object.

Param b1:

The source object to compare to this object.

Param b2:

The source object to compare to this object.

Return:

true if the objects are not equivalent, false otherwise.

ModifierKeys operator+ (ModifierKeys b1, ModifierKeys b2)

Merges the buttons from two ModifierKeys objects.

Param b1:

A collection of modifiers to merge with the modifiers of parameter b2.

Param b2:

A collection of modifiers to merge with the modifiers of parameter b1.

Return:

A new ModifierKeys object.

ModifierKeys operator- (ModifierKeys b1, ModifierKeys b2)

Creates a new ModifierKeys object representing the removal of the modifiers of another ModifierKeys object from this object.

Param b1:

A collection of modifiers to remove from those of parameter b2.

Param b2:

A collection of modifiers to remove from those of parameter b1.

Return:

A new ModifierKeys object.

bool operator== (ModifierKeys b1, ModifierKeys b2)

Check if the source object is equivalent to this object.

Param b1:

The first object to compare

Param b2:

The second object to compare

Return:

true if the objects are equivalent, false otherwise.