Inheritance diagram for SCR_PooledListComponent:

[legend]

Public Member Functions
override void	HandlerAttached (Widget w)

void	UpdateEntries (bool animated=false)
	Fill entries with data.

void	UpdateScroll ()
	Update positions of pages and offsets.

void	FocusFirstAvailableEntry ()
	Find first available entry and focus it.

void	MoveToTop ()
	Move list scroll to top.

void	ShowScrollbar (bool show)
	Clip scroll bar to hide.

int	GetPageEntriesCount ()

array< Widget >	GetEntryWidgets ()

void	SetDataEntries (int entriesCount)

Widget	FirstAvailableEntry ()
	Return first that is visible and enabled.

void	SetIsListFocused (bool focused)

bool	IsListFocused ()

Widget	GetScrollWidget ()

ScriptInvokerInt	GetOnSetPage ()

Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)

override bool	OnClick (Widget w, int x, int y, int button)

Widget	GetRootWidget ()

bool	IsVisible ()

Public Attributes
bool	m_bIsListFocused

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Static Public Attributes
const float	SIZE_UNMEASURED = -1

const int	CHECK_ENTRY_SIZE_DELAY = 100

const float	ENTRY_OFFSET_UP = 0.1

const int	ZORDER_OFFSET_TOP

const int	ZORDER_OFFSET_BOTTOM = 3

const string	WIDGET_PAGES = "VPages"

const string	WIDGET_PAGE0 = "VPage0"

const string	WIDGET_PAGE1 = "VPage1"

const string	WIDGET_SCROLL_LAYOUT = "ScrollLayout"

const string	WIDGET_SIZE_OFFSET_TOP = "SizeOffsetTop"

const string	WIDGET_SIZE_OFFSET_BOTTOM = "SizeOffsetBottom"

const string	WIDGET_FOCUS_REST = "FocusRest"

Protected Member Functions
void	OnActionUp ()
	Call this when up action is activated.

void	OnActionDown ()
	Call this when down action is activated.

void	OnScroll (float scrollY)
	Call this position of scroll is changed.

int	CurrentPageFromScrollPos (float scrollY)
	Return current page from scroll position.

float	EntriesOutOfView ()
	How many entries are of view - how many entries can be scrolled.

void	SetCurrentPage (int page)
	Set which page should be currently displayed.

void	SetCurrentPageBase (int page)
	Base function for updating current page.

void	SwitchPages (bool invert, float size, int page)
	Change order of list to fake endless scrolling.

void	SetupOffsets (int page)
	Set sizes of top and bottom offsets.

void	AccessingHandlers ()
	Get reference to all needed component for handling.

void	CreateEntriesWidgets ()
	Create server entries widget.

void	CreateEntriesWidgetsInPage (Widget parent, int count, out Widget firstEntry, out Widget lastEntry)
	Create entries to selected page and assing first and last entries.

Widget	CreateEntry (Widget parent)
	Create entry to given page and setup it's behavior

void	CheckEntrySize ()
	Get size of widget entry used in list.

void	SetupEntryBehavior (Widget entry)
	Empty functions for setting up widget entry beavhior actions, callbacks, etc.

void	FillEntry (Widget w)
	Empty function for filling entries with data Override this to fill entries with data.

void	AnimateEntryOpacity (Widget w, int delay, float animTime, float opacityEnd, float opacityStart=-1)
	Setup opacity animation.

void	OpacityAnimation (Widget w, int time, float opacityEnd)

void	ShowEntries (int dataCount)
	Display right entries with right position by scroll.

Widget	FocusedWidgetFromEntryList ()
	Return if and which entry widget is actually focus.

Protected Attributes
ResourceName	m_sEntry

float	m_fAnimationAppearTime

int	m_iPageEntriesCount

int	m_iPageChangeOffset

int	m_iAllEntriesCount

float	m_fListPxHeight = SIZE_UNMEASURED

float	m_fPagePxHeight = SIZE_UNMEASURED

float	m_fViewPxHeight = SIZE_UNMEASURED

float	m_fEntryPxHeight = SIZE_UNMEASURED

ScrollLayoutWidget	m_wScroll

Widget	m_wPagesWrap

Widget	m_wPage0

Widget	m_wPage1

Widget	m_wPage0FirstEntry

Widget	m_wPage0LastEntry

Widget	m_wPage1FirstEntry

Widget	m_wPage1LastEntry

Widget	m_wLastFocused

ref array< Widget >	m_aEntryWidgets = {}

SizeLayoutWidget	m_wSizeOffsetTop

SizeLayoutWidget	m_wSizeOffsetBottom

bool	m_bPagesInverted

int	m_iCurrentPage

float	m_ScrollLastY

ref ScriptInvokerInt	m_OnSetPage

bool	m_bIsMeasured = false

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Member Function Documentation

◆ AccessingHandlers()

void SCR_PooledListComponent.AccessingHandlers ( )

protected

Get reference to all needed component for handling.

◆ AnimateEntryOpacity()

void SCR_PooledListComponent.AnimateEntryOpacity	(	Widget	w,
		int	delay,
		float	animTime,
		float	opacityEnd,
		float	opacityStart = `-1`
	)

protected

Setup opacity animation.

◆ CheckEntrySize()

void SCR_PooledListComponent.CheckEntrySize ( )

protected

Get size of widget entry used in list.

◆ CreateEntriesWidgets()

void SCR_PooledListComponent.CreateEntriesWidgets ( )

protected

Create server entries widget.

◆ CreateEntriesWidgetsInPage()

void SCR_PooledListComponent.CreateEntriesWidgetsInPage	(	Widget	parent,
		int	count,
		out Widget	firstEntry,
		out Widget	lastEntry
	)

protected

Create entries to selected page and assing first and last entries.

◆ CreateEntry()

Widget SCR_PooledListComponent.CreateEntry ( Widget parent )

protected

Create entry to given page and setup it's behavior

Implemented in SCR_PooledServerListComponent.

◆ CurrentPageFromScrollPos()

int SCR_PooledListComponent.CurrentPageFromScrollPos ( float scrollY )

protected

Return current page from scroll position.

◆ EntriesOutOfView()

float SCR_PooledListComponent.EntriesOutOfView ( )

protected

How many entries are of view - how many entries can be scrolled.

◆ FillEntry()

void SCR_PooledListComponent.FillEntry ( Widget w )

protected

Empty function for filling entries with data Override this to fill entries with data.

Implemented in SCR_PooledServerListComponent.

◆ FirstAvailableEntry()

Widget SCR_PooledListComponent.FirstAvailableEntry ( )

Return first that is visible and enabled.

◆ FocusedWidgetFromEntryList()

Widget SCR_PooledListComponent.FocusedWidgetFromEntryList ( )

protected

Return if and which entry widget is actually focus.

◆ FocusFirstAvailableEntry()

void SCR_PooledListComponent.FocusFirstAvailableEntry ( )

Find first available entry and focus it.

◆ GetEntryWidgets()

array< Widget > SCR_PooledListComponent.GetEntryWidgets ( )

◆ GetOnSetPage()

ScriptInvokerInt SCR_PooledListComponent.GetOnSetPage ( )

◆ GetPageEntriesCount()

int SCR_PooledListComponent.GetPageEntriesCount ( )

◆ GetScrollWidget()

Widget SCR_PooledListComponent.GetScrollWidget ( )

◆ HandlerAttached()

override void SCR_PooledListComponent.HandlerAttached ( Widget w )

Implements SCR_ScriptedWidgetComponent.

◆ IsListFocused()

bool SCR_PooledListComponent.IsListFocused ( )

◆ MoveToTop()

void SCR_PooledListComponent.MoveToTop ( )

Move list scroll to top.

Implemented in SCR_PooledServerListComponent.

◆ OnActionDown()

void SCR_PooledListComponent.OnActionDown ( )

protected

Call this when down action is activated.

◆ OnActionUp()

void SCR_PooledListComponent.OnActionUp ( )

protected

Call this when up action is activated.

◆ OnScroll()

void SCR_PooledListComponent.OnScroll ( float scrollY )

protected

Call this position of scroll is changed.

◆ OpacityAnimation()

void SCR_PooledListComponent.OpacityAnimation	(	Widget	w,
		int	time,
		float	opacityEnd
	)

protected

◆ SetCurrentPage()

void SCR_PooledListComponent.SetCurrentPage ( int page )

protected

Set which page should be currently displayed.

Implemented in SCR_PooledServerListComponent.

◆ SetCurrentPageBase()

void SCR_PooledListComponent.SetCurrentPageBase ( int page )

protected

Base function for updating current page.

◆ SetDataEntries()

void SCR_PooledListComponent.SetDataEntries ( int entriesCount )

◆ SetIsListFocused()

void SCR_PooledListComponent.SetIsListFocused ( bool focused )

◆ SetupEntryBehavior()

void SCR_PooledListComponent.SetupEntryBehavior ( Widget entry )

protected

Empty functions for setting up widget entry beavhior actions, callbacks, etc.

Override this to assign specific beavhior for each entry

◆ SetupOffsets()

void SCR_PooledListComponent.SetupOffsets ( int page )

protected

Set sizes of top and bottom offsets.

◆ ShowEntries()

void SCR_PooledListComponent.ShowEntries ( int dataCount )

protected

Display right entries with right position by scroll.

◆ ShowScrollbar()

void SCR_PooledListComponent.ShowScrollbar ( bool show )

Clip scroll bar to hide.

◆ SwitchPages()

void SCR_PooledListComponent.SwitchPages	(	bool	invert,
		float	size,
		int	page
	)

protected

Change order of list to fake endless scrolling.

◆ UpdateEntries()

void SCR_PooledListComponent.UpdateEntries ( bool animated = false )

Fill entries with data.

◆ UpdateScroll()

void SCR_PooledListComponent.UpdateScroll ( )

Update positions of pages and offsets.

Member Data Documentation

◆ CHECK_ENTRY_SIZE_DELAY

const int SCR_PooledListComponent.CHECK_ENTRY_SIZE_DELAY = 100

static

◆ ENTRY_OFFSET_UP

const float SCR_PooledListComponent.ENTRY_OFFSET_UP = 0.1

static

◆ m_aEntryWidgets

ref array<Widget> SCR_PooledListComponent.m_aEntryWidgets = {}

protected

◆ m_bIsListFocused

bool SCR_PooledListComponent.m_bIsListFocused

◆ m_bIsMeasured

bool SCR_PooledListComponent.m_bIsMeasured = false

protected

◆ m_bPagesInverted

bool SCR_PooledListComponent.m_bPagesInverted

protected

◆ m_fAnimationAppearTime

float SCR_PooledListComponent.m_fAnimationAppearTime

protected

◆ m_fEntryPxHeight

float SCR_PooledListComponent.m_fEntryPxHeight = SIZE_UNMEASURED

protected

◆ m_fListPxHeight

float SCR_PooledListComponent.m_fListPxHeight = SIZE_UNMEASURED

protected

◆ m_fPagePxHeight

float SCR_PooledListComponent.m_fPagePxHeight = SIZE_UNMEASURED

protected

◆ m_fViewPxHeight

float SCR_PooledListComponent.m_fViewPxHeight = SIZE_UNMEASURED

protected

◆ m_iAllEntriesCount

int SCR_PooledListComponent.m_iAllEntriesCount

protected

◆ m_iCurrentPage

int SCR_PooledListComponent.m_iCurrentPage

protected

◆ m_iPageChangeOffset

int SCR_PooledListComponent.m_iPageChangeOffset

protected

◆ m_iPageEntriesCount

int SCR_PooledListComponent.m_iPageEntriesCount

protected

◆ m_OnSetPage

ref ScriptInvokerInt SCR_PooledListComponent.m_OnSetPage

protected

◆ m_ScrollLastY

float SCR_PooledListComponent.m_ScrollLastY

protected

◆ m_sEntry

ResourceName SCR_PooledListComponent.m_sEntry

protected

◆ m_wLastFocused

Widget SCR_PooledListComponent.m_wLastFocused

protected

◆ m_wPage0

Widget SCR_PooledListComponent.m_wPage0

protected

◆ m_wPage0FirstEntry

Widget SCR_PooledListComponent.m_wPage0FirstEntry

protected

◆ m_wPage0LastEntry

Widget SCR_PooledListComponent.m_wPage0LastEntry

protected

◆ m_wPage1

Widget SCR_PooledListComponent.m_wPage1

protected

◆ m_wPage1FirstEntry

Widget SCR_PooledListComponent.m_wPage1FirstEntry

protected

◆ m_wPage1LastEntry

Widget SCR_PooledListComponent.m_wPage1LastEntry

protected

◆ m_wPagesWrap

Widget SCR_PooledListComponent.m_wPagesWrap

protected

◆ m_wScroll

ScrollLayoutWidget SCR_PooledListComponent.m_wScroll

protected

◆ m_wSizeOffsetBottom

SizeLayoutWidget SCR_PooledListComponent.m_wSizeOffsetBottom

protected

◆ m_wSizeOffsetTop

SizeLayoutWidget SCR_PooledListComponent.m_wSizeOffsetTop

protected

◆ SIZE_UNMEASURED

const float SCR_PooledListComponent.SIZE_UNMEASURED = -1

static

◆ WIDGET_FOCUS_REST

const string SCR_PooledListComponent.WIDGET_FOCUS_REST = "FocusRest"

static

◆ WIDGET_PAGE0

const string SCR_PooledListComponent.WIDGET_PAGE0 = "VPage0"

static

◆ WIDGET_PAGE1

const string SCR_PooledListComponent.WIDGET_PAGE1 = "VPage1"

static

◆ WIDGET_PAGES

const string SCR_PooledListComponent.WIDGET_PAGES = "VPages"

static

◆ WIDGET_SCROLL_LAYOUT

const string SCR_PooledListComponent.WIDGET_SCROLL_LAYOUT = "ScrollLayout"

static

◆ WIDGET_SIZE_OFFSET_BOTTOM

const string SCR_PooledListComponent.WIDGET_SIZE_OFFSET_BOTTOM = "SizeOffsetBottom"

static

◆ WIDGET_SIZE_OFFSET_TOP

const string SCR_PooledListComponent.WIDGET_SIZE_OFFSET_TOP = "SizeOffsetTop"

static

◆ ZORDER_OFFSET_BOTTOM

const int SCR_PooledListComponent.ZORDER_OFFSET_BOTTOM = 3

static

◆ ZORDER_OFFSET_TOP

const int SCR_PooledListComponent.ZORDER_OFFSET_TOP

static

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

Game/UI/Components/WidgetLibrary/SCR_ListView/SCR_PooledListComponent.c

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ AccessingHandlers()

◆ AnimateEntryOpacity()

◆ CheckEntrySize()

◆ CreateEntriesWidgets()

◆ CreateEntriesWidgetsInPage()

◆ CreateEntry()

◆ CurrentPageFromScrollPos()

◆ EntriesOutOfView()

◆ FillEntry()

◆ FirstAvailableEntry()

◆ FocusedWidgetFromEntryList()

◆ FocusFirstAvailableEntry()

◆ GetEntryWidgets()

◆ GetOnSetPage()

◆ GetPageEntriesCount()

◆ GetScrollWidget()

◆ HandlerAttached()

◆ IsListFocused()

◆ MoveToTop()

◆ OnActionDown()

◆ OnActionUp()

◆ OnScroll()

◆ OpacityAnimation()

◆ SetCurrentPage()

◆ SetCurrentPageBase()

◆ SetDataEntries()

◆ SetIsListFocused()

◆ SetupEntryBehavior()

◆ SetupOffsets()

◆ ShowEntries()

◆ ShowScrollbar()

◆ SwitchPages()

◆ UpdateEntries()

◆ UpdateScroll()

Member Data Documentation

◆ CHECK_ENTRY_SIZE_DELAY

◆ ENTRY_OFFSET_UP

◆ m_aEntryWidgets

◆ m_bIsListFocused

◆ m_bIsMeasured

◆ m_bPagesInverted

◆ m_fAnimationAppearTime

◆ m_fEntryPxHeight

◆ m_fListPxHeight

◆ m_fPagePxHeight

◆ m_fViewPxHeight

◆ m_iAllEntriesCount

◆ m_iCurrentPage

◆ m_iPageChangeOffset

◆ m_iPageEntriesCount

◆ m_OnSetPage

◆ m_ScrollLastY

◆ m_sEntry

◆ m_wLastFocused

◆ m_wPage0

◆ m_wPage0FirstEntry

◆ m_wPage0LastEntry

◆ m_wPage1

◆ m_wPage1FirstEntry

◆ m_wPage1LastEntry

◆ m_wPagesWrap

◆ m_wScroll

◆ m_wSizeOffsetBottom

◆ m_wSizeOffsetTop

◆ SIZE_UNMEASURED

◆ WIDGET_FOCUS_REST

◆ WIDGET_PAGE0

◆ WIDGET_PAGE1

◆ WIDGET_PAGES

◆ WIDGET_SCROLL_LAYOUT

◆ WIDGET_SIZE_OFFSET_BOTTOM

◆ WIDGET_SIZE_OFFSET_TOP

◆ ZORDER_OFFSET_BOTTOM