guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
focus.hpp
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#pragma once
24
25#include <functional>
26
27#include "guillaume/ecs/component.hpp"
28
30{
31
56 class Focus: public ecs::Component
57 {
58 public:
59 using Handler = std::function<void(void)>;
60
61 private:
62 Handler _onFocusGained;
63 Handler _onFocusLost;
64 bool _focused { false };
65
66 public:
70 Focus(void) = default;
71
75 ~Focus(void) = default;
76
86 void setOnFocusGainedHandler(const Handler &handler);
87
93
102 void setOnFocusLostHandler(const Handler &handler);
103
108 Handler getOnFocusLostHandler(void) const;
109
114 bool isFocused(void) const;
115
125 void setFocused(bool focused);
126 };
127
128} // namespace guillaume::components
std::function< void(void)> Handler
Focus change callback.
Definition focus.hpp:59
Focus(void)=default
Construct an unfocused component without handler.
void setOnFocusLostHandler(const Handler &handler)
Store the callback run when the entity loses the focus.
Definition focus.cpp:38
bool isFocused(void) const
Check whether the entity owns the input focus.
Definition focus.cpp:48
~Focus(void)=default
Default destructor.
Handler getOnFocusLostHandler(void) const
Get the callback run when the entity loses the focus.
Definition focus.cpp:44
Handler getOnFocusGainedHandler(void) const
Get the callback run when the entity gains the focus.
Definition focus.cpp:33
void setFocused(bool focused)
Record whether the entity owns the input focus.
Definition focus.cpp:53
void setOnFocusGainedHandler(const Handler &handler)
Store the callback run when the entity gains the focus.
Definition focus.cpp:27
Base class of every component: a piece of state attached to an entity, plus a "changed" flag.
Definition component.hpp:72
State. Every class here is plain data attached to an entity.