guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
extended_floating_action_button.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 <optional>
26
27#include "guillaume/ecs/component.hpp"
28#include "guillaume/ecs/entity.hpp"
29
31{
32
57 {
58 public:
67 enum class Variant { Surface, Primary, Secondary, Tertiary };
68
72 enum class Mode { Elevated, Flat };
73
77 enum class Size { Small, Medium, Large };
78
79 private:
80 Variant _variant { Variant::Primary };
81 Size _size { Size::Medium };
82 Mode _mode { Mode::Elevated };
83 std::optional<float> _customSize {};
84 bool _extended { true };
85 bool _lowered { false };
86
87 public:
93
98
103 Variant getVariant(void) const noexcept;
104
111
116 Size getSize(void) const noexcept;
117
125
130 Mode getMode(void) const noexcept;
131
139
146 const std::optional<float> &getCustomSize(void) const noexcept;
147
158 setCustomSize(const std::optional<float> &size);
159
164 bool isExtended(void) const noexcept;
165
177
182 bool isLowered(void) const noexcept;
183
194 };
195
196} // namespace guillaume::components
ExtendedFloatingActionButton & setExtended(bool extended)
Show the label, or collapse the button to its icon.
const std::optional< float > & getCustomSize(void) const noexcept
Get the container height that replaces the one of the size step.
ExtendedFloatingActionButton & setCustomSize(const std::optional< float > &size)
Replace the container height of the size step.
ExtendedFloatingActionButton(void)=default
Create the configuration of a medium, elevated, primary button with its label shown.
ExtendedFloatingActionButton & setMode(Mode mode)
Choose whether the button casts a shadow.
ExtendedFloatingActionButton & setSize(Size size)
Choose the size step.
~ExtendedFloatingActionButton(void)=default
Default destructor.
ExtendedFloatingActionButton & setVariant(Variant variant)
Choose which theme colors the button uses.
Variant getVariant(void) const noexcept
Get the color variant.
bool isLowered(void) const noexcept
Check whether the resting shadow is lowered.
ExtendedFloatingActionButton & setLowered(bool lowered)
Lower the resting shadow, or restore it.
bool isExtended(void) const noexcept
Check whether the label is shown.
Mode
Whether the button casts a shadow (Elevated) or not (Flat).
Variant
Which theme colors fill the container, the icon and the label.
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.
@ Secondary
Tones of the secondary accent color.
Definition theme.hpp:142
@ Tertiary
Tones of the tertiary accent color.
Definition theme.hpp:143
@ Primary
Tones of the primary accent color.
Definition theme.hpp:141