#include <hps.h>
|
enum | Modifiers {
_key_none = 0x0000,
_key_caps_lock = 0x0001,
_key_num_lock = 0x0002,
_key_scroll_lock = 0x0004,
_key_right_shift = 0x0008,
_key_left_shift = 0x0010,
_key_right_control = 0x0020,
_key_left_control = 0x0040,
_key_right_alt = 0x0080,
_key_left_alt = 0x0100,
_key_right_meta = 0x0200,
_key_left_meta = 0x0400,
_key_shift = _key_left_shift | _key_right_shift,
_key_control = _key_left_control | _key_right_control,
_key_alt = _key_left_alt | _key_right_alt,
_key_meta = _key_left_meta | _key_right_meta
} |
|
Various modifier keys that could be active for an InputEvent.
◆ Modifiers
Modifier key bitfield constants.
◆ ModifierKeys()
HPS::ModifierKeys::ModifierKeys |
( |
| ) |
|
|
inline |
The default constructor creates a ModifierKeys object with no modifiers active.
◆ Alt() [1/2]
bool HPS::ModifierKeys::Alt |
( |
| ) |
const |
|
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_state | true if at least one alt key (right or left) is active, false otherwise. |
◆ CapsLock() [1/2]
bool HPS::ModifierKeys::CapsLock |
( |
| ) |
const |
|
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_state | true if the caps lock key is active, false otherwise. |
◆ Control() [1/2]
bool HPS::ModifierKeys::Control |
( |
| ) |
const |
|
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_state | true if at least one control key (right or left) is active, false otherwise. |
◆ Equals()
bool HPS::ModifierKeys::Equals |
( |
ModifierKeys const & |
in_that | ) |
const |
|
inline |
Check if the source object is equivalent to this object.
- Parameters
-
in_that | The source object to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
◆ HasAll()
bool HPS::ModifierKeys::HasAll |
( |
ModifierKeys const & |
in_keys | ) |
const |
|
inline |
Indicates whether all modifiers of the input parameter are present in this object.
- Parameters
-
in_keys | A collection of modifiers to check against this object. |
- Returns
- true if all of the input modifiers are active, false otherwise.
◆ HasAny()
bool HPS::ModifierKeys::HasAny |
( |
ModifierKeys const & |
in_keys | ) |
const |
|
inline |
Indicates whether any modifiers of the input parameter are present in this object.
- Parameters
-
in_keys | A collection of modifiers to check against this object. |
- Returns
- true if any of the modifiers are active, false otherwise.
◆ 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
- Returns
- A new ModifierKeys object with the alt key active.
◆ KeyCapsLock()
Creates a new ModifierKeys object with the caps lock key active.
- Returns
- A new ModifierKeys object with the caps lock key active.
◆ 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
- Returns
- A new ModifierKeys object with the control key active.
◆ KeyLeftAlt()
Creates a new ModifierKeys object with the left alt key active.
- Returns
- A new ModifierKeys object with the left alt key active.
◆ KeyLeftControl()
Creates a new ModifierKeys object with the left control key active.
- Returns
- A new ModifierKeys object with the left control key active.
◆ KeyLeftMeta()
Creates a new ModifierKeys object with the left meta key active.
- Returns
- A new ModifierKeys object with the left meta key active.
◆ KeyLeftShift()
Creates a new ModifierKeys object with the left shift key active.
- Returns
- A new ModifierKeys object with the left shift key active.
◆ 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
- Returns
- A new ModifierKeys object with the meta key active.
◆ KeyNumLock()
Creates a new ModifierKeys object with the num lock key active.
- Returns
- A new ModifierKeys object with the num lock key active.
◆ KeyRightAlt()
Creates a new ModifierKeys object with the right alt key active.
- Returns
- A new ModifierKeys object with the right alt key active.
◆ KeyRightControl()
Creates a new ModifierKeys object with the right control key active.
- Returns
- A new ModifierKeys object with the right control key active.
◆ KeyRightMeta()
Creates a new ModifierKeys object with the right meta key active.
- Returns
- A new ModifierKeys object with the right meta key active.
◆ KeyRightShift()
Creates a new ModifierKeys object with the right shift key active.
- Returns
- A new ModifierKeys object with the right shift key active.
◆ KeyScrollLock()
Creates a new ModifierKeys object with the scroll lock key active.
- Returns
- A new ModifierKeys object with the scroll lock key active.
◆ 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
- Returns
- A new ModifierKeys object with the shift key active.
◆ LeftAlt() [1/2]
bool HPS::ModifierKeys::LeftAlt |
( |
| ) |
const |
|
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_state | true if the left alt key is active, false otherwise. |
◆ LeftControl() [1/2]
bool HPS::ModifierKeys::LeftControl |
( |
| ) |
const |
|
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_state | true if the left control key is active, false otherwise. |
◆ LeftMeta() [1/2]
bool HPS::ModifierKeys::LeftMeta |
( |
| ) |
const |
|
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_state | true if the left meta key is active, false otherwise. |
◆ LeftShift() [1/2]
bool HPS::ModifierKeys::LeftShift |
( |
| ) |
const |
|
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_state | true if the left shift key is active, false otherwise. |
◆ Meta() [1/2]
bool HPS::ModifierKeys::Meta |
( |
| ) |
const |
|
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_state | true if at least one meta key (right or left) is active, false otherwise. |
◆ None()
bool HPS::ModifierKeys::None |
( |
| ) |
const |
|
inline |
Indicates whether no modifiers are active.
- Returns
- true if no modifier keys are active, false otherwise.
◆ NumLock() [1/2]
bool HPS::ModifierKeys::NumLock |
( |
| ) |
const |
|
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_state | true if the num lock key is active, false otherwise. |
◆ operator!=()
bool HPS::ModifierKeys::operator!= |
( |
ModifierKeys const & |
in_that | ) |
const |
|
inline |
Check if the source object is not equivalent to this object.
- Parameters
-
in_that | The source object to compare to this object. |
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator+()
Merges the buttons from two ModifierKeys objects.
- Parameters
-
in_modifiers_to_merge | A collection of modifiers to merge with the modifiers of this object. |
- Returns
- A new ModifierKeys object.
◆ operator+=()
Merges the modifiers from another ModifierKeys object into this one.
- Parameters
-
in_modifiers_to_merge | A collection of modifiers to merge with the modifiers of this object. |
- Returns
- A reference to this object.
◆ operator-()
Creates a new ModifierKeys object representing the removal of the modifiers of another ModifierKeys object from this object.
- Parameters
-
in_modifiers_to_remove | A collection of modifiers to remove from those of this object. |
- Returns
- A new ModifierKeys object.
◆ operator-=()
Removes the modifiers of another ModifierKeys object from this one.
- Parameters
-
in_modifiers_to_remove | A collection of modifiers to remove from those of this object. |
- Returns
- A reference to this object.
◆ operator==()
bool HPS::ModifierKeys::operator== |
( |
ModifierKeys const & |
in_that | ) |
const |
|
inline |
Check if the source object is equivalent to this object.
- Parameters
-
in_that | The source object to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
◆ RightAlt() [1/2]
bool HPS::ModifierKeys::RightAlt |
( |
| ) |
const |
|
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_state | true if the right alt key is active, false otherwise. |
◆ RightControl() [1/2]
bool HPS::ModifierKeys::RightControl |
( |
| ) |
const |
|
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_state | true if the right control key is active, false otherwise. |
◆ RightMeta() [1/2]
bool HPS::ModifierKeys::RightMeta |
( |
| ) |
const |
|
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_state | true if the right meta key is active, false otherwise. |
◆ RightShift() [1/2]
bool HPS::ModifierKeys::RightShift |
( |
| ) |
const |
|
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_state | true if the right shift key is active, false otherwise. |
◆ ScrollLock() [1/2]
bool HPS::ModifierKeys::ScrollLock |
( |
| ) |
const |
|
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_state | true if the scroll lock key is active, false otherwise. |
◆ Shift() [1/2]
bool HPS::ModifierKeys::Shift |
( |
| ) |
const |
|
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_state | true if at least one shift key (right or left) is active, false otherwise. |
The documentation for this class was generated from the following file: