UiStateComponent Class

Tracks interaction state for UI widgets. More...

Declaration

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

Public Member Functions Index

void	setSelected (const bool selected) noexcept
	Sets the selected state. More...
bool	isSelected () const noexcept
	Returns the selected state. More...
void	setHovered (bool hovered) noexcept
	Sets the hovered state. More...
bool	isHovered () const noexcept
	Returns the hovered state. More...
void	setFocused (bool focused) noexcept
	Sets the focused state. More...
bool	isFocused () const noexcept
	Returns the focused state. More...
void	setEnabled (bool enabled) noexcept
	Sets the enabled state. More...
bool	isEnabled () const noexcept
	Returns the enabled state. More...
void	setPressed (bool pressed) noexcept
	Sets the pressed state. More...
bool	isPressed () const noexcept
	Returns the pressed state. More...

Private Member Attributes Index

bool	isEnabled_ = true
bool	isSelected_ = false
bool	isHovered_ = false
bool	isFocused_ = false
bool	isPressed_ = false

Description

Tracks interaction state for UI widgets.

Manages common UI states such as selection, hover, focus, enabled/disabled, and pressed states.

Definition at line 16 of file UiStateComponent.ixx.

Public Member Functions

isEnabled()

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isEnabled ()

inline nodiscard noexcept

Returns the enabled state.

Definition at line 91 of file UiStateComponent.ixx.

91 [[nodiscard]] bool isEnabled() const noexcept {

92 return isEnabled_;

93 }

isFocused()

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isFocused ()

inline nodiscard noexcept

Returns the focused state.

Definition at line 75 of file UiStateComponent.ixx.

75 [[nodiscard]] bool isFocused() const noexcept {

76 return isFocused_;

77 }

isHovered()

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isHovered ()

inline nodiscard noexcept

Returns the hovered state.

Definition at line 59 of file UiStateComponent.ixx.

59 [[nodiscard]] bool isHovered() const noexcept {

60 return isHovered_;

61 }

isPressed()

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isPressed ()

inline nodiscard noexcept

Returns the pressed state.

Definition at line 107 of file UiStateComponent.ixx.

107 [[nodiscard]] bool isPressed() const noexcept {

108 return isPressed_;

109 }

isSelected()

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isSelected ()

inline nodiscard noexcept

Returns the selected state.

Definition at line 43 of file UiStateComponent.ixx.

43 [[nodiscard]] bool isSelected() const noexcept {

44 return isSelected_;

45 }

setEnabled()

void helios::engine::modules::ui::widgets::components::UiStateComponent::setEnabled (bool enabled)

inline noexcept

Sets the enabled state.

Parameters

enabled

True if enabled.

Definition at line 84 of file UiStateComponent.ixx.

84 void setEnabled(bool enabled) noexcept {

85 isEnabled_ = enabled;

86 }

setFocused()

void helios::engine::modules::ui::widgets::components::UiStateComponent::setFocused (bool focused)

inline noexcept

Sets the focused state.

Parameters

focused

True if focused.

Definition at line 68 of file UiStateComponent.ixx.

68 void setFocused(bool focused) noexcept {

69 isFocused_ = focused;

70 }

setHovered()

void helios::engine::modules::ui::widgets::components::UiStateComponent::setHovered (bool hovered)

inline noexcept

Sets the hovered state.

Parameters

hovered

True if hovered.

Definition at line 52 of file UiStateComponent.ixx.

52 void setHovered(bool hovered) noexcept {

53 isHovered_ = hovered;

54 }

setPressed()

void helios::engine::modules::ui::widgets::components::UiStateComponent::setPressed (bool pressed)

inline noexcept

Sets the pressed state.

Parameters

pressed

True if pressed.

Definition at line 100 of file UiStateComponent.ixx.

100 void setPressed(bool pressed) noexcept {

101 isPressed_ = pressed;

102 }

setSelected()

void helios::engine::modules::ui::widgets::components::UiStateComponent::setSelected (const bool selected)

inline noexcept

Sets the selected state.

Parameters

selected

True if selected.

Definition at line 36 of file UiStateComponent.ixx.

36 void setSelected(const bool selected) noexcept {

37 isSelected_ = selected;

38 }

Private Member Attributes

isEnabled_

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isEnabled_ = true

Definition at line 19 of file UiStateComponent.ixx.

19 bool isEnabled_ = true;

isFocused_

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isFocused_ = false

Definition at line 25 of file UiStateComponent.ixx.

25 bool isFocused_ = false;

isHovered_

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isHovered_ = false

Definition at line 23 of file UiStateComponent.ixx.

23 bool isHovered_ = false;

isPressed_

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isPressed_ = false

Definition at line 27 of file UiStateComponent.ixx.

27 bool isPressed_ = false;

isSelected_

bool helios::engine::modules::ui::widgets::components::UiStateComponent::isSelected_ = false

Definition at line 21 of file UiStateComponent.ixx.

21 bool isSelected_ = false;

---

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

• UiStateComponent.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.