Skip to main content

UiActionCommand Class

A command that encapsulates a UI action request. More...

Declaration​

class helios::engine::modules::ui::widgets::commands::UiActionCommand { ... }

Public Constructors Index​

UiActionCommand (const helios::engine::ecs::EntityHandle source, const helios::engine::modules::ui::widgets::types::ActionId actionId)

Constructs a command with source entity and action ID. More...

Public Member Functions Index​

helios::engine::ecs::EntityHandlesource () const noexcept

Returns the source entity that triggered the action. More...

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

Returns the action identifier. More...

Private Member Attributes Index​

helios::engine::ecs::EntityHandlesource_

Handle of the entity that triggered the action. More...

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

Identifier of the action to execute. More...

Description​

A command that encapsulates a UI action request.

UiActionCommands are submitted when UI elements are activated (e.g., button pressed, menu item selected). They carry the source entity and the action identifier to execute.

See Also

UiActionCommandManager

See Also

UiActionComponent

Definition at line 31 of file UiActionCommand.ixx.

Public Constructors​

UiActionCommand()​

helios::engine::modules::ui::widgets::commands::UiActionCommand::UiActionCommand (const helios::engine::ecs::EntityHandle source, const helios::engine::modules::ui::widgets::types::ActionId actionId)
 inline explicit

Constructs a command with source entity and action ID.

Parameters
source

The entity that triggered the action.

actionId

The identifier of the action to execute.

Definition at line 52 of file UiActionCommand.ixx.

52 explicit UiActionCommand(
53 const helios::engine::ecs::EntityHandle source,
54 const helios::engine::modules::ui::widgets::types::ActionId actionId) :
55 source_(source), actionId_(actionId) {}

References actionId and source.

Public Member Functions​

actionId()​

helios::engine::modules::ui::widgets::types::ActionId helios::engine::modules::ui::widgets::commands::UiActionCommand::actionId ()
 inline nodiscard noexcept

Returns the action identifier.

Returns

The ActionId.

Definition at line 72 of file UiActionCommand.ixx.

72 [[nodiscard]] helios::engine::modules::ui::widgets::types::ActionId actionId() const noexcept {
73 return actionId_;
74 }

Referenced by UiActionCommand.

source()​

helios::engine::ecs::EntityHandle helios::engine::modules::ui::widgets::commands::UiActionCommand::source ()
 inline nodiscard noexcept

Returns the source entity that triggered the action.

Returns

The entity handle.

Definition at line 63 of file UiActionCommand.ixx.

63 [[nodiscard]] helios::engine::ecs::EntityHandle source() const noexcept {
64 return source_;
65 }

Referenced by UiActionCommand.

Private Member Attributes​

actionId_​

helios::engine::modules::ui::widgets::types::ActionId helios::engine::modules::ui::widgets::commands::UiActionCommand::actionId_

Identifier of the action to execute.

Definition at line 41 of file UiActionCommand.ixx.

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

source_​

helios::engine::ecs::EntityHandle helios::engine::modules::ui::widgets::commands::UiActionCommand::source_

Handle of the entity that triggered the action.

Definition at line 36 of file UiActionCommand.ixx.

36 helios::engine::ecs::EntityHandle source_;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.