Open 3D Engine LyShine Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
UiDynamicScrollBoxElementNotifications Class Reference

#include <UiDynamicScrollBoxBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void OnElementBecomingVisible ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] int index)
 
virtual void OnPrepareElementForSizeCalculation ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] int index)
 
virtual void OnElementInSectionBecomingVisible ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] int sectionIndex, [[maybe_unused]] int index)
 
virtual void OnPrepareElementInSectionForSizeCalculation ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] int sectionIndex, [[maybe_unused]] int index)
 
virtual void OnSectionHeaderBecomingVisible ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] int sectionIndex)
 
virtual void OnPrepareSectionHeaderForSizeCalculation ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] int sectionIndex)
 

Detailed Description

Interface class that listeners need to implement to receive notifications of element state changes, such as when an element is about to scroll into view

Member Function Documentation

◆ OnElementBecomingVisible()

virtual void UiDynamicScrollBoxElementNotifications::OnElementBecomingVisible ( [[maybe_unused] ] AZ::EntityId  entityId,
[[maybe_unused] ] int  index 
)
inlinevirtual

Called when an element is about to become visible. Used to populate the element with data for display. Used with lists that are not divided into sections

◆ OnElementInSectionBecomingVisible()

virtual void UiDynamicScrollBoxElementNotifications::OnElementInSectionBecomingVisible ( [[maybe_unused] ] AZ::EntityId  entityId,
[[maybe_unused] ] int  sectionIndex,
[[maybe_unused] ] int  index 
)
inlinevirtual

Called when an element in a section is about to become visible. Used to populate the element with data for display Used with lists that are divided into sections

◆ OnPrepareElementForSizeCalculation()

virtual void UiDynamicScrollBoxElementNotifications::OnPrepareElementForSizeCalculation ( [[maybe_unused] ] AZ::EntityId  entityId,
[[maybe_unused] ] int  index 
)
inlinevirtual

Called when elements have variable sizes and are set to auto calculate. Used with lists that are not divided into sections

◆ OnPrepareElementInSectionForSizeCalculation()

virtual void UiDynamicScrollBoxElementNotifications::OnPrepareElementInSectionForSizeCalculation ( [[maybe_unused] ] AZ::EntityId  entityId,
[[maybe_unused] ] int  sectionIndex,
[[maybe_unused] ] int  index 
)
inlinevirtual

Called when elements in sections have variable sizes and are set to auto calculate Used with lists that are divided into sections

◆ OnPrepareSectionHeaderForSizeCalculation()

virtual void UiDynamicScrollBoxElementNotifications::OnPrepareSectionHeaderForSizeCalculation ( [[maybe_unused] ] AZ::EntityId  entityId,
[[maybe_unused] ] int  sectionIndex 
)
inlinevirtual

Called when headers have variable sizes and are set to auto calculate. Used with lists that are divided into sections

◆ OnSectionHeaderBecomingVisible()

virtual void UiDynamicScrollBoxElementNotifications::OnSectionHeaderBecomingVisible ( [[maybe_unused] ] AZ::EntityId  entityId,
[[maybe_unused] ] int  sectionIndex 
)
inlinevirtual

Called when a header is about to become visible. Used to populate the header with data for display. Used with lists that are divided into sections

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