UiRadioButtonGroupCommunicationInterface Class Reference

#include <UiRadioButtonGroupCommunicationBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual bool	RegisterRadioButton (AZ::EntityId radioButton)=0
virtual void	UnregisterRadioButton (AZ::EntityId radioButton)=0
virtual void	RequestRadioButtonStateChange (AZ::EntityId radioButton, bool newState)=0

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

Detailed Description

Interface class that a radio button group component needs to implement. This interface allows a radio button to communicate with the radio button group itself

Member Function Documentation

RegisterRadioButton()

virtual bool UiRadioButtonGroupCommunicationInterface::RegisterRadioButton ( AZ::EntityId  radioButton )

pure virtual

Registers a radio button within a group

Parameters

The	radio button to add

Returns

Whether the radio button was successfully added to the group or not

RequestRadioButtonStateChange()

virtual void UiRadioButtonGroupCommunicationInterface::RequestRadioButtonStateChange ( AZ::EntityId  radioButton, bool  newState  )

pure virtual

Called when a radio button wants to change state due to user action (i.e. by clicking it)

Parameters

The	radio button to change the state of
The	new radio button state

UnregisterRadioButton()

virtual void UiRadioButtonGroupCommunicationInterface::UnregisterRadioButton ( AZ::EntityId  radioButton )

pure virtual

Unregisters a radio button within a group

Parameters

The	radio button to remove

---

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

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