UiDynamicScrollBoxDataInterface Class Reference

Interface class that provides data needed to display a list of elements. More...

#include <UiDynamicScrollBoxBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual int	GetNumElements ()
virtual float	GetElementWidth ([[maybe_unused]] int index)
virtual float	GetElementHeight ([[maybe_unused]] int index)
virtual int	GetNumSections ()
virtual int	GetNumElementsInSection ([[maybe_unused]] int sectionIndex)
virtual float	GetElementInSectionWidth ([[maybe_unused]] int sectionIndex, [[maybe_unused]] int elementindex)
virtual float	GetElementInSectionHeight ([[maybe_unused]] int sectionIndex, [[maybe_unused]] int elementindex)
virtual float	GetSectionHeaderWidth ([[maybe_unused]] int sectionIndex)
virtual float	GetSectionHeaderHeight ([[maybe_unused]] int sectionIndex)

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 provides data needed to display a list of elements.

Member Function Documentation

GetElementHeight()

virtual float UiDynamicScrollBoxDataInterface::GetElementHeight ( [[maybe_unused] ] int  index )

inlinevirtual

Returns the height of an element at the specified index. Called when a vertical list contains elements of varying size, and the element's "auto calculate size" option is disabled. Used with lists that are not divided into sections

GetElementInSectionHeight()

virtual float UiDynamicScrollBoxDataInterface::GetElementInSectionHeight ( [[maybe_unused] ] int  sectionIndex, [[maybe_unused] ] int  elementindex  )

inlinevirtual

Returns the height of an element at the specified section. Called when a vertical list contains elements of varying size, and the element's "auto calculate size" option is disabled. Used with lists that are divided into sections

GetElementInSectionWidth()

virtual float UiDynamicScrollBoxDataInterface::GetElementInSectionWidth ( [[maybe_unused] ] int  sectionIndex, [[maybe_unused] ] int  elementindex  )

inlinevirtual

Returns the width of an element at the specified section. Called when a horizontal list contains elements of varying size, and the element's "auto calculate size" option is disabled. Used with lists that are divided into sections

GetElementWidth()

virtual float UiDynamicScrollBoxDataInterface::GetElementWidth ( [[maybe_unused] ] int  index )

inlinevirtual

Returns the width of an element at the specified index. Called when a horizontal list contains elements of varying size, and the element's "auto calculate size" option is disabled. Used with lists that are not divided into sections

GetNumElements()

virtual int UiDynamicScrollBoxDataInterface::GetNumElements ( )

inlinevirtual

Returns the number of elements in the list. Called when the list is being constructed (in the component's InGamePostActivate or when RefreshContent is being called explicitely). Used with lists that are not divided into sections

GetNumElementsInSection()

virtual int UiDynamicScrollBoxDataInterface::GetNumElementsInSection ( [[maybe_unused] ] int  sectionIndex )

inlinevirtual

Returns the number of elements in the specified section. Called when the list is being constructed (in the component's InGamePostActivate or when RefreshContent is being called explicitely). Used with lists that are divided into sections

GetNumSections()

virtual int UiDynamicScrollBoxDataInterface::GetNumSections ( )

inlinevirtual

Returns the number of sections in the list. Called when the list is being constructed (in the component's InGamePostActivate or when RefreshContent is being called explicitely). Used with lists that are divided into sections

GetSectionHeaderHeight()

virtual float UiDynamicScrollBoxDataInterface::GetSectionHeaderHeight ( [[maybe_unused] ] int  sectionIndex )

inlinevirtual

Returns the height of a header at the specified section. Called when a vertical list contains elements of varying size, and the header's "auto calculate size" option is disabled. Used with lists that are divided into sections

GetSectionHeaderWidth()

virtual float UiDynamicScrollBoxDataInterface::GetSectionHeaderWidth ( [[maybe_unused] ] int  sectionIndex )

inlinevirtual

Returns the width of a header at the specified section. Called when a horizontal list contains headers of varying size, and the header's "auto calculate size" option is disabled. Used with lists that are divided into sections

---

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

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