UiScrollerInterface Class Reference

#include <UiScrollerBus.h>

Inherits AZ::ComponentBus.

Public Types
enum class	Orientation { Horizontal , Vertical }
	Scroller orientation.
typedef AZStd::function< void(AZ::EntityId, float)>	ValueChangeCallback
	params: sending entity id, newValue, newPosition

Public Member Functions
virtual float	GetValue ()=0
	Get the current value for the scrollbar (0 - 1)
virtual void	SetValue (float value)=0
	Set the value of the scrollbar (0 - 1)
virtual Orientation	GetOrientation ()=0
	Get the orientation of the scroller.
virtual void	SetOrientation (Orientation orientation)=0
	Set the orientation of the scroller.
virtual AZ::EntityId	GetScrollableEntity ()=0
	Get the scrollable entity.
virtual void	SetScrollableEntity (AZ::EntityId entityId)=0
	Set the scrollable entity.
virtual ValueChangeCallback	GetValueChangingCallback ()=0
	Get the callback invoked while the value is changing.
virtual void	SetValueChangingCallback (ValueChangeCallback onChange)=0
	Set the callback invoked while the value is changing.
virtual ValueChangeCallback	GetValueChangedCallback ()=0
	Get the callback invoked when the value is done changing.
virtual void	SetValueChangedCallback (ValueChangeCallback onChange)=0
	Set the callback invoked when the value is done changing.
virtual const LyShine::ActionName &	GetValueChangingActionName ()=0
	Get the action triggered while the value is changing.
virtual void	SetValueChangingActionName (const LyShine::ActionName &actionName)=0
	Set the action triggered while the value is changing.
virtual const LyShine::ActionName &	GetValueChangedActionName ()=0
	Get the action triggered when the value is done changing.
virtual void	SetValueChangedActionName (const LyShine::ActionName &actionName)=0
	Set the action triggered when the value is done changing.

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 scroller component needs to implement. A scroller component provides functionality to control the scrolling of scrollable content (e.g. UiScrollBarComponent)

---

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

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