Public Member Functions

bool Alt ()
 
void Alt (bool in_state)
 
bool CapsLock ()
 
void CapsLock (bool in_state)
 
bool Control ()
 
void Control (bool in_state)
 
override bool Equals (object obj)
 
bool Equals (ModifierKeys in_that)
 
override int GetHashCode ()
 
bool LeftAlt ()
 
void LeftAlt (bool in_state)
 
bool LeftControl ()
 
void LeftControl (bool in_state)
 
bool LeftMeta ()
 
void LeftMeta (bool in_state)
 
bool LeftShift ()
 
void LeftShift (bool in_state)
 
bool Meta ()
 
void Meta (bool in_state)
 
 ModifierKeys (ModifierKeys other)
 
bool None ()
 
bool NumLock ()
 
void NumLock (bool in_state)
 
bool RightAlt ()
 
void RightAlt (bool in_state)
 
bool RightControl ()
 
void RightControl (bool in_state)
 
bool RightMeta ()
 
void RightMeta (bool in_state)
 
bool RightShift ()
 
void RightShift (bool in_state)
 
bool ScrollLock ()
 
void ScrollLock (bool in_state)
 
bool Shift ()
 
void Shift (bool in_state)
 

Static Public Member Functions

static ModifierKeys KeyAlt ()
 
static ModifierKeys KeyCapsLock ()
 
static ModifierKeys KeyControl ()
 
static ModifierKeys KeyLeftAlt ()
 
static ModifierKeys KeyLeftControl ()
 
static ModifierKeys KeyLeftMeta ()
 
static ModifierKeys KeyLeftShift ()
 
static ModifierKeys KeyMeta ()
 
static ModifierKeys KeyNumLock ()
 
static ModifierKeys KeyRightAlt ()
 
static ModifierKeys KeyRightControl ()
 
static ModifierKeys KeyRightMeta ()
 
static ModifierKeys KeyRightShift ()
 
static ModifierKeys KeyScrollLock ()
 
static ModifierKeys KeyShift ()
 
static bool operator!= (ModifierKeys b1, ModifierKeys b2)
 
static ModifierKeys operator+ (ModifierKeys b1, ModifierKeys b2)
 
static ModifierKeys operator- (ModifierKeys b1, ModifierKeys b2)
 
static bool operator== (ModifierKeys b1, ModifierKeys b2)
 

Constructor & Destructor Documentation

◆ ModifierKeys()

HPS.ModifierKeys.ModifierKeys ( ModifierKeys  other)
inline

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

Member Function Documentation

◆ Alt() [1/2]

bool HPS.ModifierKeys.Alt ( )
inline

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

Returns
true if any alt key is active, false otherwise.

◆ Alt() [2/2]

void HPS.ModifierKeys.Alt ( bool  in_state)
inline

Sets the state of the alt key modifier

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

◆ CapsLock() [1/2]

bool HPS.ModifierKeys.CapsLock ( )
inline

Indicates whether the caps lock button is active

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

◆ CapsLock() [2/2]

void HPS.ModifierKeys.CapsLock ( bool  in_state)
inline

Sets the state of the caps lock key modifier

Parameters
in_statetrue if the caps lock key is active, false otherwise.

◆ Control() [1/2]

bool HPS.ModifierKeys.Control ( )
inline

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

Returns
true if any control key is active, false otherwise.

◆ Control() [2/2]

void HPS.ModifierKeys.Control ( bool  in_state)
inline

Sets the state of the control key modifier

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

◆ Equals() [1/2]

override bool HPS.ModifierKeys.Equals ( object  obj)
inline

Check if the source object is equivalent to this object.

Parameters
objThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Equals() [2/2]

bool HPS.ModifierKeys.Equals ( ModifierKeys  in_that)
inline

Check if the source object is equivalent to this object.

Parameters
in_thatThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ KeyAlt()

static ModifierKeys HPS.ModifierKeys.KeyAlt ( )
inlinestatic

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

Returns
A new ModifierKeys object with the alt key active.

◆ KeyCapsLock()

static ModifierKeys HPS.ModifierKeys.KeyCapsLock ( )
inlinestatic

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

Returns
A new ModifierKeys object with the caps lock key active.

◆ KeyControl()

static ModifierKeys HPS.ModifierKeys.KeyControl ( )
inlinestatic

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

Returns
A new ModifierKeys object with the control key active.

◆ KeyLeftAlt()

static ModifierKeys HPS.ModifierKeys.KeyLeftAlt ( )
inlinestatic

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

Returns
A new ModifierKeys object with the left alt key active.

◆ KeyLeftControl()

static ModifierKeys HPS.ModifierKeys.KeyLeftControl ( )
inlinestatic

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

Returns
A new ModifierKeys object with the left control key active.

◆ KeyLeftMeta()

static ModifierKeys HPS.ModifierKeys.KeyLeftMeta ( )
inlinestatic

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

Returns
A new ModifierKeys object with the left meta key active.

◆ KeyLeftShift()

static ModifierKeys HPS.ModifierKeys.KeyLeftShift ( )
inlinestatic

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

Returns
A new ModifierKeys object with the left shift key active.

◆ KeyMeta()

static ModifierKeys HPS.ModifierKeys.KeyMeta ( )
inlinestatic

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

Returns
A new ModifierKeys object with the meta key active.

◆ KeyNumLock()

static ModifierKeys HPS.ModifierKeys.KeyNumLock ( )
inlinestatic

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

Returns
A new ModifierKeys object with the num lock key active.

◆ KeyRightAlt()

static ModifierKeys HPS.ModifierKeys.KeyRightAlt ( )
inlinestatic

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

Returns
A new ModifierKeys object with the right alt key active.

◆ KeyRightControl()

static ModifierKeys HPS.ModifierKeys.KeyRightControl ( )
inlinestatic

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

Returns
A new ModifierKeys object with the right control key active.

◆ KeyRightMeta()

static ModifierKeys HPS.ModifierKeys.KeyRightMeta ( )
inlinestatic

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

Returns
A new ModifierKeys object with the right meta key active.

◆ KeyRightShift()

static ModifierKeys HPS.ModifierKeys.KeyRightShift ( )
inlinestatic

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

Returns
A new ModifierKeys object with the right shift key active.

◆ KeyScrollLock()

static ModifierKeys HPS.ModifierKeys.KeyScrollLock ( )
inlinestatic

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

Returns
A new ModifierKeys object with the scroll lock key active.

◆ KeyShift()

static ModifierKeys HPS.ModifierKeys.KeyShift ( )
inlinestatic

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

Returns
A new ModifierKeys object with the shift key active.

◆ LeftAlt() [1/2]

bool HPS.ModifierKeys.LeftAlt ( )
inline

Indicates whether the left alt button is active

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

◆ LeftAlt() [2/2]

void HPS.ModifierKeys.LeftAlt ( bool  in_state)
inline

Sets the state of the left alt key modifier

Parameters
in_statetrue if the left alt key is active, false otherwise.

◆ LeftControl() [1/2]

bool HPS.ModifierKeys.LeftControl ( )
inline

Indicates whether the left control button is active

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

◆ LeftControl() [2/2]

void HPS.ModifierKeys.LeftControl ( bool  in_state)
inline

Sets the state of the left control key modifier

Parameters
in_statetrue if the left control key is active, false otherwise.

◆ LeftMeta() [1/2]

bool HPS.ModifierKeys.LeftMeta ( )
inline

Indicates whether the left meta button is active

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

◆ LeftMeta() [2/2]

void HPS.ModifierKeys.LeftMeta ( bool  in_state)
inline

Sets the state of the left meta key modifier

Parameters
in_statetrue if the left meta key is active, false otherwise.

◆ LeftShift() [1/2]

bool HPS.ModifierKeys.LeftShift ( )
inline

Indicates whether the left shift button is active

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

◆ LeftShift() [2/2]

void HPS.ModifierKeys.LeftShift ( bool  in_state)
inline

Sets the state of the left shift key modifier

Parameters
in_statetrue if the left shift key is active, false otherwise.

◆ Meta() [1/2]

bool HPS.ModifierKeys.Meta ( )
inline

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

Returns
true if any meta key is active, false otherwise.

◆ Meta() [2/2]

void HPS.ModifierKeys.Meta ( bool  in_state)
inline

Sets the state of the meta key modifier

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

◆ None()

bool HPS.ModifierKeys.None ( )
inline

Indicates whether no modifiers are active.

Returns
true if no modifier keys are active, false otherwise.

◆ NumLock() [1/2]

bool HPS.ModifierKeys.NumLock ( )
inline

Indicates whether the num lock button is active

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

◆ NumLock() [2/2]

void HPS.ModifierKeys.NumLock ( bool  in_state)
inline

Sets the state of the num lock key modifier

Parameters
in_statetrue if the num lock key is active, false otherwise.

◆ operator!=()

static bool HPS.ModifierKeys.operator!= ( ModifierKeys  b1,
ModifierKeys  b2 
)
inlinestatic

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

Parameters
b1The source object to compare to this object.
b2The source object to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator+()

static ModifierKeys HPS.ModifierKeys.operator+ ( ModifierKeys  b1,
ModifierKeys  b2 
)
inlinestatic

Merges the buttons from two ModifierKeys objects.

Parameters
b1A collection of modifiers to merge with the modifiers of parameter b2.
b2A collection of modifiers to merge with the modifiers of parameter b1.
Returns
A new ModifierKeys object.

◆ operator-()

static ModifierKeys HPS.ModifierKeys.operator- ( ModifierKeys  b1,
ModifierKeys  b2 
)
inlinestatic

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

Parameters
b1A collection of modifiers to remove from those of parameter b2.
b2A collection of modifiers to remove from those of parameter b1.
Returns
A new ModifierKeys object.

◆ operator==()

static bool HPS.ModifierKeys.operator== ( ModifierKeys  b1,
ModifierKeys  b2 
)
inlinestatic

Check if the source object is equivalent to this object.

Parameters
b1The first object to compare
b2The second object to compare
Returns
true if the objects are equivalent, false otherwise.

◆ RightAlt() [1/2]

bool HPS.ModifierKeys.RightAlt ( )
inline

Indicates whether the right alt button is active

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

◆ RightAlt() [2/2]

void HPS.ModifierKeys.RightAlt ( bool  in_state)
inline

Sets the state of the right alt key modifier

Parameters
in_statetrue if the right alt key is active, false otherwise.

◆ RightControl() [1/2]

bool HPS.ModifierKeys.RightControl ( )
inline

Indicates whether the right control button is active

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

◆ RightControl() [2/2]

void HPS.ModifierKeys.RightControl ( bool  in_state)
inline

Sets the state of the right control key modifier

Parameters
in_statetrue if the right control key is active, false otherwise.

◆ RightMeta() [1/2]

bool HPS.ModifierKeys.RightMeta ( )
inline

Indicates whether the right meta button is active

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

◆ RightMeta() [2/2]

void HPS.ModifierKeys.RightMeta ( bool  in_state)
inline

Sets the state of the right meta key modifier

Parameters
in_statetrue if the right meta key is active, false otherwise.

◆ RightShift() [1/2]

bool HPS.ModifierKeys.RightShift ( )
inline

Indicates whether the right shift button is active

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

◆ RightShift() [2/2]

void HPS.ModifierKeys.RightShift ( bool  in_state)
inline

Sets the state of the right shift key modifier

Parameters
in_statetrue if the right shift key is active, false otherwise.

◆ ScrollLock() [1/2]

bool HPS.ModifierKeys.ScrollLock ( )
inline

Indicates whether the scroll lock button is active

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

◆ ScrollLock() [2/2]

void HPS.ModifierKeys.ScrollLock ( bool  in_state)
inline

Sets the state of the scroll lock key modifier

Parameters
in_statetrue if the scroll lock key is active, false otherwise.

◆ Shift() [1/2]

bool HPS.ModifierKeys.Shift ( )
inline

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

Returns
true if any shift key is active, false otherwise.

◆ Shift() [2/2]

void HPS.ModifierKeys.Shift ( bool  in_state)
inline

Sets the state of the shift key modifier

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

The documentation for this struct was generated from the following file:
  • internals/hps_core/source/cs/HPS.ModifierKeys.cs