UiActionComponent.ixx File

Component for associating actions with UI elements. More...

Included Headers

#include <helios.engine.modules.ui.widgets.types>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	modules
	Domain-specific components and systems. More...
namespace	ui
	User interface components and systems for game entities. More...
namespace	widgets
	UI widget components and systems. More...
namespace	components
	UI widget state components. More...

Classes Index

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

Description

Component for associating actions with UI elements.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file UiActionComponent.ixx

3 * @brief Component for associating actions with UI elements.

4 */

5module;

6

7export module helios.engine.modules.ui.widgets.components.UiActionComponent;

8

9import helios.engine.modules.ui.widgets.types;

10

11export namespace helios::engine::modules::ui::widgets::components {

12

13 /**

14 * @brief Associates an action identifier with a UI element.

15 *

16 * When a UI element (e.g., menu item) is activated, the associated

17 * ActionId can be used to trigger the corresponding action.

18 */

19 class UiActionComponent {

20

21 /**

22 * @brief The action identifier associated with this UI element.

23 */

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

25

26 public:

27

28 /**

29 * @brief Constructs the component with the given action ID.

30 *

31 * @param actionId The action identifier to associate.

32 */

33 explicit UiActionComponent(

34 const helios::engine::modules::ui::widgets::types::ActionId actionId

35 ) noexcept : actionId_{actionId} {}

36

37 /**

38 * @brief Returns the associated action identifier.

39 *

40 * @return The ActionId.

41 */

42 [[nodiscard]] helios::engine::modules::ui::widgets::types::ActionId actionId() const noexcept {

43 return actionId_;

44 }

45

46

47 };

48

49

50

51}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.