|
guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
|
Configures, creates and registers ExtendedFloatingActionButton widgets. More...
#include <headers/guillaume/entities/extended_floating_action_button.hpp>


Public Member Functions | |
| Builder (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry) | |
| Construct a builder with the default configuration (see reset()). | |
| std::shared_ptr< ExtendedFloatingActionButton > | buildEntity (void) override |
| Build an ExtendedFloatingActionButton, with its icon and label children, from the current configuration, without registering it. | |
| void | reset (void) override |
| Restore the default configuration. | |
| Builder & | withIcon (const std::string &iconGlyphName) |
| Set the icon shown before the label. | |
| Builder & | withIconStyle (const components::Glyph::Style &iconStyle) |
| Set the glyph style of the icon. | |
| Builder & | withLabel (const std::string &labelContent) |
| Set the label text. | |
| Builder & | withOnClick (std::function< void(void)> onClick) |
| Set the click handler. | |
| Builder & | withVariant (const Variant &variant) |
| Set the color variant. | |
| Builder & | withSize (const Size &size) |
| Set the size. | |
| Builder & | withLowered (const bool &lowered) |
| Choose the lowered style: a weaker shadow (elevation level 1 instead of 3). | |
| Builder & | withDisabled (const bool &isDisabled) |
| Choose whether the FAB starts disabled. | |
| Builder & | withAccessibilityLabel (const std::string &accessibilityLabel) |
| Set the label read by assistive technology. | |
| std::shared_ptr< ExtendedFloatingActionButton > | makeExtendedFloatingActionButton (std::shared_ptr< Entity > parent, const std::string &labelContent, std::function< void(void)> onClick) |
| Build an extended FAB, register it under parent and reset the builder. | |
| Public Member Functions inherited from guillaume::entities::EntityBuilderBase< ExtendedFloatingActionButton > | |
| EntityBuilderBase (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry) | |
| Construct a builder bound to two registries. | |
| ~EntityBuilderBase (void) override=default | |
| Default destructor. | |
| std::shared_ptr< ExtendedFloatingActionButton > | registerEntity (std::shared_ptr< ecs::Entity > parent) |
| Build the widget, attach it to its parent, hand it to the entity registry, then reset the builder to its defaults. | |
| Public Member Functions inherited from guillaume::ecs::EntityBuilder | |
| EntityBuilder (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry) | |
| Create a builder working on a pair of registries, normally those of one scene. | |
| virtual | ~EntityBuilder (void)=default |
| Virtual destructor. | |
Additional Inherited Members | |
| Protected Member Functions inherited from guillaume::ecs::EntityBuilder | |
| ComponentRegistry & | getComponentRegistry (void) |
| Get the registry in which the builder creates components. | |
| EntityRegistry & | getEntityRegistry (void) |
| Get the registry in which the builder registers the entities it creates. | |
Configures, creates and registers ExtendedFloatingActionButton widgets.
Set options with the with... methods then call registerEntity(), or use makeExtendedFloatingActionButton() to do both in one call.
Definition at line 102 of file extended_floating_action_button.hpp.
| guillaume::entities::ExtendedFloatingActionButton::Builder::Builder | ( | ecs::ComponentRegistry & | componentRegistry, |
| ecs::EntityRegistry & | entityRegistry ) |
Construct a builder with the default configuration (see reset()).
| componentRegistry | The registry that stores the components of the buttons to build. |
| entityRegistry | The registry the built buttons are added to (usually the scene's). |
Definition at line 37 of file extended_floating_action_button.cpp.

|
overridevirtual |
Build an ExtendedFloatingActionButton, with its icon and label children, from the current configuration, without registering it.
registerEntity() calls it, then sets the parent, registers the button and resets the builder.
Implements guillaume::entities::EntityBuilderBase< ExtendedFloatingActionButton >.
Definition at line 47 of file extended_floating_action_button.cpp.

| std::shared_ptr< ExtendedFloatingActionButton > guillaume::entities::ExtendedFloatingActionButton::Builder::makeExtendedFloatingActionButton | ( | std::shared_ptr< Entity > | parent, |
| const std::string & | labelContent, | ||
| std::function< void(void)> | onClick ) |
Build an extended FAB, register it under parent and reset the builder.
The icon, variant, size and other options are the ones set before the call with the with... methods, or the defaults.
| parent | The entity the FAB becomes a child of. |
| labelContent | The label text. |
| onClick | The function called when the user clicks the FAB (may be empty). |
Definition at line 140 of file extended_floating_action_button.cpp.

|
overridevirtual |
Restore the default configuration.
Defaults: no icon, Glyph::Style::Outlined, empty label, no click handler, Variant::Primary, Size::Medium, not lowered, enabled, empty accessibility label.
Implements guillaume::ecs::EntityBuilder.
Definition at line 56 of file extended_floating_action_button.cpp.

| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withAccessibilityLabel | ( | const std::string & | accessibilityLabel | ) |
Set the label read by assistive technology.
| accessibilityLabel | The accessibility label. Default: empty, in which case the label text is used. |
Definition at line 132 of file extended_floating_action_button.cpp.
| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withDisabled | ( | const bool & | isDisabled | ) |
Choose whether the FAB starts disabled.
| isDisabled | True for a FAB that ignores input. Default: false. |
Definition at line 124 of file extended_floating_action_button.cpp.

| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withIcon | ( | const std::string & | iconGlyphName | ) |
Set the icon shown before the label.
| iconGlyphName | The glyph name of the icon (for example "edit"). Default: empty, no icon. |
Definition at line 70 of file extended_floating_action_button.cpp.
| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withIconStyle | ( | const components::Glyph::Style & | iconStyle | ) |
Set the glyph style of the icon.
| iconStyle | The glyph style. Default: Glyph::Style::Outlined. |
Definition at line 78 of file extended_floating_action_button.cpp.
| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withLabel | ( | const std::string & | labelContent | ) |
Set the label text.
| labelContent | The label text. Default: empty. It is also the accessibility label when none is set. |
Definition at line 86 of file extended_floating_action_button.cpp.

| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withLowered | ( | const bool & | lowered | ) |
Choose the lowered style: a weaker shadow (elevation level 1 instead of 3).
| lowered | True for the lowered style. Default: false. |
Definition at line 117 of file extended_floating_action_button.cpp.
| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withOnClick | ( | std::function< void(void)> | onClick | ) |
Set the click handler.
| onClick | The function called when the user clicks the FAB. Default: empty, nothing is called. |
Definition at line 94 of file extended_floating_action_button.cpp.
| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withSize | ( | const Size & | size | ) |
Set the size.
| size | The size. Default: Size::Medium. |
Definition at line 110 of file extended_floating_action_button.cpp.
| ExtendedFloatingActionButton::Builder & guillaume::entities::ExtendedFloatingActionButton::Builder::withVariant | ( | const Variant & | variant | ) |
Set the color variant.
| variant | The color variant. Default: Variant::Primary. |
Definition at line 102 of file extended_floating_action_button.cpp.