guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
switch.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/switch.hpp"
24
25#include <utility>
26
28{
30 {
31 return _variant;
32 }
33
35 {
36 if (_variant != variant) {
37 _variant = variant;
38 setHasChanged(true);
39 }
40 return *this;
41 }
42
43 const std::string &Switch::getIconGlyph(void) const noexcept
44 {
45 return _iconGlyph;
46 }
47
48 Switch &Switch::setIconGlyph(const std::string &glyph)
49 {
50 if (_iconGlyph != glyph) {
51 _iconGlyph = glyph;
52 setHasChanged(true);
53 }
54 return *this;
55 }
56
57 const std::string &Switch::getLabel(void) const noexcept
58 {
59 return _label;
60 }
61
62 Switch &Switch::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 _thumb;
74 }
75
77 {
78 if (_thumb != identifier) {
79 _thumb = identifier;
80 setHasChanged(true);
81 }
82 return *this;
83 }
84
86 {
87 return _icon;
88 }
89
91 {
92 if (_icon != identifier) {
93 _icon = identifier;
94 setHasChanged(true);
95 }
96 return *this;
97 }
98
100 {
101 return _labelEntity;
102 }
103
105 {
106 if (_labelEntity != identifier) {
107 _labelEntity = identifier;
108 setHasChanged(true);
109 }
110 return *this;
111 }
112
114 Switch::getOnValueChange(void) const noexcept
115 {
116 return _onValueChange;
117 }
118
120 {
121 _onValueChange = std::move(handler);
122 return *this;
123 }
124} // namespace guillaume::components
ecs::Entity::Identifier getIcon(void) const noexcept
Get the child entity that draws the thumb icon.
Definition switch.cpp:85
Switch & setOnValueChange(ValueChangeHandler handler)
Set the callback run when the user toggles the switch.
Definition switch.cpp:119
Variant getVariant(void) const noexcept
Get the visual variant.
Definition switch.cpp:29
Switch(void)=default
Create the configuration of an enabled switch with no icon and no label.
Switch & setThumb(ecs::Entity::Identifier identifier)
Record which child entity is the thumb.
Definition switch.cpp:76
Switch & setLabelEntity(ecs::Entity::Identifier identifier)
Record which child entity draws the label.
Definition switch.cpp:104
Switch & setIconGlyph(const std::string &glyph)
Set the name of the glyph drawn on the thumb.
Definition switch.cpp:48
const std::string & getIconGlyph(void) const noexcept
Get the name of the glyph drawn on the thumb.
Definition switch.cpp:43
const std::string & getLabel(void) const noexcept
Get the label text.
Definition switch.cpp:57
ecs::Entity::Identifier getThumb(void) const noexcept
Get the child entity drawn as the thumb.
Definition switch.cpp:71
ecs::Entity::Identifier getLabelEntity(void) const noexcept
Get the child entity that draws the label.
Definition switch.cpp:99
const ValueChangeHandler & getOnValueChange(void) const noexcept
Get the callback run when the user toggles the switch.
Definition switch.cpp:114
Switch & setLabel(const std::string &label)
Set the label text.
Definition switch.cpp:62
Switch & setVariant(Variant variant)
Choose the visual variant.
Definition switch.cpp:34
Switch & setIcon(ecs::Entity::Identifier identifier)
Record which child entity draws the thumb icon.
Definition switch.cpp:90
std::function< void(bool)> ValueChangeHandler
Definition switch.hpp:69
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.