UiRadioButtonInterface Class Reference

#include <UiRadioButtonBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual bool	GetState ()=0
virtual AZ::EntityId	GetGroup ()=0
	Get the radio button group.
virtual AZ::EntityId	GetCheckedEntity ()=0
	Get the optional checked (ON) entity.
virtual void	SetCheckedEntity (AZ::EntityId entityId)=0
	Set the optional checked (ON) entity.
virtual AZ::EntityId	GetUncheckedEntity ()=0
	Get the optional unchecked (OFF) entity.
virtual void	SetUncheckedEntity (AZ::EntityId entityId)=0
	Set the optional unchecked (OFF) entity.
virtual const LyShine::ActionName &	GetTurnOnActionName ()=0
	Get the action triggered when turned on.
virtual void	SetTurnOnActionName (const LyShine::ActionName &actionName)=0
	Set the action triggered when turned on.
virtual const LyShine::ActionName &	GetTurnOffActionName ()=0
	Get the action triggered when turned off.
virtual void	SetTurnOffActionName (const LyShine::ActionName &actionName)=0
	Set the action triggered when turned off.
virtual const LyShine::ActionName &	GetChangedActionName ()=0
	Get the action triggered when changed.
virtual void	SetChangedActionName (const LyShine::ActionName &actionName)=0
	Set the action triggered when changed.

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
	Only one component on a entity can implement the events.

Detailed Description

Interface class that a radio button component needs to implement. A radio button component provides functionality for a button that can be turned on or off and is dependent on the other radio buttons in the same radio button group. This interface is designed to be used in conjunction with the UiRadioButtonGroupInterface, which describes the group for radio buttons.

Member Function Documentation

GetState()

virtual bool UiRadioButtonInterface::GetState ( )

pure virtual

Query the state of the radio button

Returns

The current state for the radio button.

---

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

• Gems/LyShine/Code/Include/LyShine/Bus/UiRadioButtonBus.h