UiRadioButtonGroupInterface Class Reference

#include <UiRadioButtonGroupBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual AZ::EntityId	GetCheckedRadioButton ()=0
virtual void	SetState (AZ::EntityId radioButton, bool isOn)=0
	Set a radio button to a desired state.
virtual bool	GetAllowUncheck ()=0
	Get the allow uncheck flag.
virtual void	SetAllowUncheck (bool allowUncheck)=0
	Set the allow uncheck flag.
virtual void	AddRadioButton (AZ::EntityId radioButton)=0
	Add a new radio button to the group.
virtual void	RemoveRadioButton (AZ::EntityId radioButton)=0
	Remove a radio button from the group.
virtual bool	ContainsRadioButton (AZ::EntityId radioButton)=0
	Query whether a radio button is in the group or not.
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 group component needs to implement. A radio button group component provides functionality to manage a group of radio buttons. A group of radio buttons allows users to choose one of a predefined set of mutually exclusive options. No more than one item may be selected.

Member Function Documentation

GetCheckedRadioButton()

virtual AZ::EntityId UiRadioButtonGroupInterface::GetCheckedRadioButton ( )

pure virtual

Query the state of the radio button group

Returns

The currently checked radio button.

---

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

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