guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
style_state.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 <cstdint>
26#include <optional>
27
28#include "guillaume/ecs/component.hpp"
29#include "guillaume/theme/tokens.hpp"
30
32{
33
60 {
61 public:
65 StyleState(void) = default;
66
70 ~StyleState(void) = default;
71
76 bool isEnabled(void) const;
77
88 StyleState &setEnabled(bool enabled);
89
95 bool isHovered(void) const;
96
107 StyleState &setHovered(bool hovered);
108
114 bool isPressed(void) const;
115
126 StyleState &setPressed(bool pressed);
127
132 bool isFocused(void) const;
133
144 StyleState &setFocused(bool focused);
145
150 bool isDragged(void) const;
151
162 StyleState &setDragged(bool dragged);
163
173 std::optional<theme::StateLayer> getActiveLayer(void) const;
174
175 private:
176 bool _enabled { true };
177 bool _hovered { false };
178 bool _pressed { false };
179 bool _focused { false };
180 bool _dragged { false };
181
187 void setFlag(bool &flag, bool value);
188 };
189
190} // namespace guillaume::components
StyleState(void)=default
Construct an enabled, idle state.
bool isHovered(void) const
Check whether the mouse pointer or a hand ray is over the entity.
bool isDragged(void) const
Check whether a drag gesture is in progress on the entity.
~StyleState(void)=default
Default destructor.
bool isFocused(void) const
Check whether the entity owns the input focus.
StyleState & setFocused(bool focused)
Record whether the entity owns the input focus.
std::optional< theme::StateLayer > getActiveLayer(void) const
Get the Material 3 state layer to paint over the entity.
bool isEnabled(void) const
Check whether the entity accepts interaction.
StyleState & setEnabled(bool enabled)
Enable or disable the entity.
bool isPressed(void) const
Check whether the entity is pressed: the left mouse button or hand button A is held on it,...
StyleState & setPressed(bool pressed)
Record whether the entity is pressed.
StyleState & setDragged(bool dragged)
Record whether the entity is being dragged.
StyleState & setHovered(bool hovered)
Record whether the entity is hovered.
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.