Skip to main content

UiActionComponent Class

Associates an action identifier with a UI element. More...

Declaration​

class helios::engine::modules::ui::widgets::components::UiActionComponent { ... }

Public Constructors Index​

UiActionComponent (const helios::engine::modules::ui::widgets::types::ActionId actionId) noexcept

Constructs the component with the given action ID. More...

Public Member Functions Index​

helios::engine::modules::ui::widgets::types::ActionIdactionId () const noexcept

Returns the associated action identifier. More...

Private Member Attributes Index​

helios::engine::modules::ui::widgets::types::ActionIdactionId_

The action identifier associated with this UI element. More...

Description​

Associates an action identifier with a UI element.

When a UI element (e.g., menu item) is activated, the associated ActionId can be used to trigger the corresponding action.

Definition at line 19 of file UiActionComponent.ixx.

Public Constructors​

UiActionComponent()​

helios::engine::modules::ui::widgets::components::UiActionComponent::UiActionComponent (const helios::engine::modules::ui::widgets::types::ActionId actionId)
 inline explicit noexcept

Constructs the component with the given action ID.

Parameters
actionId

The action identifier to associate.

Definition at line 33 of file UiActionComponent.ixx.

33 explicit UiActionComponent(
34 const helios::engine::modules::ui::widgets::types::ActionId actionId
35 ) noexcept : actionId_{actionId} {}

Reference actionId.

Public Member Functions​

actionId()​

helios::engine::modules::ui::widgets::types::ActionId helios::engine::modules::ui::widgets::components::UiActionComponent::actionId ()
 inline nodiscard noexcept

Returns the associated action identifier.

Returns

The ActionId.

Definition at line 42 of file UiActionComponent.ixx.

42 [[nodiscard]] helios::engine::modules::ui::widgets::types::ActionId actionId() const noexcept {
43 return actionId_;
44 }

Referenced by UiActionComponent.

Private Member Attributes​

actionId_​

helios::engine::modules::ui::widgets::types::ActionId helios::engine::modules::ui::widgets::components::UiActionComponent::actionId_

The action identifier associated with this UI element.

Definition at line 24 of file UiActionComponent.ixx.

24 helios::engine::modules::ui::widgets::types::ActionId actionId_;

The documentation for this class was generated from the following file:

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.