utility 2026.1.9
A comprehensive C++ utilities library tailored for the development of modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
keyboard_event.cpp
1/*
2 Copyright (c) 2026 ETIB Corporation
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy of
5 this software and associated documentation files (the "Software"), to deal in
6 the Software without restriction, including without limitation the rights to
7 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
8 of the Software, and to permit persons to whom the Software is furnished to do
9 so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21 */
22
23#include "utility/event/keyboard_event.hpp"
24
25namespace utility::event
26{
27
28 KeyboardEvent::Factory::~Factory(void) = default;
29
30 std::shared_ptr<Event> KeyboardEvent::Factory::create(void) const
31 {
32 return std::make_unique<KeyboardEvent>();
33 }
34
35 std::shared_ptr<KeyboardEvent>
37 {
38 return std::make_unique<KeyboardEvent>();
39 }
40
41 KeyboardEvent::KeyboardEvent(void) = default;
42
43 KeyboardEvent::~KeyboardEvent(void) = default;
44
46 {
47 return _scancode;
48 }
49
51 {
52 _scancode = scancode;
53 return *this;
54 }
55
57 {
58 _keycode = keycode;
59 return *this;
60 }
61
63 {
64 return _keycode;
65 }
66
68 KeyboardEvent::setModifiers(const KeyModifiers modifiers) noexcept
69 {
70 _modifiers = std::bitset<sizeof(KeyModifiers) * 8>(
71 static_cast<std::size_t>(modifiers));
72 return *this;
73 }
74
75 bool
76 KeyboardEvent::isModifierSet(const KeyModifiers modifier) const noexcept
77 {
78 const auto mask = static_cast<std::size_t>(modifier);
79 if (mask == 0) {
80 return _modifiers.none();
81 }
82 return (_modifiers.to_ulong() & mask) != 0;
83 }
84
85 KeyboardEvent &KeyboardEvent::setIsDownEvent(const bool isDown) noexcept
86 {
87 isDownEvent = isDown;
88 return *this;
89 }
90
91 bool KeyboardEvent::getIsDownEvent(void) const noexcept
92 {
93 return isDownEvent;
94 }
95
96 KeyboardEvent &KeyboardEvent::setIsRepeatEvent(const bool isRepeat) noexcept
97 {
98 isRepeatEvent = isRepeat;
99 return *this;
100 }
101
102 bool KeyboardEvent::getIsRepeatEvent(void) const noexcept
103 {
104 return isRepeatEvent;
105 }
106
107} // namespace utility::event
std::shared_ptr< KeyboardEvent > createTyped(void) const
Create a strongly-typed KeyboardEvent.
std::shared_ptr< Event > create(void) const override
Create a KeyboardEvent as a base Event pointer.
Keyboard event representation.
bool isModifierSet(const KeyModifiers modifier) const noexcept
Check if a specific key modifier is set.
KeyboardEvent & setIsRepeatEvent(const bool isRepeat) noexcept
Set whether the event is a key repeat event.
KeyboardEvent & setModifiers(const KeyModifiers modifiers) noexcept
Set the key modifiers.
KeyboardEvent & setScancode(const ScanCode scancode) noexcept
Set the keyboard scancode.
bool getIsDownEvent(void) const noexcept
Check if the event is a key down event.
KeyboardEvent(void)
Default constructor.
bool getIsRepeatEvent(void) const noexcept
Check if the event is a key repeat event.
KeyCode
Virtual key codes derived from keyboard scancodes.
KeyboardEvent & setIsDownEvent(const bool isDown) noexcept
Set whether the event is a key down event.
ScanCode getScancode(void) const noexcept
Get the keyboard scancode.
KeyboardEvent & setKeycode(const KeyCode keycode) noexcept
Set the virtual key code.
~KeyboardEvent(void) override
Default destructor.
KeyCode getKeycode(void) const noexcept
Get the virtual key code.