guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
checkbox.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 "guillaume/components/checkbox.hpp"
24
25#include <utility>
26
28{
30 {
31 return _state;
32 }
33
35 {
36 if (_state != state) {
37 _state = state;
38 setHasChanged(true);
39 }
40 return *this;
41 }
42
44 {
45 return _variant;
46 }
47
49 {
50 if (_variant != variant) {
51 _variant = variant;
52 setHasChanged(true);
53 }
54 return *this;
55 }
56
57 const std::string &Checkbox::getLabel(void) const noexcept
58 {
59 return _label;
60 }
61
62 Checkbox &Checkbox::setLabel(const std::string &label)
63 {
64 if (_label != label) {
65 _label = label;
66 setHasChanged(true);
67 }
68 return *this;
69 }
70
72 {
73 return _checkIcon;
74 }
75
77 {
78 if (_checkIcon != identifier) {
79 _checkIcon = identifier;
80 setHasChanged(true);
81 }
82 return *this;
83 }
84
86 {
87 return _labelEntity;
88 }
89
91 {
92 if (_labelEntity != identifier) {
93 _labelEntity = identifier;
94 setHasChanged(true);
95 }
96 return *this;
97 }
98
99 const std::optional<utility::graphic::Color32Bit> &
100 Checkbox::getCheckedColor(void) const noexcept
101 {
102 return _checkedColor;
103 }
104
106 std::optional<utility::graphic::Color32Bit> color)
107 {
108 if (_checkedColor != color) {
109 _checkedColor = color;
110 setHasChanged(true);
111 }
112 return *this;
113 }
114
115 const std::optional<utility::graphic::Color32Bit> &
116 Checkbox::getUncheckedColor(void) const noexcept
117 {
118 return _uncheckedColor;
119 }
120
122 std::optional<utility::graphic::Color32Bit> color)
123 {
124 if (_uncheckedColor != color) {
125 _uncheckedColor = color;
126 setHasChanged(true);
127 }
128 return *this;
129 }
130
132 Checkbox::getOnValueChange(void) const noexcept
133 {
134 return _onValueChange;
135 }
136
138 {
139 _onValueChange = std::move(handler);
140 return *this;
141 }
142} // namespace guillaume::components
const std::optional< utility::graphic::Color32Bit > & getCheckedColor(void) const noexcept
Get the color that replaces the themed fill of a checked box.
Definition checkbox.cpp:100
Checkbox & setLabelEntity(ecs::Entity::Identifier identifier)
Record which child entity draws the label.
Definition checkbox.cpp:90
Variant getVariant(void) const noexcept
Get the visual variant.
Definition checkbox.cpp:43
Checkbox & setVariant(Variant variant)
Choose the visual variant.
Definition checkbox.cpp:48
Checkbox & setLabel(const std::string &label)
Set the label text.
Definition checkbox.cpp:62
Checkbox & setCheckedColor(std::optional< utility::graphic::Color32Bit > color)
Replace the themed fill of a checked or indeterminate box.
Definition checkbox.cpp:105
Checkbox & setCheckIcon(ecs::Entity::Identifier identifier)
Record which child entity draws the check glyph.
Definition checkbox.cpp:76
ecs::Entity::Identifier getLabelEntity(void) const noexcept
Get the child entity that draws the label.
Definition checkbox.cpp:85
std::function< void(State)> ValueChangeHandler
Called with the new state when the user toggles the box.
Definition checkbox.hpp:83
ecs::Entity::Identifier getCheckIcon(void) const noexcept
Get the child entity that draws the check glyph.
Definition checkbox.cpp:71
State getState(void) const noexcept
Get the checked state.
Definition checkbox.cpp:29
Checkbox & setState(State state)
Store the checked state.
Definition checkbox.cpp:34
const std::optional< utility::graphic::Color32Bit > & getUncheckedColor(void) const noexcept
Get the color that replaces the themed outline of an unchecked box.
Definition checkbox.cpp:116
const std::string & getLabel(void) const noexcept
Get the label text.
Definition checkbox.cpp:57
Checkbox & setUncheckedColor(std::optional< utility::graphic::Color32Bit > color)
Replace the themed outline of an unchecked box.
Definition checkbox.cpp:121
Checkbox & setOnValueChange(ValueChangeHandler handler)
Set the callback run when the user toggles the box.
Definition checkbox.cpp:137
const ValueChangeHandler & getOnValueChange(void) const noexcept
Get the callback run when the user toggles the box.
Definition checkbox.cpp:132
Checkbox(void)=default
Create the state of an enabled, unchecked checkbox with no label.
void setHasChanged(bool hasChanged)
Raise or lower the changed flag.
Definition component.cpp:32
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
State. Every class here is plain data attached to an entity.