guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
checkbox.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#pragma once
23
24#include "guillaume/ecs/system_filler.hpp"
25
26#include "guillaume/components/checkbox.hpp"
27
28namespace guillaume::systems
29{
65 class Checkbox: public ecs::SystemFiller<components::Checkbox>
66 {
67 public:
72 Checkbox(void);
73
77 ~Checkbox(void) override = default;
78
103 static void install(ecs::ComponentRegistry &componentRegistry,
104 const ecs::Entity::Identifier &entityIdentifier);
105
135 static void apply(ecs::ComponentRegistry &componentRegistry,
136 const ecs::Entity::Identifier &entityIdentifier);
137
151 static void setState(ecs::ComponentRegistry &componentRegistry,
152 const ecs::Entity::Identifier &entityIdentifier,
154
169 static void toggle(ecs::ComponentRegistry &componentRegistry,
170 const ecs::Entity::Identifier &entityIdentifier);
171
179 static bool isDisabled(const ecs::ComponentRegistry &componentRegistry,
180 const ecs::Entity::Identifier &entityIdentifier);
181
187 void update(const ecs::Entity::Identifier &entityIdentifier) override;
188 };
189
190} // namespace guillaume::systems
Stores every component of a scene, per component type and per entity identifier, and knows which ones...
std::size_t Identifier
The key under which an entity's components are stored. Systems and components refer to entities by th...
Definition entity.hpp:86
The base class to derive a system from: a System whose signature is the list of component types given...
~Checkbox(void) override=default
Default destructor.
static void apply(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Draw one checkbox from its component: colors, accessibility and label position.
Definition checkbox.cpp:187
static void install(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Make an entity behave as a checkbox.
Definition checkbox.cpp:104
Checkbox(void)
Create the system for the Layout phase, matching entities that have a components::Checkbox.
Definition checkbox.cpp:99
static void setState(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, components::Checkbox::State state)
Set the state of a checkbox from code and show it at once.
Definition checkbox.cpp:156
static bool isDisabled(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Whether the checkbox ignores input and is drawn disabled.
Definition checkbox.cpp:146
void update(const ecs::Entity::Identifier &entityIdentifier) override
Frame entry point: call apply on one checkbox.
Definition checkbox.cpp:273
static void toggle(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Toggle the checkbox as a click does.
Definition checkbox.cpp:167
Rules. Every class here runs each frame on the entities that have the components it declares.